Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:52:01Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Multiplies a window's scale by a factor.

<pre>
WindowSetRelativeScale(windowName, factor)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;factor : <code>number</code> – Value to multiply the window's current scale by.

== Returns ==
Nothing.

== Details ==
* The window's new scale is its current scale ([[API:WindowGetScale|WindowGetScale]]) times <code>factor</code>.
* Every descendant then gets the window's new scale as its absolute scale, the same as with [[API:WindowSetScale|WindowSetScale]]. The descendants' previous scales are not multiplied.
* The scale changes on every call, so calling it twice with 2 scales the window by 4.
* Unlike [[API:WindowSetScale|WindowSetScale]], there is no check for an unchanged value.
* The function needs at least two arguments and only reads the last two.

== Errors ==
* <code>Error in function call 'WindowSetRelativeScale': Window %s does not exist</code>
* <code>Error in function call 'WindowSetRelativeScale': 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 ==
From <code>easystem_glyphdisplay/source/glyphdisplay.lua</code>:
<pre>
--may have been resized with layout editor...
local newWidth, newHeight = WindowGetDimensions(self.windowName)
local scaleFactor = newWidth / DEFAULT_CONTAINER_WIDTH
WindowSetRelativeScale( self.windowName, scaleFactor )
</pre>

== See also ==
* [[API:WindowSetScale|WindowSetScale]]
* [[API:WindowGetScale|WindowGetScale]]

API:WindowSetRelativeScale - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)