WoW:API GetMapOverlayInfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Move page script moved page API GetMapOverlayInfo to API GetMapOverlayInfo without leaving a redirect) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | |||
Returns the information about an overlay on the current world map. | |||
textureName, texWidth, texHeight, ofsX, ofsY, mapX, mapY = GetMapOverlayInfo(overlayIndex); | textureName, texWidth, texHeight, ofsX, ofsY, mapX, mapY = GetMapOverlayInfo(overlayIndex); | ||
==Parameters== | |||
===Arguments=== | |||
:;overlayIndex : Number - Indicates which overlay to query (from 1 to [[API GetNumMapOverlays|GetNumMapOverlays()]]) | :;overlayIndex : Number - Indicates which overlay to query (from 1 to [[API GetNumMapOverlays|GetNumMapOverlays()]]) | ||
===Returns=== | |||
:;textureName : String - The path of the overlay texture | :;textureName : String - The path of the overlay texture | ||
:;texWidth : Number - The width of the resulting texture in pixels. | :;texWidth : Number - The width of the resulting texture in pixels. | ||
| Line 22: | Line 15: | ||
:;mapX : Number - Unknown - always 0 and not used in UI. | :;mapX : Number - Unknown - always 0 and not used in UI. | ||
:;mapY : Number - Unknown - always 0 and not used in UI. | :;mapY : Number - Unknown - always 0 and not used in UI. | ||
Latest revision as of 04:46, 15 August 2023
Returns the information about an overlay on the current world map.
textureName, texWidth, texHeight, ofsX, ofsY, mapX, mapY = GetMapOverlayInfo(overlayIndex);
Parameters[edit]
Arguments[edit]
- overlayIndex
- Number - Indicates which overlay to query (from 1 to GetNumMapOverlays())
Returns[edit]
- 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.