Class Animatable

Holds the animation state machine of an actor: its states, frames and transitions. Build it in the animation editor. Animator plays it.

See

Hierarchy (View Summary)

Component
- Animatable

Index

Constructors

Properties

actor? duration initialState

Methods

getParentComponent setCurrentState

Constructors

constructor

new Animatable(config: Animation.AnimatableConfig): Animatable
Parameters
- config: Animation.AnimatableConfig
Returns Animatable

Overrides Component.constructor

Properties

`Optional`actor

actor?: Actor

The actor that has this component. It is undefined until the component is added to an actor.

duration

duration: number

Duration of the current state relative to the total duration of the timeline

initialState

initialState: string

Initial state of the animatable component

Methods

getParentComponent

getParentComponent(): Component<object> | undefined

Returns the component of the same class on the parent actor.

Returns Component<object> | undefined
The component, or undefined if the actor has no parent actor or the parent has no such component.

Inherited from Component.getParentComponent

setCurrentState

setCurrentState(currentState: string): void
Switches the animation to another state at once, without a transition.
Parameters
- currentState: string
  The id of the state.
Returns void

Throws
Error If there is no state with this id.