WoW:API GetMapLandmarkInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
<center>'''GetMapLandmarkInfo''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
<center>'''GetMapLandmarkInfo''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>


  name, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);
  name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);


Returns the information about a landmark on the current world map.
Returns the information about a landmark on the current world map.
Line 14: Line 14:
;''Returns''
;''Returns''


:name, textureIndex, x, y
:name, description, textureIndex, x, y
:;name : String - The name of the landmark
:;name : String - The name of the landmark
:;description : String - A description of the landmark.  In Battlegrounds this can dynamic information such as which faction controls the landmark.
:;textureIndex : Number - An index representing which landmark icon to display. Values seen today are:
:;textureIndex : Number - An index representing which landmark icon to display. Values seen today are:
:::4 - Town - the small house icon
:::4 - Town - the small house icon
:::5 - City - The grey tower icon
:::5 - City - The grey tower icon
:::6 - Flag - This is the temporary marker shown when you ask a town guard for directions
:::15 - Invisible - There's number of these on zoomed in maps that dont get displayed.
:::15 - Invisible - There's number of these on zoomed in maps that dont get displayed.
:;x : Number - The X location of the landmark's center (A proportion of the current map's width, between 0 and 1)
:;x : Number - The X location of the landmark's center (A proportion of the current map's width, between 0 and 1)

Revision as of 19:48, 12 May 2005

GetMapLandmarkInfo -Documentation by Flickering-
name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);

Returns the information about a landmark on the current world map.


Arguments
(landmarkIndex)
landmarkIndex
Number - Indicates which landmark to query (from 1 to GetNumMapLandmarks())

Returns
name, description, textureIndex, x, y
name
String - The name of the landmark
description
String - A description of the landmark. In Battlegrounds this can dynamic information such as which faction controls the landmark.
textureIndex
Number - An index representing which landmark icon to display. Values seen today are:
4 - Town - the small house icon
5 - City - The grey tower icon
6 - Flag - This is the temporary marker shown when you ask a town guard for directions
15 - Invisible - There's number of these on zoomed in maps that dont get displayed.
x
Number - The X location of the landmark's center (A proportion of the current map's width, between 0 and 1)
y
Number - The Y location of the landmark's center (A proportion of the current map's height, between 0 and 1)

Template:WoW API