API:AnimatedImageStopAnimation

UI Lua API · AnimatedImage functions
Version: WAR 1.4.8

Stops a playing AnimatedImage and hides it.

AnimatedImageStopAnimation(imageName)

Arguments

imageName

string – 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 delay given to 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

• Error in function call 'AnimatedImageStopAnimation': Window %s does not exist
• Error in function call 'AnimatedImageStopAnimation': %s is not an AnimatedImage

Example

From ea_loadingscreen/source/standardloadingscreen.lua:

AnimatedImageStopAnimation( textContainerName.."LoadingAnim" )

The AnimatedImage frame class in easystem_windowutils/source/animatedimage.lua only calls it while it knows the animation is playing:

if (self.m_AnimationPlaying == true)
then
    AnimatedImageStopAnimation (self:GetName ())
    self.m_AnimationPlaying = false
end

See also

• AnimatedImageStartAnimation