Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:01Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the map areas the player is currently in, with their influence ids.

<pre>
areas = GetAreaData()
</pre>

== Arguments ==
None.

== Returns ==
;areas : <code>table</code> – Array of area tables, indexed from 1.

Each area table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>areaName</code> || <code>wstring</code> || Name of the area.
|-
| <code>areaNumber</code> || <code>number</code> || Area number.
|-
| <code>areaID</code> || <code>number</code> || Area id. Always equal to <code>areaNumber</code> in the result.
|-
| <code>influenceID</code> || <code>number</code> || Influence id of the area, or 0 if it has none. Use it with [[API:GetInfluenceData|GetInfluenceData]].
|-
| <code>hasPQButNoInfluence</code> || <code>boolean</code> || —
|}

== Details ==
* The client skips areas whose area number and area id differ, so only entries where both match are returned.
* If the zone tracker is not set up, or there is no player object, or the Lua state is not available, the function returns nothing. The stock UI checks the result for <code>nil</code>.

== Errors ==
None.

== Example ==
Finding the influence id of the current area, from <code>ea_objectivetrackers/source/publicquesttrackerwindow.lua</code>:
<pre>
local areaData = GetAreaData()

if( areaData == nil )
then
return nil, false
end

local hasPQButNoInfluence = false
for key, value in ipairs( areaData )
do
if (value.influenceID ~= 0)
then
-- Return whatever value.hasPQButNoInfluence is
return value.influenceID, value.hasPQButNoInfluence
elseif( value.hasPQButNoInfluence )
then
hasPQButNoInfluence = true
end
end
</pre>

== See also ==
* [[API:GetInfluenceData|GetInfluenceData]]
* [[API:GetActiveObjectivesData|GetActiveObjectivesData]]

API:GetAreaData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)