https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AAnimatedImageSetPlaySpeedAPI:AnimatedImageSetPlaySpeed - Revision history2026-10-17T18:49:18ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:AnimatedImageSetPlaySpeed&diff=30171&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:40:22Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=AnimatedImage}}<br />
Sets how fast an AnimatedImage plays.<br />
<br />
<pre><br />
AnimatedImageSetPlaySpeed(imageName, framesPerSecond)<br />
</pre><br />
<br />
== Arguments ==<br />
;imageName : <code>string</code> – Name of an AnimatedImage window.<br />
;framesPerSecond : <code>number</code> – Playing speed in frames per second.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The client stores the time per frame, <code>1 / framesPerSecond</code>. There is no check for 0; with 0 the animation does not advance.<br />
* In the stock XML, <code>AnimatedImage</code> elements give their speed with an <code>fps</code> attribute, for example <code>fps="10"</code>.<br />
* The function needs at least two arguments and only reads the last two.<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 'AnimatedImageSetPlaySpeed': Window %s does not exist</code><br />
* <code>Error in function call 'AnimatedImageSetPlaySpeed': %s is not an AnimatedImage</code><br />
<br />
== Example ==<br />
From <code>ea_loadingscreen/source/standardloadingscreen.lua</code> (<code>FLIP_FPS</code> is 12):<br />
<pre><br />
AnimatedImageSetPlaySpeed( windowName.."PageFlipAnim", EA_Window_LoadingScreen.FLIP_FPS )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:AnimatedImageStartAnimation|AnimatedImageStartAnimation]]</div>Maintenance script