API GetMapOverlayInfo

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

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

Parameters

Arguments

overlayIndex

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

Returns

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.