View source for API:GameData.GetScenarioPlayerGroups

{{LuaApi|group=Scenario}}
Returns the players of the local player's realm in the current scenario (or city siege instance), with their scenario group slot and status.

<pre>
players = GameData.GetScenarioPlayerGroups()
</pre>

== Arguments ==
None.

== Returns ==
;players : <code>table</code> – Array of player tables, indexed from 1, or nothing if the client has no scenario data.

Each player table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Character name.
|-
| <code>career</code> || <code>wstring</code> || Career name.
|-
| <code>careerId</code> || <code>number</code> || Career id.
|-
| <code>rank</code> || <code>number</code> || Character rank.
|-
| <code>sgroupindex</code> || <code>number</code> || Scenario group the player is in. The stock UI treats <code>0</code> as "not in a group".
|-
| <code>sgroupslotnum</code> || <code>number</code> || Slot within that scenario group.
|-
| <code>health</code> || <code>number</code> || Health percentage.
|-
| <code>ap</code> || <code>number</code> || Action point percentage.
|-
| <code>morale</code> || <code>number</code> || –
|-
| <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]]).
|}

== Details ==
* Only players whose realm matches the local player's realm are listed. If there is no player object, every entry is listed.
* Unlike [[API:GameData.GetScenarioPlayers|GameData.GetScenarioPlayers]] there is no <code>realm</code> field and no stats.
* 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.

== Errors ==
None.

== Example ==
From <code>default/ea_scenariogroupwindow/source/scenariogroupwindow.lua</code>:
<pre>
ScenarioGroupWindow.playerGroupData = GameData.GetScenarioPlayerGroups()
...
if( player.sgroupindex > 0 ) then
    local groupIndex = player.sgroupindex
    local groupSlotNum = player.sgroupslotnum
</pre>

== See also ==
* [[API:GameData.GetScenarioGroupReservations|GameData.GetScenarioGroupReservations]]
* [[API:JoinScenarioGroup|JoinScenarioGroup]]
* [[API:LeaveScenarioGroup|LeaveScenarioGroup]]