https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGetBattlegroupMemberDataAPI:GetBattlegroupMemberData - Revision history2026-10-18T13:12:07ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GetBattlegroupMemberData&diff=30343&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:43:03Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Group}}<br />
Returns the members of all four parties of the player's warband.<br />
<br />
<pre><br />
parties = GetBattlegroupMemberData()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;parties : <code>table</code> – Array of exactly four party tables, <code>parties[1]</code> to <code>parties[4]</code>.<br />
<br />
Each party table has one field:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>players</code> || <code>table</code> || Array of member tables, indexed from 1. Empty for a party that does not exist.<br />
|}<br />
<br />
Each member table has the same fields as the member tables of [[API:GetGroupData|GetGroupData]]: <code>name</code>, <code>careerName</code>, <code>careerLine</code>, <code>level</code>, <code>battleLevel</code>, <code>worldObjNum</code>, <code>healthPercent</code>, <code>actionPointPercent</code>, <code>moraleLevel</code>, <code>isGroupLeader</code>, <code>isRVRFlagged</code>, <code>isInSameRegion</code>, <code>isMainAssist</code>, <code>isMasterLooter</code>, <code>isAssistant</code>, <code>zoneNum</code>, <code>online</code>, <code>isDistant</code> and <code>Pet</code> (a table with <code>healthPercent</code>). Both functions fill the member tables with the same code.<br />
<br />
== Details ==<br />
* The four party tables are always present; a party the client has no data for gets an empty <code>players</code> table.<br />
* <code>isAssistant</code> is <code>true</code> when the member is in the warband's assistant list.<br />
* A new table is built on every call. The stock UI caches it in <code>PartyUtils.GetWarbandData()</code> (refreshed when <code>GameData.Party.warbandDirty</code> is set) and refreshes single members with [[API:GetWarbandMemberStatus|GetWarbandMemberStatus]]. Its comments ask addons to prefer the <code>PartyUtils</code> functions.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/easystem_utils/source/partyutils.lua</code>:<br />
<pre><br />
function PartyUtils.GetWarbandData()<br />
if( GameData.Party.warbandDirty )<br />
then<br />
warbandParties = GetBattlegroupMemberData()<br />
GameData.Party.warbandDirty = false<br />
end<br />
return warbandParties<br />
end<br />
</pre><br />
<br />
Reading one member (same file):<br />
<pre><br />
local party = PartyUtils.GetWarbandParty( partyIndex )<br />
local member = party.players[memberIndex]<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GetGroupData|GetGroupData]]<br />
* [[API:GetWarbandMemberStatus|GetWarbandMemberStatus]]<br />
* [[API:IsWarBandActive|IsWarBandActive]]</div>Maintenance script