WoW:API GetMapLandmarkInfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
({{wowapi}}, format) |
||
| Line 1: | Line 1: | ||
{{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); | ||
==Parameters== | |||
===Arguments=== | |||
:;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=== | |||
:;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. | ||
:;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) | ||
Revision as of 22:25, 23 December 2006
← WoW API < GetMapLandmarkInfo
Returns the information about a landmark on the current world map.
name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);
Parameters
Arguments
- landmarkIndex
- Number - Indicates which landmark to query (from 1 to GetNumMapLandmarks())
Returns
- 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. These icons are in Interface\Minimap\POIIcons.blp, in a 4x4 grid. Values are:
- 0 - Gray cart - A neutral mine (Battlegrounds)
- 1 - Blue cart - An Alliance held mine (Battlegrounds)
- 2 - Red cart - A Horde held mine (Battlegrounds)
- 3 - Half red tombstone - A contested Horde graveyard (Battlegrounds)
- 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
- 7 - Tombstone - Player corpse marker
- 8 - Half red tower - An endangered Horde tower (Battlegrounds)
- 9 - Blue tower - An Alliance tower (Battlegrounds)
- 10 - Red tower - A Horde tower (Battlegrounds)
- 11 - Half blue tower - An endangered Alliance tower (Battlegrounds)
- 12 - Blue tombstone - An Alliance graveyard (Battlegrounds)
- 13 - Half blue tombstone - A contested Alliance graveyard (Battlegrounds)
- 14 - Red tombstone - A Horde graveyard (Battlegrounds)
- 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)