WoW:API GetMapLandmarkInfo: Difference between revisions

{{wowapi}}, format
No edit summary
({{wowapi}}, format)
Line 1: Line 1:
<center>'''GetMapLandmarkInfo''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
{{wowapi}} __NOTOC__
 
Returns the information about a landmark on the current world map.
  name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);
  name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);


Returns the information about a landmark on the current world map.
==Parameters==
 
===Arguments===
----
;''Arguments''
 
:(landmarkIndex)
:;landmarkIndex : Number - Indicates which landmark to query (from 1 to [[API GetNumMapLandmarks|GetNumMapLandmarks()]])
:;landmarkIndex : Number - Indicates which landmark to query (from 1 to [[API GetNumMapLandmarks|GetNumMapLandmarks()]])
 
===Returns===
----
;''Returns''
 
: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.
:;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. These icons are in <tt>Interface\Minimap\POIIcons.blp</tt>, in a 4x4 grid.  Values are:
:;textureIndex : Number - An index representing which landmark icon to display. These icons are in <tt>Interface\Minimap\POIIcons.blp</tt>, in a 4x4 grid.  Values are:
[[Image:POIIcons.png|right]]
:::0 - Gray cart - A neutral mine (Battlegrounds)
:::0 - Gray cart - A neutral mine (Battlegrounds)
:::1 - Blue cart - An Alliance held mine (Battlegrounds)
:::1 - Blue cart - An Alliance held mine (Battlegrounds)
Line 34: Line 27:
:::14 - Red tombstone - A Horde graveyard (Battlegrounds)
:::14 - Red tombstone - A Horde graveyard (Battlegrounds)
:::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.
:::[[Image:POIIcons.png]]
:;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)
:;y : Number - The Y location of the landmark's center (A proportion of the current map's height, 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)
----
{{WoW API}}