Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:38Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Returns a window's scale.

<pre>
scale = WindowGetScale(windowName)
</pre>

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

== Returns ==
;scale : <code>number</code> – The window's scale. 1 means unscaled.

== Details ==
* The scale is absolute, not relative to the parent. [[API:WindowSetScale|WindowSetScale]] and [[API:WindowSetRelativeScale|WindowSetRelativeScale]] write the same absolute value to all descendants.
* A window's size on screen is its dimensions ([[API:WindowGetDimensions|WindowGetDimensions]]) multiplied by this value.

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

== Example ==
Copying a window's size and scale to a resize frame, from <code>easystem_windowutils/source/windowutils.lua</code>:
<pre>
local width, height = WindowGetDimensions( windowName )
local scale = WindowGetScale(windowName)

WindowSetScale( "ResizingWindowFrame", scale )
WindowSetDimensions( "ResizingWindowFrame", width, height )
</pre>

== See also ==
* [[API:WindowSetScale|WindowSetScale]]
* [[API:WindowSetRelativeScale|WindowSetRelativeScale]]
* [[API:WindowGetDimensions|WindowGetDimensions]]

API:WindowGetScale - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)