Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:52:04Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Sets the scale of a window and all of its descendants.

<pre>
WindowSetScale(windowName, scale)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;scale : <code>number</code> – New absolute scale. 1 means unscaled.

== Returns ==
Nothing.

== Details ==
* The window and every descendant get exactly this scale. Child windows do not keep a scale of their own relative to the parent.
* The dimensions ([[API:WindowGetDimensions|WindowGetDimensions]]) do not change; the size on screen is the dimensions multiplied by the new scale.
* If the new scale differs from the window's current scale only by a very small amount, the call does nothing.
* A running scale animation overwrites the value on its next frame. Stop it first with [[API:WindowStopScaleAnimation|WindowStopScaleAnimation]].
* The function needs at least two arguments and only reads the last two.

== Errors ==
* <code>Error in function call 'WindowSetScale': Window %s does not exist</code>
* <code>Error in function call 'WindowSetScale': 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]].

== Example ==
Restoring a window's settings after editing, from <code>easystem_layouteditor/source/layoutframe.lua</code>:
<pre>
-- Restore the Size
WindowSetDimensions( self.m_sourceWindowName, self.m_originalWidth , self.m_originalHeight )

-- Restore the Scale
WindowSetScale( self.m_sourceWindowName, self.m_originalScale )
</pre>

== See also ==
* [[API:WindowGetScale|WindowGetScale]]
* [[API:WindowSetRelativeScale|WindowSetRelativeScale]]
* [[API:WindowStartScaleAnimation|WindowStartScaleAnimation]]

API:WindowSetScale - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)