PokéRogue
    Preparing search index...

    A single frame within an Animation sequence.

    An AnimationFrame holds a reference to the Texture Frame it uses for rendering, links to the previous and next frames in the sequence, its position index, and playback progress data. It can also carry an optional per-frame duration that overrides the parent Animation's default frame rate, and can be flagged as a keyframe to mark significant moments in the sequence.

    AnimationFrames are created and managed automatically by the Animation class when an animation is built via the Animation Manager. You would not typically instantiate AnimationFrame directly.

    Index
    • 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 AnimationFrame

    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?

    nextFrame: AnimationFrame | null

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

    prevFrame: AnimationFrame | null

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

    progress: number

    The normalized progress of this frame within the animation, in the range 0 to 1. A value of 0 means the very start of the animation and 1 means the very end. This value is calculated 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.

    • Destroys this object by removing references to external resources.

      Returns void

    • Generates a JavaScript object suitable for converting to JSON.undefined

      Returns JSONAnimationFrame

      The AnimationFrame data.