WoW:API GetMapLandmarkInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Add in new images that have been around for a while (EoTS and Halaa etc.))
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 8x8 grid.  Values are:
:;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 [[Image:IconSmall_POI0.png]] Mine, neutral
::: <span style="visibility:hidden">0</span>0 &mdash; Invisible (There's a number of these on zoomed in maps that don't get displayed.)
::: <span style="visibility:hidden">0</span>1 [[Image:IconSmall_POI1.png]] Mine, held by [[Horde]]
::: <span style="visibility:hidden">0</span>1 [[Image:IconSmall_POI0.png]] Mine, neutral
::: <span style="visibility:hidden">0</span>2 [[Image:IconSmall_POI2.png]] Mine, held by [[Alliance]]
::: <span style="visibility:hidden">0</span>2 [[Image:IconSmall_POI1.png]] Mine, held by [[Horde]]
::: <span style="visibility:hidden">0</span>3 [[Image:IconSmall_POI3.png]] Graveyard, assaulted by Alliance
::: <span style="visibility:hidden">0</span>3 [[Image:IconSmall_POI2.png]] Mine, held by [[Alliance]]
::: <span style="visibility:hidden">0</span>4 [[Image:IconSmall_POI4.png]] Town
::: <span style="visibility:hidden">0</span>4 [[Image:IconSmall_POI3.png]] Graveyard, assaulted by Alliance
::: <span style="visibility:hidden">0</span>5 [[Image:IconSmall_POI5.png]] City
::: <span style="visibility:hidden">0</span>5 [[Image:IconSmall_POI4.png]] Town
::: <span style="visibility:hidden">0</span>6 [[Image:IconSmall_POI6.png]] Flag (Shown when you ask a town guard for directions.)
::: <span style="visibility:hidden">0</span>6 [[Image:IconSmall_POI5.png]] City
::: <span style="visibility:hidden">0</span>7 [[Image:IconSmall_POI7.png]] Player corpse marker
::: <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:IconSmall_POI8.png]] Tower, assaulted by Alliance
::: <span style="visibility:hidden">0</span>8 [[Image:IconSmall_POI7.png]] Player corpse marker
::: <span style="visibility:hidden">0</span>9 [[Image:IconSmall_POI9.png]] Tower, held by Horde
::: <span style="visibility:hidden">0</span>9 [[Image:IconSmall_POI8.png]] Tower, assaulted by Alliance
::: 10 [[Image:IconSmall_POI10.png]] Tower, held by Alliance
::: 10 [[Image:IconSmall_POI9.png]] Tower, held by Horde
::: 11 [[Image:IconSmall_POI11.png]] Tower, assaulted by Horde
::: 11 [[Image:IconSmall_POI10.png]] Tower, held by Alliance
::: 12 [[Image:IconSmall_POI12.png]] Graveyard, held by Horde
::: 12 [[Image:IconSmall_POI11.png]] Tower, assaulted by Horde
::: 13 [[Image:IconSmall_POI13.png]] Graveyard, assaulted by Horde
::: 13 [[Image:IconSmall_POI12.png]] Graveyard, held by Horde
::: 14 [[Image:IconSmall_POI14.png]] Graveyard, held by Alliance
::: 14 [[Image:IconSmall_POI13.png]] Graveyard, assaulted by Horde
::: 15 &mdash; Invisible (There's a number of these on zoomed in maps that don't get displayed.)
::: 15 [[Image:IconSmall_POI14.png]] Graveyard, held by Alliance
::: 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-63 &mdash; Currently unused
::: 41 [[Image:IconSmall_POI41.png]] Unknown
::: 42 [[Image:IconSmall_POI42.png]] Unknown
::: 43 [[Image:IconSmall_POI43.png]] Alliance Flag
::: 44 [[Image:IconSmall_POI44.png]] Horde Flag
::: 45 [[Image:IconSmall_POI45.png]] Uncaptured Flag
::: 46 [[Image:IconSmall_POI46.png]] Alliance Crest
::: 47 [[Image:IconSmall_POI47.png]] Uncaptured Alliance Crest
::: 48 [[Image:IconSmall_POI48.png]] Horde Crest
::: 49 [[Image:IconSmall_POI49.png]] Uncaptured Horde Crest
::: 50-102 &mdash; Currently unused/unknown. Assumed to be for new content in WotLK


:;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 10:51, 24 October 2008

WoW API < GetMapLandmarkInfo

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
00 — Invisible (There's a number of these on zoomed in maps that don't get displayed.)
01 File:IconSmall POI0.png Mine, neutral
02 File:IconSmall POI1.png Mine, held by Horde
03 File:IconSmall POI2.png Mine, held by Alliance
04 File:IconSmall POI3.png Graveyard, assaulted by Alliance
05 File:IconSmall POI4.png Town
06 File:IconSmall POI5.png City
07 File:IconSmall POI6.png Flag (Shown when you ask a town guard for directions.)
08 File:IconSmall POI7.png Player corpse marker
09 File:IconSmall POI8.png Tower, assaulted by Alliance
10 File:IconSmall POI9.png Tower, held by Horde
11 File:IconSmall POI10.png Tower, held by Alliance
12 File:IconSmall POI11.png Tower, assaulted by Horde
13 File:IconSmall POI12.png Graveyard, held by Horde
14 File:IconSmall POI13.png Graveyard, assaulted by Horde
15 File:IconSmall POI14.png Graveyard, held by Alliance
16 File:IconSmall POI16.png Gold Mine, neutral
17 File:IconSmall POI17.png Gold Mine, assaulted by Alliance
18 File:IconSmall POI18.png Gold Mine, held by Alliance
19 File:IconSmall POI19.png Gold Mine, assaulted by Horde
20 File:IconSmall POI20.png Gold Mine, held by Horde
21 File:IconSmall POI21.png Lumber Mill, neutral
22 File:IconSmall POI22.png Lumber Mill, assaulted by Alliance
23 File:IconSmall POI23.png Lumber Mill, held by Alliance
24 File:IconSmall POI24.png Lumber Mill, assaulted by Horde
25 File:IconSmall POI25.png Lumber Mill, held by Horde
26 File:IconSmall POI26.png Blacksmith, neutral
27 File:IconSmall POI27.png Blacksmith, assaulted by Alliance
28 File:IconSmall POI28.png Blacksmith, held by Alliance
29 File:IconSmall POI29.png Blacksmith, assaulted by Horde
30 File:IconSmall POI30.png Blacksmith, held by Horde
31 File:IconSmall POI31.png Farm, neutral
32 File:IconSmall POI32.png Farm, assaulted by Alliance
33 File:IconSmall POI33.png Farm, held by Alliance
34 File:IconSmall POI34.png Farm, assaulted by Horde
35 File:IconSmall POI35.png Farm, held by Horde
36 File:IconSmall POI36.png Stables, neutral
37 File:IconSmall POI37.png Stables, assaulted by Alliance
38 File:IconSmall POI38.png Stables, held by Alliance
39 File:IconSmall POI39.png Stables, assaulted by Horde
40 File:IconSmall POI40.png Stables, held by Horde
41 File:IconSmall POI41.png Unknown
42 File:IconSmall POI42.png Unknown
43 File:IconSmall POI43.png Alliance Flag
44 File:IconSmall POI44.png Horde Flag
45 File:IconSmall POI45.png Uncaptured Flag
46 File:IconSmall POI46.png Alliance Crest
47 File:IconSmall POI47.png Uncaptured Alliance Crest
48 File:IconSmall POI48.png Horde Crest
49 File:IconSmall POI49.png Uncaptured Horde Crest
50-102 — Currently unused/unknown. Assumed to be for new content in WotLK
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)