https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALeaveScenarioGroupAPI:LeaveScenarioGroup - Revision history2026-10-18T04:53:55ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:LeaveScenarioGroup&diff=30560&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:46:32Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Scenario}}<br />
Asks the server to remove the player from their scenario group.<br />
<br />
<pre><br />
LeaveScenarioGroup()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* Nothing is sent if there is no player object, or if the player is neither in a scenario (<code>GameData.Player.isInScenario</code>) nor in a city siege (<code>GameData.Player.isInSiege</code>).<br />
* Arguments are not read.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_scenariogroupwindow/source/scenariogroupwindow.lua</code>:<br />
<pre><br />
function ScenarioGroupWindow.LeaveGroup()<br />
LeaveScenarioGroup()<br />
ScenarioGroupWindow.GroupJoined = 0<br />
ScenarioGroupWindow.HideLeaveGroupElements()<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:JoinScenarioGroup|JoinScenarioGroup]]</div>Maintenance script