Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:52:11Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Starts an animation of a window's scale.

<pre>
WindowStartScaleAnimation(windowName, animationType, startScale, endScale, duration, setStartBeforeDelay, delay, loopCount)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;animationType : <code>number</code> – How the scale changes over time. Use a <code>Window.AnimationType</code> constant; see [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]] for the list.
;startScale : <code>number</code> – Scale at the start of the animation.
;endScale : <code>number</code> – Scale at the end of the animation.
;duration : <code>number</code> – Length of one pass from start to end, in seconds.
;setStartBeforeDelay : <code>boolean</code> – <code>true</code> to apply <code>startScale</code> straight away, during the delay.
;delay : <code>number</code> – Seconds to wait before the animation starts.
;loopCount : <code>number</code> – For <code>LOOP</code> and <code>REPEAT</code>: how many passes to run. 0 runs until stopped.

== Returns ==
Nothing.

== Details ==
* The animation types, the delay, the loop count and the reset at the end work as described on [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]]. "Original scale" for the resetting types is the window's scale when the animation was started.
* Each frame the scale is applied as with [[API:WindowSetScale|WindowSetScale]], so all descendants get the same absolute scale.
* A window has at most one scale animation. Starting a new one stops the old one first.
* <code>animationType</code> and <code>loopCount</code> are truncated to whole numbers.
* The stock UI never calls <code>WindowStartScaleAnimation</code>.

== Errors ==
* <code>Error in function call 'WindowStartScaleAnimation': Window %s does not exist</code>
* <code>Error in function call 'WindowStartScaleAnimation': 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 ==
A minimal example built from the signature above: grow a window to 1.2 times its size and back, three times, without a delay.
<pre>
WindowStartScaleAnimation( "MyWindow", Window.AnimationType.LOOP, 1.0, 1.2, 0.25, false, 0, 3 )
</pre>

== See also ==
* [[API:WindowStopScaleAnimation|WindowStopScaleAnimation]]
* [[API:WindowSetScale|WindowSetScale]]
* [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]]

API:WindowStartScaleAnimation - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)