https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AJoinScenarioGroup 2026-10-17T22:25:43Z Revision history for this page on the wiki MediaWiki 1.43.11 https://wiki.returnofreckoning.com/index.php?title=API:JoinScenarioGroup&diff=30526&oldid=prev 2026-10-16T19:45:58Z

<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 put the player into a scenario group.<br /> <br /> &lt;pre&gt;<br /> JoinScenarioGroup(groupIndex)<br /> &lt;/pre&gt;<br /> <br /> == Arguments ==<br /> ;groupIndex : &lt;code&gt;number&lt;/code&gt; – Scenario group to join. Only the low 8 bits are sent.<br /> <br /> == Returns ==<br /> Nothing.<br /> <br /> == Details ==<br /> * Nothing happens if there is no player object, or if the player is neither in a scenario (&lt;code&gt;GameData.Player.isInScenario&lt;/code&gt;) nor in a city siege (&lt;code&gt;GameData.Player.isInSiege&lt;/code&gt;). In that case the argument is not checked either.<br /> * Nothing is sent when &lt;code&gt;groupIndex&lt;/code&gt; is &lt;code&gt;0&lt;/code&gt;.<br /> * The client does not change any group data itself; the result comes from the server.<br /> * The function takes exactly one argument.<br /> <br /> == Errors ==<br /> None besides the generic &#039;&#039;Invalid Parameters&#039;&#039; message when the argument is missing or not a number.<br /> <br /> == Example ==<br /> From &lt;code&gt;default/ea_scenariogroupwindow/source/scenariogroupwindow.lua&lt;/code&gt; (each Join button carries its group index as window id):<br /> &lt;pre&gt;<br /> local selGroupIndex = WindowGetId( SystemData.ActiveWindow.name )<br /> JoinScenarioGroup( selGroupIndex )<br /> &lt;/pre&gt;<br /> <br /> == See also ==<br /> * [[API:LeaveScenarioGroup|LeaveScenarioGroup]]<br /> * [[API:GameData.GetScenarioPlayerGroups|GameData.GetScenarioPlayerGroups]]</div>

Maintenance script