https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AGameData.GetScenarioPlayersAPI:GameData.GetScenarioPlayers - Revision history2026-10-26T17:32:43ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:GameData.GetScenarioPlayers&diff=30308&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:42:31Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Scenario}}<br />
Returns the scoreboard of the current scenario (or city siege instance): one entry per player with their stats.<br />
<br />
<pre><br />
players = GameData.GetScenarioPlayers()<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. The stock UI turns it into an icon with <code>Icons.GetCareerIconIDFromCareerNamesID</code>.<br />
|-<br />
| <code>rank</code> || <code>number</code> || Character rank.<br />
|-<br />
| <code>realm</code> || <code>number</code> || Realm of the player.<br />
|-<br />
| <code>solokills</code> || <code>number</code> || –<br />
|-<br />
| <code>groupkills</code> || <code>number</code> || –<br />
|-<br />
| <code>deathblows</code> || <code>number</code> || –<br />
|-<br />
| <code>deaths</code> || <code>number</code> || –<br />
|-<br />
| <code>damagedealt</code> || <code>number</code> || –<br />
|-<br />
| <code>healingdealt</code> || <code>number</code> || –<br />
|-<br />
| <code>renown</code> || <code>number</code> || –<br />
|-<br />
| <code>renownbonus</code> || <code>number</code> || –<br />
|-<br />
| <code>experience</code> || <code>number</code> || –<br />
|-<br />
| <code>experiencebonus</code> || <code>number</code> || –<br />
|-<br />
| <code>isplayer</code> || <code>boolean</code> || <code>true</code> for the local player's own entry.<br />
|}<br />
<br />
== Details ==<br />
* Players of both realms are included.<br />
* When <code>GameData.Player.isInSiege</code> is true the client reads the city instance's player list; otherwise it reads the scenario's list. If the list it needs does not exist, the function returns nothing.<br />
* The stat keys are all lower case.<br />
* A new table is built on every call. The stock scenario summary window rebuilds its data from it on the <code>SCENARIO_PLAYERS_LIST_UPDATED</code> and <code>SCENARIO_PLAYERS_LIST_STATS_UPDATED</code> events.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_scenariosummarywindow/scenariosummarywindow.lua</code> (shortened):<br />
<pre><br />
local interimPlayerData = GameData.GetScenarioPlayers()<br />
if( interimPlayerData ~= nil ) then<br />
for key, value in ipairs( interimPlayerData ) do<br />
ScenarioSummaryWindow.playersData[key] = {}<br />
ScenarioSummaryWindow.playersData[key].name = value.name<br />
ScenarioSummaryWindow.playersData[key].solokills = value.solokills<br />
ScenarioSummaryWindow.playersData[key].isplayer = value.isplayer<br />
ScenarioSummaryWindow.playersData[key].careerIcon = Icons.GetCareerIconIDFromCareerNamesID(value.careerId)<br />
end<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:GameData.GetScenarioPlayerGroups|GameData.GetScenarioPlayerGroups]]<br />
* [[API:GetCityInstanceId|GetCityInstanceId]]</div>Maintenance script