Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:48Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns a table describing the other members of the player's group.

<pre>
members = GetGroupData()
</pre>

== Arguments ==
None.

== Returns ==
;members : <code>table</code> – Array of member tables, indexed from 1. One entry per groupmate slot; the player is not included.

Each member table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Character name. <code>L""</code> for an empty slot.
|-
| <code>careerName</code> || <code>wstring</code> || Career name.
|-
| <code>careerLine</code> || <code>number</code> || Career line id.
|-
| <code>level</code> || <code>number</code> || Character level.
|-
| <code>battleLevel</code> || <code>number</code> || Battle (bolstered) level. Equal to <code>level</code> when the client has no separate battle level.
|-
| <code>worldObjNum</code> || <code>number</code> || World object number of the member.
|-
| <code>healthPercent</code> || <code>number</code> || Health, 0–100.
|-
| <code>actionPointPercent</code> || <code>number</code> || Action points, 0–100.
|-
| <code>moraleLevel</code> || <code>number</code> || Morale rank, 0–4, derived from the member's morale percentage.
|-
| <code>isGroupLeader</code> || <code>boolean</code> || —
|-
| <code>isRVRFlagged</code> || <code>boolean</code> || —
|-
| <code>isInSameRegion</code> || <code>boolean</code> || —
|-
| <code>isMainAssist</code> || <code>boolean</code> || —
|-
| <code>isMasterLooter</code> || <code>boolean</code> || —
|-
| <code>isAssistant</code> || <code>boolean</code> || <code>true</code> if the member is in the warband's assistant list.
|-
| <code>zoneNum</code> || <code>number</code> || Zone id.
|-
| <code>online</code> || <code>boolean</code> || —
|-
| <code>isDistant</code> || <code>boolean</code> || —
|-
| <code>Pet</code> || <code>table</code> || Table with one field, <code>healthPercent</code> (<code>number</code>), the health of the member's pet.
|}

== Details ==
* <code>battleLevel</code> falls back to <code>level</code> when the stored battle level is 0.
* <code>moraleLevel</code> is converted from a percentage to a rank (0–4) with the client's fixed morale thresholds.
* If there is no player object, or the Lua state is not available, the function returns nothing.
* A new table is built on every call. The stock UI caches it in <code>PartyUtils.GetPartyData()</code> (<code>easystem_utils/source/partyutils.lua</code>) and refreshes single members with [[API:GetGroupMemberStatusData|GetGroupMemberStatusData]]. Its comments ask addons to prefer the <code>PartyUtils</code> functions.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/partyutils.lua</code>:
<pre>
function PartyUtils.GetPartyData()
if( GameData.Party.partyDirty )
then
partyData = GetGroupData()
GameData.Party.partyDirty = false
end
return partyData
end
</pre>

Testing for an empty slot, from the same file:
<pre>
if( member ~= nil and member.name ~= nil and member.name ~= L"" )
</pre>

== See also ==
* [[API:GetNumGroupmates|GetNumGroupmates]]
* [[API:GetGroupMemberStatusData|GetGroupMemberStatusData]]

API:GetGroupData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)