Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:52:10Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Starts an animation that moves a window between two positions relative to its parent.

<pre>
WindowStartPositionAnimation(windowName, animationType, startX, startY, endX, endY, duration, setStartBeforeDelay, delay, loopCount)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;animationType : <code>number</code> – How the position changes over time. Use a <code>Window.AnimationType</code> constant; see [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]] for the list.
;startX, startY : <code>number</code> – Start offset of the window's top-left corner from its parent's top-left corner, in screen pixels.
;endX, endY : <code>number</code> – End offset, in screen pixels.
;duration : <code>number</code> – Length of one pass from start to end, in seconds.
;setStartBeforeDelay : <code>boolean</code> – <code>true</code> to move the window to the start position straight away, during the delay. See Details for what <code>false</code> does.
;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]]. X and Y are animated separately with the same settings.
* The positions are in screen pixels. They are '''not''' multiplied by the window's scale, unlike the values of [[API:WindowSetOffsetFromParent|WindowSetOffsetFromParent]]. The stock alert text window multiplies the result of [[API:WindowGetOffsetFromParent|WindowGetOffsetFromParent]] by the interface scale before using it here (see the example).
* "Original position" for the resetting types is the window's offset from its parent when the animation was started.
* Unlike the alpha and scale animations, the value used before the animation starts is not the window's current position but (0, 0). With a <code>delay</code> and <code>setStartBeforeDelay = false</code>, the window therefore sits at its parent's top-left corner until the delay is over. Pass <code>true</code> to avoid this.
* Each frame the new offset is applied the same way as a moved window, so the client may keep the window on screen (see [[API:WindowIsSticky|WindowIsSticky]]).
* The window's anchors are not removed. The stock UI clears and re-adds anchors around position animations; its comment says ''"animation ignores the anchors"''.
* A window has at most one position animation. Starting a new one stops the old one first.
* <code>animationType</code> and <code>loopCount</code> are truncated to whole numbers.

== Errors ==
* <code>Error in function call 'WindowStartPositionAnimation': Window %s does not exist</code>
* <code>Error in function call 'WindowStartPositionAnimation': 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 ==
Sliding an alert upwards, from <code>ea_alerttextwindow/source/alerttextwindow.lua</code>:
<pre>
-- Get where we are
local x, y = WindowGetOffsetFromParent( oldestWindowName )
WindowStopPositionAnimation( oldestWindowName )

-- reset the anchor for the oldest window
-- because animation ignores the anchors
WindowClearAnchors( oldestWindowName )
WindowAddAnchor( oldestWindowName, "top", "Root", "top", 0, y )

local uiScale = InterfaceCore.GetScale()
x = uiScale * x
y = uiScale * y

local targetY = y - AlertTextWindow.NewestHeight
WindowStartPositionAnimation( oldestWindowName,
Window.AnimationType.SINGLE_NO_RESET,
x,
y,
x,
targetY,
AlertTextWindow.ANIMATION_DATA.duration,
true, 0, 0 )
</pre>

== See also ==
* [[API:WindowStopPositionAnimation|WindowStopPositionAnimation]]
* [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]]
* [[API:WindowSetOffsetFromParent|WindowSetOffsetFromParent]]

API:WindowStartPositionAnimation - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)