Open 3D Engine LyShine Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
UiFlipbookAnimationNotifications Class Reference

Allows listeners to be aware of events, like loop completion, occurring. More...

#include <UiFlipbookAnimationBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void OnAnimationStarted ()
 Notify listeners when the animation starts.
 
virtual void OnAnimationStopped ()
 Notify listeners when the animation stops.
 
virtual void OnLoopSequenceCompleted ()
 

Detailed Description

Allows listeners to be aware of events, like loop completion, occurring.

Member Function Documentation

◆ OnLoopSequenceCompleted()

virtual void UiFlipbookAnimationNotifications::OnLoopSequenceCompleted ( )
inlinevirtual

Notify listeners when the current loop sequence has completed

This will only trigger for LoopType sequences other than None.

For Linear LoopType, this will trigger on the last frame of the last frame of the loop.

For PingPong LoopType, this will trigger on the last frame of the loop sequence before reversing the loop direction.


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