View source for API:SetOverheadMapZoomLevel

{{LuaApi|group=Map}}
Sets the zoom level of the overhead map (minimap).

<pre>
SetOverheadMapZoomLevel(zoomLevel)
</pre>

== Arguments ==
;zoomLevel : <code>number</code> – The new zoom level. Fractions are rounded down; the result must be 0, 1 or 2. The stock UI uses the range <code>SystemData.OverheadMap.MIN_ZOOM_LEVEL</code> to <code>SystemData.OverheadMap.MAX_ZOOM_LEVEL</code>.

== Returns ==
Nothing.

== Details ==
* Values that are not 0, 1 or 2 after rounding down are ignored without an error.
* If the overhead map has not been created, the call does nothing.
* Read the value back with [[API:GetOverheadMapZoomLevel|GetOverheadMapZoomLevel]].
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
From <code>default/ea_siegeweaponwindow/source/siegeweaponscorchfirewindow.lua</code>, zooming out while aiming and restoring the old level afterwards:
<pre>
SiegeWeaponScorchFireWindow.cachedOverheadZoomLevel = GetOverheadMapZoomLevel()
SetOverheadMapZoomLevel( SystemData.OverheadMap.MIN_ZOOM_LEVEL )
...
SetOverheadMapZoomLevel( SiegeWeaponScorchFireWindow.cachedOverheadZoomLevel )
</pre>

== See also ==
* [[API:GetOverheadMapZoomLevel|GetOverheadMapZoomLevel]]
* [[API:MapSetPinFilter|MapSetPinFilter]]