C_WorldMap.GetMapLandmarkInfo

From Warcraft Wiki
(Redirected from API GetMapLandmarkInfo)
Jump to navigation Jump to search
Links
Info
Added in 7.2.0

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

type, name, description, textureIndex, x, y, mapLinkID, showInBattleMap, graveyardID, areaID, poiID, isObjectIcon, atlasName, displayAsBanner, mapFloor, textureKitPrefix = GetMapLandmarkInfo(landmarkIndex)

Arguments

landmarkIndex
Number - Indicates which landmark to query (from 1 to GetNumMapLandmarks())

Returns

type
Number - Indicates the type of landmark. See LE_MAP_LANDMARK* in WorldMapFrame sources
name
String - Name of the landmark, e.g. "Domination Point Tower".
description
String - Description of the landmark, e.g. "Horde Controlled" or "Grand Master Pet Tamer".
textureIndex
Number - An index representing which POI or object icon to display for this landmark.
x
Number - The X location of the landmark's center; 0 at left edge of the map, 1 at the right.
y
Number - The Y location of the landmark's center; 0 at the top edge of the map, 1 at the bottom.
mapLinkID
Number - map link ID that should be followed if the landmark is clicked.
showInBattleMap
Boolean - whether this landmark should be shown in the battle map.
graveyardID
Number - for graveyard landmarks, graveyard ID for use in conjunction with SetCemeteryPreference; 0 if not a graveyard.
areaID
Number - WorldMapAreaID of the map this landmark should be limited to, or 0 if no such limitation applies.
poiID
Number - POI-specific ID, or nil.
isObjectIcon
Flag - if true, this landmark uses an object rather than POI icon.
atlasName
string
displayAsBanner
boolean
mapFloor
number
textureKitPrefix
string

Details

Object icons
POIIcons landmarks
  • The textureIndex specifies, depending on isObjectIcon, an icon from either Interface\​Minimap\​ObjectIcons or Interface\​Minimap\​POIIcons textures. You can use GetObjectIconTextureCoords and GetPOITextureCoords functions to resolve these indices to texture coordinates.

Patch changes

  • Battle for Azeroth Patch 8.0.1 (2018-07-17): Removed.
  • Legion Patch 7.3.0 (2017-08-29): Added mapFloor, textureKitPrefix returns.
  • Legion Patch 7.2.0 (2017-03-28): Moved to C_WorldMap.GetMapLandmarkInfo. [1]
  • Legion Patch 7.0.3 (2016-07-19): type was added as the first returned value; prior to this version, name was the first returned value
  • Wrath-Logo-Small.png Patch 3.0.2 (2008-10-14): Additional icons were added to POIIcons.blp, doubling the size of the texture to 256x256. The invisible texture was moved from index 15 to 0.
  • WoW Icon update.png Patch 1.1.0 (2004-11-07): Added.

See also