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

    Type Alias SpriteSheetFromAtlasConfig

    type SpriteSheetFromAtlasConfig = {
        atlas: string;
        endFrame?: number;
        frame: string;
        frameHeight?: number;
        frameWidth: number;
        margin?: number;
        spacing?: number;
        startFrame?: number;
    }
    Index

    Properties

    atlas endFrame? frame frameHeight? frameWidth margin? spacing? startFrame?

    Properties

    atlas: string

    The key of the Texture Atlas in which this Sprite Sheet can be found.

    endFrame?: number

    The total number of frames to extract from the Sprite Sheet. The default value of -1 means "extract all frames".

    frame: string

    The key of the Texture Atlas Frame in which this Sprite Sheet can be found.

    frameHeight?: number

    The fixed height of each frame. If not set it will use the frameWidth as the height.

    frameWidth: number

    The fixed width of each frame.

    margin?: number

    If the frames have been drawn with a margin, specify the amount here.

    spacing?: number

    If the frames have been drawn with spacing between them, specify the amount here.

    startFrame?: number

    Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.

    Settings

    Member Visibility

    On This Page

    Properties