xy::SpriteAnimation Struct Reference

Component which contains information about the currently playing sprite animation. Requires a SpriteAnimator system in the scene. More...

#include <SpriteAnimation.hpp>

Public Member Functions
void	play (std::size_t index)
	Play the animation at the given index if it exists.
std::size_t	getAnimationIndex () const
	Returns the currently playing animation index, or the last played index if the animation is currently not playing.
void	pause ()
	Pause the playing animation, if there is one.
void	stop ()
	Stops the current animation if it is playing and rewinds it to the first frame if it is playing or paused.
bool	stopped () const
	Returns true if the current animation has stopped playing.
sf::Uint32	getFrameID () const
	Returns the current frame ID.
void	setFrameID (sf::Uint32 frameID)
	Set the current frame ID.

Friends
class	SpriteAnimator

Detailed Description

Component which contains information about the currently playing sprite animation. Requires a SpriteAnimator system in the scene.