https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AAnimatedImageStartAnimationAPI:AnimatedImageStartAnimation - Revision history2026-10-17T18:49:15ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:AnimatedImageStartAnimation&diff=30173&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:40:24Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=AnimatedImage}}<br />
Starts playing an AnimatedImage.<br />
<br />
<pre><br />
AnimatedImageStartAnimation(imageName, startFrame, loop, hideWhenComplete, delay)<br />
</pre><br />
<br />
== Arguments ==<br />
;imageName : <code>string</code> – Name of an AnimatedImage window.<br />
;startFrame : <code>number</code> – Frame number. The stock UI always passes <code>0</code>. Fractions are dropped.<br />
;loop : <code>boolean</code> – <code>true</code> to start again from the first frame after the last one, <code>false</code> to play once.<br />
;hideWhenComplete : <code>boolean</code> – <code>true</code> to hide the image when a non-looping animation ends.<br />
;delay : <code>number</code> – Seconds to wait before the animation starts. <code>0</code> starts it at once.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* If <code>startFrame</code> is greater than the number of frames in the animation, the call does nothing.<br />
* The function does not show the window. The stock UI shows it first (see the example).<br />
* When a non-looping animation reaches its end, it stops; with <code>hideWhenComplete</code> the image is also hidden.<br />
* The playing speed can be changed with [[API:AnimatedImageSetPlaySpeed|AnimatedImageSetPlaySpeed]].<br />
* <code>loop</code> and <code>hideWhenComplete</code> must be real booleans. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.<br />
* Note the wording of the second error message: it has no "Window" before the name.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'AnimatedImageStartAnimation': Window %s does not exist</code><br />
* <code>Error in function call 'AnimatedImageStartAnimation': %s is not an AnimatedImage</code><br />
<br />
== Example ==<br />
A looping indicator, from <code>ea_menubarwindow/source/menubarwindow.lua</code>:<br />
<pre><br />
if ( SystemData.StreamingData.isStreaming )<br />
then<br />
WindowSetShowing( "StreamingIndicator", true )<br />
WindowSetShowing( "StreamingIndicatorAnim", true )<br />
AnimatedImageStartAnimation( "StreamingIndicatorAnim", 0, true, false, 0 )<br />
else<br />
AnimatedImageStopAnimation( "StreamingIndicatorAnim" )<br />
WindowSetShowing( "StreamingIndicatorAnim", false )<br />
WindowSetShowing( "StreamingIndicator", false )<br />
end<br />
</pre><br />
<br />
A page flip that plays once after a delay and then hides itself, from <code>ea_loadingscreen/source/standardloadingscreen.lua</code>:<br />
<pre><br />
AnimatedImageStartAnimation( windowName.."PageFlipAnim", 0, false, true, animDelay )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:AnimatedImageStopAnimation|AnimatedImageStopAnimation]]<br />
* [[API:AnimatedImageSetPlaySpeed|AnimatedImageSetPlaySpeed]]<br />
* [[API:AnimatedImageSetTexture|AnimatedImageSetTexture]]</div>Maintenance script