phaser - v4.0.0-rc.4
    Preparing search index...

    A single frame in an Animation sequence.

    An AnimationFrame consists of a reference to the Texture it uses for rendering, references to other frames in the animation, and index data. It also has the ability to modify the animation timing.

    AnimationFrames are generated automatically by the Animation class.

    Index

    Constructors

    • Parameters

      • textureKey: string

        The key of the Texture this AnimationFrame uses.

      • textureFrame: string | number

        The key of the Frame within the Texture that this AnimationFrame uses.

      • index: number

        The index of this AnimationFrame within the Animation sequence.

      • frame: Frame

        A reference to the Texture Frame this AnimationFrame uses for rendering.

      • OptionalisKeyFrame: boolean

        Is this Frame a Keyframe within the Animation? Default false.

      Returns Animations.AnimationFrame

    Properties

    duration: number

    The duration, in ms, of this frame of the animation.

    frame: Frame

    A reference to the Texture Frame this AnimationFrame uses for rendering.

    index: number

    The index of this AnimationFrame within the Animation sequence.

    isFirst: boolean

    Is this the first frame in an animation sequence?

    isKeyFrame: boolean

    Is this Frame a KeyFrame within the Animation?

    isLast: boolean

    Is this the last frame in an animation sequence?

    A reference to the AnimationFrame that comes after this one in the animation, if any.

    A reference to the AnimationFrame that comes before this one in the animation, if any.

    progress: number

    What % through the animation does this frame come? This value is generated when the animation is created and cached here.

    textureFrame: string | number

    The key of the Frame within the Texture that this AnimationFrame uses.

    textureKey: string

    The key of the Texture this AnimationFrame uses.

    Methods

    • Destroys this object by removing references to external resources and callbacks.

      Returns void