Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:51Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Turns a MapDisplay window into a working map of the given type.

<pre>
CreateMapInstance(windowName, mapType)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of a MapDisplay window.
;mapType : <code>number</code> – Kind of map, a value from <code>SystemData.MapTypes</code> (<code>NORMAL</code>, <code>OVERHEAD</code>, <code>MAINMAP</code>, <code>RVRTRACKER</code>, ...).

== Returns ==
Nothing.

== Details ==
* The client creates map data of the requested type for the window. Afterwards [[API:MapSetMapView|MapSetMapView]] can choose what the window shows.
* If <code>windowName</code> is empty, or the client's map data is not loaded, the call does nothing.
* If the window does not exist, both errors below are logged.
* The function needs at least two arguments and only reads the last two.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'CreateMapInstance': Display Window %s does not exist</code>
* <code>Error in function call 'CreateMapInstance': Display Window %s is not a MapDisplay</code>

== Example ==
From <code>ea_overheadmapwindow/source/overheadmapwindow.lua</code>:
<pre>
CreateMapInstance( "EA_Window_OverheadMapMapDisplay", SystemData.MapTypes.OVERHEAD )
</pre>

From <code>ea_worldmapwindow/source/zoneview.lua</code>:
<pre>
CreateMapInstance( "EA_Window_WorldMapZoneViewMapDisplay", SystemData.MapTypes.MAINMAP )
</pre>

== See also ==
* [[API:MapSetMapView|MapSetMapView]]

API:CreateMapInstance - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)