https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AIsScenarioF2PServer 2026-10-18T04:53:34Z Revision history for this page on the wiki MediaWiki 1.43.11 https://wiki.returnofreckoning.com/index.php?title=API:IsScenarioF2PServer&diff=30521&oldid=prev 2026-10-16T19:45:53Z

<p>UI Lua API import (WAR 1.4.8)</p> <p><b>New page</b></p><div>{{LuaApi|group=Scenario}}<br /> Returns whether the client has the &quot;scenario free-to-play server&quot; flag set.<br /> <br /> &lt;pre&gt;<br /> isF2P = IsScenarioF2PServer()<br /> &lt;/pre&gt;<br /> <br /> == Arguments ==<br /> None.<br /> <br /> == Returns ==<br /> ;isF2P : &lt;code&gt;boolean&lt;/code&gt; – &lt;code&gt;true&lt;/code&gt; if the client&#039;s flag has the value 1.<br /> <br /> == Details ==<br /> * The function only reads a value stored by the client. It sends nothing to the server.<br /> * The only stock caller is the character creation screen (&lt;code&gt;interfacecore/source/characterselectwindow.lua&lt;/code&gt;): when the result is &lt;code&gt;false&lt;/code&gt; (or the build is internal), it adds a &quot;no template&quot; entry to the character template list. Its comment calls such servers &quot;template-enforced&quot;.<br /> <br /> == Errors ==<br /> None.<br /> <br /> == Example ==<br /> From &lt;code&gt;interfacecore/source/characterselectwindow.lua&lt;/code&gt;:<br /> &lt;pre&gt;<br /> if(IsScenarioF2PServer() == false or IsInternalBuild())<br /> then<br /> -- Not a template-enforced server, so display the no-template option<br /> CharacterSelectWindow.numTemplates = 1<br /> CharacterSelectWindow.bNoTemplateOptionDisplayed = true<br /> ComboBoxAddMenuItem(&quot;CharacterSelectTemplateOptionsComboBox&quot;, GetPregameString( StringTables.Pregame.LABEL_NO_TEMPLATE ))<br /> end<br /> &lt;/pre&gt;<br /> <br /> == See also ==<br /> * [[API:IsInternalBuild|IsInternalBuild]]<br /> * [[API:GetScenarioQueueData|GetScenarioQueueData]]</div>

Maintenance script