WoW:API GetMapLandmarkInfo: Difference between revisions

← Older edit

WoW:API GetMapLandmarkInfo (source)

Revision as of 04:46, 15 August 2023

95 bytes removed , 15 August 2023

m

Move page script moved page API GetMapLandmarkInfo to WoW:API GetMapLandmarkInfo without leaving a redirect

Anonymous user

Move page script

@@ 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.
+ name, description, textureId, x, y = GetMapLandmarkInfo(landmarkId)
-----
+== Parameters ==
-;''Arguments''
+=== Arguments ===
+* landmarkId (number) - indicates which landmark to query, from 1 to [[API GetNumMapLandmarks|GetNumMapLandmarks()]].
-:(landmarkIndex)
+=== Returns ===
-:;landmarkIndex : Number - Indicates which landmark to query (from 1 to [[API GetNumMapLandmarks|GetNumMapLandmarks()]])
+* 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 ==
-;''Returns''
+{{Map/Note/doc/markers_poi}}
-:name, description, textureIndex, x, y
+== Notes ==
-:;name : String - The name of the landmark
+* 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.
-:;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. Values seen today are:
-:::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
-:::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)
-----
+[[ru:API GetMapLandmarkInfo]]
-{{Template:WoW API}}
-[[Category:API World Map Functions|GetMapLandmarkInfo]]