Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:07Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Map}}
Returns the maps one level below a given map, for example the zone maps of a pairing map.

<pre>
children = MapGetChildMaps(mapLevel, mapNumber)
</pre>

== Arguments ==
;mapLevel : <code>number</code> – Level of the map, a <code>GameDefs.MapLevel</code> value (<code>WORLD_MAP</code>, <code>PAIRING_MAP</code>, <code>ZONE_MAP</code>, <code>AREA_MAP</code>).
;mapNumber : <code>number</code> – Number of the map at that level, for example a zone id for <code>ZONE_MAP</code>.

== Returns ==
;children : <code>table</code> – Array of child maps, indexed from 1, or nothing if the map is not in the client's map data.

Each entry:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>mapLevel</code> || <code>number</code> || Level of the child map.
|-
| <code>mapNumber</code> || <code>number</code> || Number of the child map.
|}

== Details ==
* A map without children returns an empty table.
* If the client's map data is not loaded, the function returns nothing.
* The stock UI never calls this function.
* The function needs at least two arguments and only reads the last two.

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

== Example ==
A minimal example built from the signature:
<pre>
local children = MapGetChildMaps( GameDefs.MapLevel.PAIRING_MAP, pairingMapNumber )
if children ~= nil then
for _, child in ipairs( children ) do
-- child.mapLevel, child.mapNumber
end
end
</pre>

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

API:MapGetChildMaps - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)