DarkRyder12754@legacy41533782 (talk | contribs) m (→Returns) |
Ashberlin3981@legacy41525371 (talk | contribs) (First update for 3.0.2 changes) |
||
| Line 2: | Line 2: | ||
Returns the information about a landmark on the current world map. |
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); |
||
| + | |||
| + | Note that 3.0.2 added more icons (102 now), doubled the size of the POIIcons.blp texture to 256x256 and moved the invisible texture from index 15 to 0. |
||
==Parameters== |
==Parameters== |
||
| Line 10: | Line 12: | ||
:;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 an |
+ | :;textureIndex : Number - An index representing which landmark icon to display. These icons are in <tt>Interface\Minimap\POIIcons.blp</tt>, in an 16x16 grid (each icon is 16x16). Values are: |
[[Image:POIIcons.png|frame|POIIcons.blp]] |
[[Image:POIIcons.png|frame|POIIcons.blp]] |
||
| − | ::: <span style="visibility:hidden">0</span>0 |
+ | ::: <span style="visibility:hidden">0</span>0 — Invisible (There's a number of these on zoomed in maps that don't get displayed.) |
| − | ::: <span style="visibility:hidden">0</span>1 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>1 [[Image:IconSmall_POI0.png]] Mine, neutral |
| − | ::: <span style="visibility:hidden">0</span>2 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>2 [[Image:IconSmall_POI1.png]] Mine, held by [[Horde]] |
| − | ::: <span style="visibility:hidden">0</span>3 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>3 [[Image:IconSmall_POI2.png]] Mine, held by [[Alliance]] |
| − | ::: <span style="visibility:hidden">0</span>4 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>4 [[Image:IconSmall_POI3.png]] Graveyard, assaulted by Alliance |
| − | ::: <span style="visibility:hidden">0</span>5 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>5 [[Image:IconSmall_POI4.png]] Town |
| − | ::: <span style="visibility:hidden">0</span>6 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>6 [[Image:IconSmall_POI5.png]] City |
| − | ::: <span style="visibility:hidden">0</span>7 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>7 [[Image:IconSmall_POI6.png]] Flag (Shown when you ask a town guard for directions.) |
| − | ::: <span style="visibility:hidden">0</span>8 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>8 [[Image:IconSmall_POI7.png]] Player corpse marker |
| − | ::: <span style="visibility:hidden">0</span>9 [[Image: |
+ | ::: <span style="visibility:hidden">0</span>9 [[Image:IconSmall_POI8.png]] Tower, assaulted by Alliance |
| − | ::: 10 [[Image: |
+ | ::: 10 [[Image:IconSmall_POI9.png]] Tower, held by Horde |
| − | ::: 11 [[Image: |
+ | ::: 11 [[Image:IconSmall_POI10.png]] Tower, held by Alliance |
| − | ::: 12 [[Image: |
+ | ::: 12 [[Image:IconSmall_POI11.png]] Tower, assaulted by Horde |
| − | ::: 13 [[Image: |
+ | ::: 13 [[Image:IconSmall_POI12.png]] Graveyard, held by Horde |
| − | ::: 14 [[Image: |
+ | ::: 14 [[Image:IconSmall_POI13.png]] Graveyard, assaulted by Horde |
| + | ::: 15 [[Image:IconSmall_POI14.png]] Graveyard, held by Alliance |
||
| − | ::: 15 — Invisible (There's a number of these on zoomed in maps that don't get displayed.) |
||
::: 16 [[Image:IconSmall_POI16.png]] Gold Mine, neutral |
::: 16 [[Image:IconSmall_POI16.png]] Gold Mine, neutral |
||
::: 17 [[Image:IconSmall_POI17.png]] Gold Mine, assaulted by Alliance |
::: 17 [[Image:IconSmall_POI17.png]] Gold Mine, assaulted by Alliance |
||
| Line 53: | Line 55: | ||
::: 39 [[Image:IconSmall_POI39.png]] Stables, assaulted by Horde |
::: 39 [[Image:IconSmall_POI39.png]] Stables, assaulted by Horde |
||
::: 40 [[Image:IconSmall_POI40.png]] Stables, held by Horde |
::: 40 [[Image:IconSmall_POI40.png]] Stables, held by Horde |
||
| − | ::: 41- |
+ | ::: 41-102 — Currently unused/unknown |
:;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 10:38, 24 October 2008
 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Returns the information about a landmark on the current world map.
name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);
Note that 3.0.2 added more icons (102 now), doubled the size of the POIIcons.blp texture to 256x256 and moved the invisible texture from index 15 to 0.
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 an 16x16 grid (each icon is 16x16). Values are:
POIIcons.blp
- 0 — Invisible (There's a number of these on zoomed in maps that don't get displayed.)
- 1
Mine, neutral - 2 Mine, held by Horde
- 3 Mine, held by Alliance
- 4 Graveyard, assaulted by Alliance
- 5 Town
- 6 City
- 7 Flag (Shown when you ask a town guard for directions.)
- 8 Player corpse marker
- 9 Tower, assaulted by Alliance
- 10 Tower, held by Horde
- 11 Tower, held by Alliance
- 12 Tower, assaulted by Horde
- 13 Graveyard, held by Horde
- 14 Graveyard, assaulted by Horde
- 15 Graveyard, held by Alliance
- 16 Gold Mine, neutral
- 17 Gold Mine, assaulted by Alliance
- 18 Gold Mine, held by Alliance
- 19 Gold Mine, assaulted by Horde
- 20 Gold Mine, held by Horde
- 21 Lumber Mill, neutral
- 22 Lumber Mill, assaulted by Alliance
- 23 Lumber Mill, held by Alliance
- 24 Lumber Mill, assaulted by Horde
- 25 Lumber Mill, held by Horde
- 26 Blacksmith, neutral
- 27 Blacksmith, assaulted by Alliance
- 28 Blacksmith, held by Alliance
- 29 Blacksmith, assaulted by Horde
- 30 Blacksmith, held by Horde
- 31 Farm, neutral
- 32 Farm, assaulted by Alliance
- 33 Farm, held by Alliance
- 34 Farm, assaulted by Horde
- 35 Farm, held by Horde
- 36 Stables, neutral
- 37 Stables, assaulted by Alliance
- 38 Stables, held by Alliance
- 39 Stables, assaulted by Horde
- 40 Stables, held by Horde
- 41-102 — Currently unused/unknown
- 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)