WoW:API GetMapOverlayInfo: Difference between revisions

Revision as of 22:26, 23 December 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns the information about an overlay on the current world map.

textureName, texWidth, texHeight, ofsX, ofsY, mapX, mapY = GetMapOverlayInfo(overlayIndex);

overlayIndex: Number - Indicates which overlay to query (from 1 to GetNumMapOverlays())

textureName: String - The path of the overlay texture
texWidth: Number - The width of the resulting texture in pixels.
texHeight: Number - The height of the resulting texture in pixels.
ofsX: Number - X direction pixel offset of the overlay texture from the map texture
ofsY: Number - Y direction pixel offset of the overlay texture from the map texture
mapX: Number - Unknown - always 0 and not used in UI.
mapY: Number - Unknown - always 0 and not used in UI.

@@ Line 1: / Line 1: @@
-<center>'''GetMapOverlayInfo''' ''-Documentation by [[user:Flickering|Flickering]]-''</center>
+{{wowapi}} __NOTOC__
+Returns the information about an overlay on the current world map.
   textureName, texWidth, texHeight, ofsX, ofsY, mapX, mapY = GetMapOverlayInfo(overlayIndex);
-Returns the information about an overlay on the current world map.
+==Parameters==
+===Arguments===
-----
-;''Arguments''
-:(overlayIndex)
 :;overlayIndex : Number - Indicates which overlay to query (from 1 to [[API GetNumMapOverlays|GetNumMapOverlays()]])
-----
+===Returns===
-;''Returns''
-:textureName, texWidth, texHeight, ofsX, ofsY, mapX, mapY
 :;textureName : String - The path of the overlay texture
 :;texWidth : Number - The width of the resulting texture in pixels.
@@ Line 22: / Line 15: @@
 :;mapX : Number - Unknown - always 0 and not used in UI.
 :;mapY : Number - Unknown - always 0 and not used in UI.
-----
-{{WoW API}}