Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:47Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Resets a window's anchors, size and scale to the defaults from its definition.

<pre>
WindowRestoreDefaultSettings(windowName)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.

== Returns ==
Nothing.

== Details ==
* If the window was created from a definition (XML), the client:
** removes all current anchors,
** restores the size from the definition, if the definition gives one,
** sets the scale of the window and its descendants to a client-wide default scale value, and
** adds the anchors from the definition again.
* After that the window and its descendants are laid out again.
* Finally, the client can call the window's <code>OnInitializeCustomSettings</code> core event handler (see [[API:WindowRegisterCoreEventHandler|WindowRegisterCoreEventHandler]]). This also happens for windows without a definition.
* Alpha, showing state and other settings are not reset by this function.
* There is no lock check in this function.

== Errors ==
* <code>Error in function call 'WindowRestoreDefaultSettings': Window %s does not exist</code>

== Example ==
The layout editor's "restore defaults" for a window, from <code>easystem_layouteditor/source/layoutframe.lua</code>:
<pre>
function LayoutFrame:RestoreDefaults()
WindowRestoreDefaultSettings( self.m_sourceWindowName )
self:SetHidden( self.m_windowData.isDefaultHidden )
end
</pre>

== See also ==
* [[API:WindowClearAnchors|WindowClearAnchors]]
* [[API:WindowSetDimensions|WindowSetDimensions]]
* [[API:WindowSetScale|WindowSetScale]]

API:WindowRestoreDefaultSettings - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)