Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:52:13Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Stops a window's position animation.

<pre>
WindowStopPositionAnimation(windowName)
</pre>

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

== Returns ==
Nothing.

== Details ==
* Stops the animation started with [[API:WindowStartPositionAnimation|WindowStartPositionAnimation]].
* For the animation types <code>SINGLE</code>, <code>LOOP</code>, <code>REPEAT</code>, <code>POP</code> and <code>POP_AND_EASE</code>, the window goes back to the offset it had when the animation was started. For the other types it stays where it is.
* If the window has no position animation, nothing happens.

== Errors ==
* <code>Error in function call 'WindowStopPositionAnimation': Window %s does not exist</code>
* <code>Error in function call 'WindowStopPositionAnimation': 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 ==
Restarting a looping slider animation, from <code>ea_craftingwindow/source/apothecarywindow.lua</code>:
<pre>
function ApothecaryWindow.UpdateStabilityAnimation()
WindowStopPositionAnimation( windowName.."StabilityMeterSlider" )

local currentAnimationPoints = ApothecaryWindow.stabilityAnimationPoints[ApothecaryWindow.stabilityCurrentState]

WindowStartPositionAnimation( windowName.."StabilityMeterSlider",
Window.AnimationType.LOOP,
currentAnimationPoints.startX,
currentAnimationPoints.startY,
currentAnimationPoints.stopX,
currentAnimationPoints.stopY,
ApothecaryWindow.stabilityAnimationDuration,
false, 0, 0 )
end
</pre>

== See also ==
* [[API:WindowStartPositionAnimation|WindowStartPositionAnimation]]
* [[API:WindowStopAlphaAnimation|WindowStopAlphaAnimation]]

API:WindowStopPositionAnimation - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)