WoW:API GetMapLandmarkInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API GetMapLandmarkInfo to API GetMapLandmarkInfo without leaving a redirect)
 
(12 intermediate revisions by 12 users not shown)
Line 1: Line 1:
<center>'''GetMapLandmarkInfo''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
{{wowapi}}
 
name, description, textureIndex, x, y = GetMapLandmarkInfo(landmarkIndex);
 
Returns the information about a landmark on the current world map.
Returns the information about a landmark on the current world map.
name, description, textureId, x, y = GetMapLandmarkInfo(landmarkId)


----
== Parameters ==
;''Arguments''
=== Arguments ===
 
* landmarkId (number) - indicates which landmark to query, from 1 to [[API GetNumMapLandmarks|GetNumMapLandmarks()]].
:(landmarkIndex)
:;landmarkIndex : Number - Indicates which landmark to query (from 1 to [[API GetNumMapLandmarks|GetNumMapLandmarks()]])
 
----
;''Returns''
 
:name, description, textureIndex, x, y
:;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 <tt>Interface\Minimap\POIIcons.blp</tt>, 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.
:::[[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)
=== Returns ===
:;y : Number - The Y location of the landmark's center (A proportion of the current map's height, between 0 and 1)
* 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
* textureId (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 listed in the Landmarks section below.
* x (number) - The X location of the landmark's cente, as a proportion of the current map's width, between 0 and 1
* y (number) - The Y location of the landmark's center, as a proportion of the current map's height, between 0 and 1


== Landmark texture and textureIDs ==
{{Map/Note/doc/markers_poi}}


== Notes ==
* 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.


----
[[ru:API GetMapLandmarkInfo]]
{{WoW API}}

Latest revision as of 04:46, 15 August 2023

← WoW API < GetMapLandmarkInfo

Returns the information about a landmark on the current world map. 

name, description, textureId, x, y = GetMapLandmarkInfo(landmarkId)

Parameters[edit]

Arguments[edit]

Returns[edit]

  • 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
  • textureId (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 listed in the Landmarks section below.
  • x (number) - The X location of the landmark's cente, as a proportion of the current map's width, between 0 and 1
  • y (number) - The Y location of the landmark's center, as a proportion of the current map's height, between 0 and 1

Landmark texture and textureIDs[edit]

POIIcons.png

Template:Flexbox

Special
Mine

Template:Flexbox Template:Flexbox

Other

Template:Flexbox Template:Flexbox

Tower

Template:Flexbox

Template:Flexbox

Graveyard

Template:Flexbox Template:Flexbox

Other
Lumber Mill

Template:Flexbox Template:Flexbox

Blacksmith

Template:Flexbox

Template:Flexbox

Farm

Template:Flexbox Template:Flexbox

Stables

Template:Flexbox

Template:Flexbox

Other
Flag

Template:Flexbox Template:Flexbox

Crest

Template:Flexbox Template:Flexbox

Tower

Template:Flexbox

Template:Flexbox

Bridge

Template:Flexbox Template:Flexbox

Workshop

Template:Flexbox Template:Flexbox

Gate

Template:Flexbox

Template:Flexbox

Wall horizontal

Template:Flexbox Template:Flexbox

Wall vertical

Template:Flexbox

Template:Flexbox

Other
Gate

Template:Flexbox Template:Flexbox

Numbers

Template:Flexbox Template:Flexbox

Unknown

Template:Flexbox

Template:Flexbox

Tower

Template:Flexbox Template:Flexbox

Other
Siege workshop

Template:Flexbox Template:Flexbox

Hangar

Template:Flexbox Template:Flexbox

Docks

Template:Flexbox Template:Flexbox

Refinery

Template:Flexbox

Notes[edit]

  • 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.

ru:API GetMapLandmarkInfo

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetMapLandmarkInfo&oldid=19123"