Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:13Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Map}}
Turns the "gutter" setting on or off for one type of map pin in a map window.

<pre>
MapSetPinGutter(mapDisplayName, pinType, enabled)
</pre>

== Arguments ==
;mapDisplayName : <code>string</code> – Name of a MapDisplay window set up with [[API:CreateMapInstance|CreateMapInstance]].
;pinType : <code>number</code> – Pin type, a <code>SystemData.MapPips</code> value. Must be 0–57.
;enabled : <code>boolean</code> – The new gutter setting for this pin type.

== Returns ==
Nothing.

== Details ==
* The setting is kept per map window and per pin type, next to the filter set by [[API:MapSetPinFilter|MapSetPinFilter]].
* The stock overhead map offers it as a second check box per pin group in its pin filter menu, saved in <code>EA_Window_OverheadMap.Settings.mapPinGutters</code>, and switches its border style depending on whether any gutters are enabled.
* Pin types outside 0–57 and unknown window names are ignored without an error.
* When the setting changes, the client updates the pins of that window.
* <code>enabled</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least three arguments and only reads the last three.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.

== Example ==
From <code>default/ea_overheadmapwindow/source/overheadmapwindow.lua</code>:
<pre>
function EA_Window_OverheadMap.ToggleMapPinGutter()
local gutterPin = ButtonGetPressedFlag(SystemData.ActiveWindow.name)
local pinTypeIndex = WindowGetId(SystemData.ActiveWindow.name)
local pinTypes = EA_Window_OverheadMap.mapPinGutters[pinTypeIndex].pins

for _, pinType in ipairs(pinTypes)
do
MapSetPinGutter("EA_Window_OverheadMapMapDisplay", pinType, gutterPin)
EA_Window_OverheadMap.Settings.mapPinGutters[ pinType ] = gutterPin
end
...
</pre>

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

API:MapSetPinGutter - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)