Interface CreateSpriteOptions

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

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

Properties

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

Properties

animationID

animationID: Scriptable<string>

animations

animations: CreateSpriteOptionsAnimation[]

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

OptionalanimationStartedAt

animationStartedAt?: Scriptable<number>

Optionalcoordinates

coordinates?: CreateSpriteOptionsCoordinates

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

OptionaldownsampleScale

downsampleScale?: Scriptable<number>

Renders each frame at 1/scale resolution then nearest-filters to the frame size (same idea as tile map downsample). Omitted or 1 disables the extra pass.

imagePath

imagePath: Scriptable<string>

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

OptionalisGrayscale

isGrayscale?: Scriptable<boolean>

Optionalopacity

opacity?: Scriptable<number>

Optionalpalette

palette?: Scriptable<string[]>

Optionalrecolors

recolors?: Scriptable<CreateSpriteOptionsRecolor[]>

Settings

Member Visibility

On This Page

Properties