Options
Menu

Class AnimationStateEvent

Dispatched to notify changes in an animation state's state.

Hierarchy

  • EventBase

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new AnimationStateEvent(type: string, animator: AnimatorBase, animationState: IAnimationState, animationNode: AnimationNodeBase): AnimationStateEvent

  • Create a new AnimatonStateEvent

    Parameters

    • type: string

      The event type.

    • animator: AnimatorBase

      The animation state object that is the subject of this event.

    • animationState: IAnimationState
    • animationNode: AnimationNodeBase

      The animation node inside the animation state from which the event originated.

    Returns AnimationStateEvent

Properties

target

target: any

Reference to target object

property

target

type

Object

type

type: string

Type of event

property

type

type

String

Static PLAYBACK_COMPLETE

PLAYBACK_COMPLETE: string

Dispatched when a non-looping clip node inside an animation state reaches the end of its timeline.

Static TRANSITION_COMPLETE

TRANSITION_COMPLETE: string

Accessors

animationNode

  • get (): AnimationNodeBase

  • The animation node inside the animation state from which the event originated.

    Returns AnimationNodeBase

animationState

  • get (): IAnimationState

  • The animation state object that is the subject of this event.

    Returns IAnimationState

animator

  • get (): AnimatorBase

  • The animator object that is the subject of this event.

    Returns AnimatorBase

Methods

clone

  • Clones the event.

    Returns AnimationStateEvent

    An exact duplicate of the current object.

Generated using TypeDoc