Options
All
  • Public
  • Public/Protected
  • All
Menu

Composed of a frame, and an action function

Hierarchy

  • AnimationEvent

Index

Constructors

  • new AnimationEvent(frame: number, action: ((currentFrame: number) => void), onlyOnce?: boolean): AnimationEvent
  • Initializes the animation event

    Parameters

    • frame: number

      The frame for which the event is triggered

    • action: ((currentFrame: number) => void)

      The event to perform when triggered

        • (currentFrame: number): void
        • The event to perform when triggered

          Parameters

          • currentFrame: number

          Returns void

    • Optional onlyOnce: boolean

      Specifies if the event should be triggered only once

    Returns AnimationEvent

Properties

action: ((currentFrame: number) => void)

Type declaration

    • (currentFrame: number): void
    • The event to perform when triggered

      Parameters

      • currentFrame: number

      Returns void

frame: number

The frame for which the event is triggered

isDone: boolean

Specifies if the animation event is done

onlyOnce?: boolean

Specifies if the event should be triggered only once

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme