UiAnimationInterface Class Reference

Inherits AZ::ComponentBus.

Public Member Functions
virtual void	StartSequence (const AZStd::string &sequenceName)=0
	Start a sequence.
virtual void	PlaySequenceRange (const AZStd::string &sequenceName, float startTime, float endTime)=0
	Play a sequence from startTime to endTime.
virtual void	StopSequence (const AZStd::string &sequenceName)=0
	Stop a sequence.
virtual void	AbortSequence (const AZStd::string &sequenceName)=0
	Abort a sequence.
virtual void	PauseSequence (const AZStd::string &sequenceName)=0
	Pause a sequence.
virtual void	ResumeSequence (const AZStd::string &sequenceName)=0
	Resume a sequence.
virtual void	ResetSequence (const AZStd::string &sequenceName)=0
	Reset a sequence.
virtual float	GetSequencePlayingSpeed (const AZStd::string &sequenceName)=0
	Get the speed of a sequence.
virtual void	SetSequencePlayingSpeed (const AZStd::string &sequenceName, float speed)=0
	Set the speed of a sequence.
virtual float	GetSequencePlayingTime (const AZStd::string &sequenceName)=0
	Get the current time of a sequence.
virtual bool	IsSequencePlaying (const AZStd::string &sequenceName)=0
	Get whether a sequence is currently playing.
virtual float	GetSequenceLength (const AZStd::string &sequenceName)=0
	Get the length of a sequence in seconds.
virtual void	SetSequenceStopBehavior (IUiAnimationSystem::ESequenceStopBehavior stopBehavior)=0
	Set the behavior a sequence will exhibit when it stops playing.

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	Only one component on a entity can implement the events.

---

The documentation for this class was generated from the following file:

• Gems/LyShine/Code/Include/LyShine/Bus/UiAnimationBus.h