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

    Type Alias Animation

    type Animation = {
        defaultTextureKey?: string;
        delay?: number;
        duration?: number;
        frameRate?: number;
        frames?: string | Types.Animations.AnimationFrame[];
        hideOnComplete?: boolean;
        key?: string;
        randomFrame?: boolean;
        repeat?: number;
        repeatDelay?: number;
        showBeforeDelay?: boolean;
        showOnStart?: boolean;
        skipMissedFrames?: boolean;
        sortFrames?: boolean;
        yoyo?: boolean;
    }
    Index

    Properties

    defaultTextureKey? delay? duration? frameRate? frames? hideOnComplete? key? randomFrame? repeat? repeatDelay? showBeforeDelay? showOnStart? skipMissedFrames? sortFrames? yoyo?

    Properties

    defaultTextureKey?: string

    The key of the texture all frames of the animation will use. Can be overridden on a per frame basis.

    delay?: number

    Delay before starting playback. Value given in milliseconds.

    duration?: number

    How long the animation should play for in milliseconds. If not given its derived from frameRate.

    frameRate?: number

    The frame rate of playback in frames per second (default 24 if duration is null)

    frames?: string | Types.Animations.AnimationFrame[]

    Either a string, in which case it will use all frames from a texture with the matching key, or an array of Animation Frame configuration objects.

    hideOnComplete?: boolean

    Should sprite.visible = false when the animation finishes?

    key?: string

    The key that the animation will be associated with. i.e. sprite.animations.play(key)

    randomFrame?: boolean

    Start playback of this animation from a randomly selected frame?

    repeat?: number

    Number of times to repeat the animation (-1 for infinity)

    repeatDelay?: number

    Delay before the animation repeats. Value given in milliseconds.

    showBeforeDelay?: boolean

    If this animation has a delay, should it show the first frame immediately (true), or only after the delay (false)

    showOnStart?: boolean

    Should sprite.visible = true when the animation starts to play? This happens after any delay, if set.

    skipMissedFrames?: boolean

    Skip frames if the time lags, or always advanced anyway?

    sortFrames?: boolean

    If you provide a string for frames you can optionally have the frame names numerically sorted.

    yoyo?: boolean

    Should the animation yoyo? (reverse back down to the start) before repeating?

    Settings

    Member Visibility

    On This Page

    Properties