https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGameData.GetScenarioPlayerGroupsAPI:GameData.GetScenarioPlayerGroups - Revision history2026-10-17T15:22:05ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GameData.GetScenarioPlayerGroups&diff=30307&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:42:30Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Scenario}}<br />
Returns the players of the local player's realm in the current scenario (or city siege instance), with their scenario group slot and status.<br />
<br />
<pre><br />
players = GameData.GetScenarioPlayerGroups()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;players : <code>table</code> – Array of player tables, indexed from 1, or nothing if the client has no scenario data.<br />
<br />
Each player table has these fields:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Character name.<br />
|-<br />
| <code>career</code> || <code>wstring</code> || Career name.<br />
|-<br />
| <code>careerId</code> || <code>number</code> || Career id.<br />
|-<br />
| <code>rank</code> || <code>number</code> || Character rank.<br />
|-<br />
| <code>sgroupindex</code> || <code>number</code> || Scenario group the player is in. The stock UI treats <code>0</code> as "not in a group".<br />
|-<br />
| <code>sgroupslotnum</code> || <code>number</code> || Slot within that scenario group.<br />
|-<br />
| <code>health</code> || <code>number</code> || Health percentage.<br />
|-<br />
| <code>ap</code> || <code>number</code> || Action point percentage.<br />
|-<br />
| <code>morale</code> || <code>number</code> || –<br />
|-<br />
| <code>isMainAssist</code> || <code>boolean</code> || <code>true</code> for the player the client has stored as the local player's main assist (see [[API:IsPlayerMainAssist|IsPlayerMainAssist]]).<br />
|}<br />
<br />
== Details ==<br />
* Only players whose realm matches the local player's realm are listed. If there is no player object, every entry is listed.<br />
* Unlike [[API:GameData.GetScenarioPlayers|GameData.GetScenarioPlayers]] there is no <code>realm</code> field and no stats.<br />
* When <code>GameData.Player.isInSiege</code> is true the client reads the city instance's list; otherwise it reads the scenario's list. If that list does not exist, the function returns nothing.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_scenariogroupwindow/source/scenariogroupwindow.lua</code>:<br />
<pre><br />
ScenarioGroupWindow.playerGroupData = GameData.GetScenarioPlayerGroups()<br />
...<br />
if( player.sgroupindex > 0 ) then<br />
local groupIndex = player.sgroupindex<br />
local groupSlotNum = player.sgroupslotnum<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GameData.GetScenarioGroupReservations|GameData.GetScenarioGroupReservations]]<br />
* [[API:JoinScenarioGroup|JoinScenarioGroup]]<br />
* [[API:LeaveScenarioGroup|LeaveScenarioGroup]]</div>Maintenance script