Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:25Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=AnimatedImage}}
Stops a playing AnimatedImage and hides it.

<pre>
AnimatedImageStopAnimation(imageName)
</pre>

== Arguments ==
;imageName : <code>string</code> – Name of an AnimatedImage window.

== Returns ==
Nothing.

== Details ==
* If the animation is playing, it is stopped and the image is hidden.
* If it is not playing, nothing happens. This includes an animation that is still waiting out the <code>delay</code> given to [[API:AnimatedImageStartAnimation|AnimatedImageStartAnimation]]: the wait continues and the animation still starts afterwards.
* Note the wording of the second error message: it has no "Window" before the name.

== Errors ==
* <code>Error in function call 'AnimatedImageStopAnimation': Window %s does not exist</code>
* <code>Error in function call 'AnimatedImageStopAnimation': %s is not an AnimatedImage</code>

== Example ==
From <code>ea_loadingscreen/source/standardloadingscreen.lua</code>:
<pre>
AnimatedImageStopAnimation( textContainerName.."LoadingAnim" )
</pre>

The <code>AnimatedImage</code> frame class in <code>easystem_windowutils/source/animatedimage.lua</code> only calls it while it knows the animation is playing:
<pre>
if (self.m_AnimationPlaying == true)
then
AnimatedImageStopAnimation (self:GetName ())
self.m_AnimationPlaying = false
end
</pre>

== See also ==
* [[API:AnimatedImageStartAnimation|AnimatedImageStartAnimation]]

API:AnimatedImageStopAnimation - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)