Interface CreateSpriteOptions

Information used to decide when an animation should be played for a Sprite

interface CreateSpriteOptions {
    animationID: Scriptable<string>;
    animationStartedAt?: Scriptable<number>;
    animations: CreateSpriteOptionsAnimation[];
    coordinates?: CreateSpriteOptionsCoordinates;
    imagePath: Scriptable<string>;
    isGrayscale?: Scriptable<boolean>;
    palette?: Scriptable<string[]>;
    recolors?: Scriptable<CreateSpriteOptionsRecolor[]>;
}

Properties

animationID animationStartedAt? animations coordinates? imagePath isGrayscale? palette? recolors?

Properties

animationID

animationID: Scriptable<string>

Optional animationStartedAt

animationStartedAt?: Scriptable<number>

animations

animations: CreateSpriteOptionsAnimation[]

Array of Animations that are able to be indentified by their AnimationID to play the animation

Optional coordinates

coordinates?: CreateSpriteOptionsCoordinates

Optional coordinates that can be used to precisely define where the Sprite should be on the screen

imagePath

imagePath: Scriptable<string>

Optional isGrayscale

isGrayscale?: Scriptable<boolean>

String path to the sprite sheet, automatically starts in images folder**

Example

imagePath: "player", // The actual path to the file is {PROJECTFILE}/images/player.png

Optional palette

palette?: Scriptable<string[]>

Optional recolors

recolors?: Scriptable<CreateSpriteOptionsRecolor[]>

Settings

Member Visibility

Theme

On This Page

animationIDanimationStartedAtanimationscoordinatesimagePathisGrayscalepaletterecolors