Class Animator

Animator system that manages the animation of actors with Animatable components using the state machine approach

Hierarchy (View Summary)

SceneSystem
- Animator

Index

Constructors

Properties

Methods

fixedUpdate? onSceneDestroy onSceneEnter? onSceneExit? onSceneLoad? update

Constructors

constructor

new Animator(options: SceneSystemOptions): Animator
Parameters
- options: SceneSystemOptions
Returns Animator

Overrides SceneSystem.constructor

Properties

`Static`systemName

systemName: string

Unique name identifier for the system

Methods

`Optional`fixedUpdate

fixedUpdate?(): void

Called with fixed timestep for physics calculations

Returns void

Inherited from SceneSystem.fixedUpdate

onSceneDestroy

onSceneDestroy(): void

Called when a scene is destroyed

Returns void

Overrides SceneSystem.onSceneDestroy

`Optional`onSceneEnter

onSceneEnter?(scene: Scene): void
Called when a scene becomes active
Parameters
- scene: Scene
Returns void

Inherited from SceneSystem.onSceneEnter

`Optional`onSceneExit

onSceneExit?(scene: Scene): void
Called when a scene becomes inactive, but still remains in memory
Parameters
- scene: Scene
Returns void

Inherited from SceneSystem.onSceneExit

`Optional`onSceneLoad

onSceneLoad?(scene: Scene): Promise<void>
Called when a scene is loaded. Used to load required resources for the system such as images, fonts, etc.
Parameters
- scene: Scene
Returns Promise<void>

Inherited from SceneSystem.onSceneLoad

update

update(): void

Called every frame with variable timestep

Returns void

Overrides SceneSystem.update