WoW:API GetMapLandmarkInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
Line 7: Line 7:
:;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 : 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 an 8x8 grid.  Values are:
[[Image:POIIcons.png|right]]
[[Image:POIIcons.png|frame|POIIcons.blp]]
:::0 - Gray cart - A neutral mine (Battlegrounds)
::: <span style="visibility:hidden">0</span>0 [[Image:IconSmall_POI0.png]] Mine, neutral
:::1 - Blue cart - An Alliance held mine (Battlegrounds)
::: <span style="visibility:hidden">0</span>1 [[Image:IconSmall_POI1.png]] Mine, held by [[Horde]]
:::2 - Red cart - A Horde held mine (Battlegrounds)
::: <span style="visibility:hidden">0</span>2 [[Image:IconSmall_POI2.png]] Mine, held by [[Alliance]]
:::3 - Half red tombstone - A contested Horde graveyard (Battlegrounds)
::: <span style="visibility:hidden">0</span>3 [[Image:IconSmall_POI3.png]] Graveyard, assaulted by Alliance
:::4 - Town - the small house icon
::: <span style="visibility:hidden">0</span>4 [[Image:IconSmall_POI4.png]] Town
:::5 - City - The grey tower icon
::: <span style="visibility:hidden">0</span>5 [[Image:IconSmall_POI5.png]] City
:::6 - Flag - This is the temporary marker shown when you ask a town guard for directions
::: <span style="visibility:hidden">0</span>6 [[Image:IconSmall_POI6.png]] Flag (Shown when you ask a town guard for directions.)
:::7 - Tombstone - Player corpse marker
::: <span style="visibility:hidden">0</span>7 [[Image:IconSmall_POI7.png]] Player corpse marker
:::8 - Half red tower - An endangered Horde tower (Battlegrounds)
::: <span style="visibility:hidden">0</span>8 [[Image:IconSmall_POI8.png]] Tower, assaulted by Alliance
:::9 - Blue tower - An Alliance tower (Battlegrounds)
::: <span style="visibility:hidden">0</span>9 [[Image:IconSmall_POI9.png]] Tower, held by Horde
:::10 - Red tower - A Horde tower (Battlegrounds)
::: 10 [[Image:IconSmall_POI10.png]] Tower, held by Alliance
:::11 - Half blue tower - An endangered Alliance tower (Battlegrounds)
::: 11 [[Image:IconSmall_POI11.png]] Tower, assaulted by Horde
:::12 - Blue tombstone - An Alliance graveyard (Battlegrounds)
::: 12 [[Image:IconSmall_POI12.png]] Graveyard, held by Horde
:::13 - Half blue tombstone - A contested Alliance graveyard (Battlegrounds)
::: 13 [[Image:IconSmall_POI13.png]] Graveyard, assaulted by Horde
:::14 - Red tombstone - A Horde graveyard (Battlegrounds)
::: 14 [[Image:IconSmall_POI14.png]] Graveyard, held by Alliance
:::15 - Invisible - There's number of these on zoomed in maps that dont get displayed.
::: 15 &mdash; Invisible (There's a number of these on zoomed in maps that don't get displayed.)
:::18 - Blue Gold Mine - Alliance held gold mine (Battlegrounds)
::: 16 [[Image:IconSmall_POI16.png]] Gold Mine, neutral
:::20 - Red Gold Mine - Horde held gold mine (Battlegrounds)
::: 17 [[Image:IconSmall_POI17.png]] Gold Mine, assaulted by Alliance
:::23 - Blue Lumber Mill - Alliance held lumber mill (Battlegrounds)
::: 18 [[Image:IconSmall_POI18.png]] Gold Mine, held by Alliance
:::28 - Blue Blacksmith - Alliance held blacksmith (Battlegrounds)
::: 19 [[Image:IconSmall_POI19.png]] Gold Mine, assaulted by Horde
:::29 - Half Red Blacksmith - Horde endangered blacksmith (Battlegrounds)
::: 20 [[Image:IconSmall_POI20.png]] Gold Mine, held by Horde
:::30 - Red Blacksmith - Horde held blacksmith (Battlegrounds)
::: 21 [[Image:IconSmall_POI21.png]] Lumber Mill, neutral
:::35 - Red Farm - Horde held farm (Battlegrounds)
::: 22 [[Image:IconSmall_POI22.png]] Lumber Mill, assaulted by Alliance
:::37 - Half blue Stables - Alliance endangered stables (Battlegrounds)
::: 23 [[Image:IconSmall_POI23.png]] Lumber Mill, held by Alliance
:::38 - Blue Stables - Alliance held stables (Battlegrounds)
::: 24 [[Image:IconSmall_POI24.png]] Lumber Mill, assaulted by Horde
::: 25 [[Image:IconSmall_POI25.png]] Lumber Mill, held by Horde
::: 26 [[Image:IconSmall_POI26.png]] Blacksmith, neutral
::: 27 [[Image:IconSmall_POI27.png]] Blacksmith, assaulted by Alliance
::: 28 [[Image:IconSmall_POI28.png]] Blacksmith, held by Alliance
::: 29 [[Image:IconSmall_POI29.png]] Blacksmith, assaulted by Horde
::: 30 [[Image:IconSmall_POI30.png]] Blacksmith, held by Horde
::: 31 [[Image:IconSmall_POI31.png]] Farm, neutral
::: 32 [[Image:IconSmall_POI32.png]] Farm, assaulted by Alliance
::: 33 [[Image:IconSmall_POI33.png]] Farm, held by Alliance
::: 34 [[Image:IconSmall_POI34.png]] Farm, assaulted by Horde
::: 35 [[Image:IconSmall_POI35.png]] Farm, held by Horde
::: 36 [[Image:IconSmall_POI36.png]] Stables, neutral
::: 37 [[Image:IconSmall_POI37.png]] Stables, assaulted by Alliance
::: 38 [[Image:IconSmall_POI38.png]] Stables, held by Alliance
::: 39 [[Image:IconSmall_POI39.png]] Stables, assaulted by Horde
::: 40 [[Image:IconSmall_POI40.png]] Stables, held by Horde
::: 41-63 &mdash; Currently unused


:;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 18:33, 8 November 2007

← 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 an 8x8 grid. Values are:
POIIcons.blp
00 File:IconSmall POI0.png Mine, neutral
01 File:IconSmall POI1.png Mine, held by Horde
02 File:IconSmall POI2.png Mine, held by Alliance
03 File:IconSmall POI3.png Graveyard, assaulted by Alliance
04 File:IconSmall POI4.png Town
05 File:IconSmall POI5.png City
06 File:IconSmall POI6.png Flag (Shown when you ask a town guard for directions.)
07 File:IconSmall POI7.png Player corpse marker
08 File:IconSmall POI8.png Tower, assaulted by Alliance
09 File:IconSmall POI9.png Tower, held by Horde
10 File:IconSmall POI10.png Tower, held by Alliance
11 File:IconSmall POI11.png Tower, assaulted by Horde
12 File:IconSmall POI12.png Graveyard, held by Horde
13 File:IconSmall POI13.png Graveyard, assaulted by Horde
14 File: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 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-63 — Currently unused
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)
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetMapLandmarkInfo&oldid=8201"