API:GetOverheadMapZoomLevel

UI Lua API · Map functions
Version: WAR 1.4.8

Returns the zoom level of the overhead map (minimap).

zoomLevel = GetOverheadMapZoomLevel()

Arguments

None.

Returns

zoomLevel

number – The current zoom level, 0, 1 or 2. 0 if the overhead map has not been created.

Details

• The stock UI uses the value with SystemData.OverheadMap.MIN_ZOOM_LEVEL and MAX_ZOOM_LEVEL to position its zoom slider.

Errors

None.

Example

From default/ea_overheadmapwindow/source/overheadmapwindow.lua:

function EA_Window_OverheadMap.RepositionZoomSlider()
    local zoomLevel       = GetOverheadMapZoomLevel()
    local oneTickAmount   = (1 / (SystemData.OverheadMap.MAX_ZOOM_LEVEL - SystemData.OverheadMap.MIN_ZOOM_LEVEL))
    local newZoomFraction = ((zoomLevel - SystemData.OverheadMap.MIN_ZOOM_LEVEL) * oneTickAmount)
    ...

See also

• SetOverheadMapZoomLevel