https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AWindowSetLayerAPI:WindowSetLayer - Revision history2026-10-18T04:52:58ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:WindowSetLayer&diff=30900&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:51:55Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Window}}<br />
Sets the layer a window is drawn on, relative to its siblings.<br />
<br />
<pre><br />
WindowSetLayer(windowName, layer)<br />
</pre><br />
<br />
== Arguments ==<br />
;windowName : <code>string</code> – Name of the window.<br />
;layer : <code>number</code> – New layer. Use one of the <code>Window.Layers</code> constants below.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The client defines these constants:<br />
{| class="wikitable"<br />
! Constant !! Value<br />
|-<br />
| <code>Window.Layers.BACKGROUND</code> || 0<br />
|-<br />
| <code>Window.Layers.DEFAULT</code> || 1<br />
|-<br />
| <code>Window.Layers.SECONDARY</code> || 2<br />
|-<br />
| <code>Window.Layers.POPUP</code> || 3<br />
|-<br />
| <code>Window.Layers.OVERLAY</code> || 4<br />
|}<br />
* Layers only order a window against its siblings (windows with the same parent). Siblings on a higher layer are drawn in front.<br />
* The window is moved in its parent's child list to the front of the siblings on its new layer. Calling the function with the window's current layer therefore also raises it within that layer.<br />
* <code>layer</code> is truncated to a whole number and stored in one byte, so values outside 0–255 wrap around. The value is not checked against the constants.<br />
* The function needs at least two arguments and only reads the last two.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'WindowSetLayer': Window %s does not exist</code><br />
* <code>Error in function call 'WindowSetLayer': Window %s is currently locked and may not be modified from lua. ...</code><br/>This check never triggers in the current client. See [[API:WindowSetShowing|WindowSetShowing]].<br />
<br />
== Example ==<br />
From <code>ea_scenariosummarywindow/scenariosummarywindow.lua</code>:<br />
<pre><br />
-- Move the window to the overlay layer when in loading mode<br />
if( inLoadingMode ) then<br />
WindowSetLayer("ScenarioSummaryWindow", Window.Layers.OVERLAY )<br />
-- ...<br />
else<br />
WindowSetLayer("ScenarioSummaryWindow", Window.Layers.SECONDARY )<br />
-- ...<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:WindowGetLayer|WindowGetLayer]]<br />
* [[API:WindowSetPopable|WindowSetPopable]]<br />
* [[API:WindowSetParent|WindowSetParent]]</div>Maintenance script