Class SpriteBase

This class holds all the info related to spritesheet data, animations, actions and the appropriate methods to generate this info.

Constructors

constructor

new SpriteBase(data, key_name, actions): SpriteBase
Parameters
- data: any
- key_name: any
- actions: any
Returns SpriteBase
- Defined in base/SpriteBase.ts:27

Properties

`Private` action_aliases

action_aliases: {
[alias: string]: string;
}

Type declaration

[alias: string]: string

`Private` actions

actions: {
    [action: string]: {
        animations?: string[];
        frame_counts?: any;
        frame_names?: {
            [animation: string]: string[];
        };
        frame_rate?: {
            [animation: string]: any;
        };
        loop?: boolean | boolean[];
        spritesheet?: {
            image: string;
            json: string;
        };
    };
}

Type declaration

[action: string]: {
    animations?: string[];
    frame_counts?: any;
    frame_names?: {
        [animation: string]: string[];
    };
    frame_rate?: {
        [animation: string]: any;
    };
    loop?: boolean | boolean[];
    spritesheet?: {
        image: string;
        json: string;
    };
}
- Optional animations?: string[]
- Optional frame_counts?: any
- Optional frame_names?: {
  [animation: string]: string[];
  }
  - [animation: string]: string[]
- Optional frame_rate?: {
  [animation: string]: any;
  }
  - [animation: string]: any
- Optional loop?: boolean | boolean[]
- Optional spritesheet?: {
  image: string;
  json: string;
  }
  - image: string
  - json: string

`Private` data

data: GoldenSun

key_name

key_name: string

`Static` `Readonly` ACTION_ANIM_SEPARATOR

ACTION_ANIM_SEPARATOR: "/" = "/"

Accessors

all_actions

get all_actions(): string[]
Returns string[]
- Defined in base/SpriteBase.ts:37

Methods

generateAllFrames

generateAllFrames(): void
Returns void
- Defined in base/SpriteBase.ts:193

`Private` generateFrameNames

generateFrameNames(action, animation, start, stop, suffix, zeroPad): void
Parameters
- action: any
- animation: any
- start: any
- stop: any
- suffix: any
- zeroPad: any
Returns void
- Defined in base/SpriteBase.ts:152

getActionRefFromAlias

getActionRefFromAlias(alias): string
Parameters
- alias: any
Returns string
- Defined in base/SpriteBase.ts:119

getAnimationKey

getAnimationKey(action, animation): string
Parameters
- action: any
- animation: any
Returns string
- Defined in base/SpriteBase.ts:239

getFrameName

getFrameName(action, animation, index?): string
Parameters
- action: any
- animation: any
- index: number = 0
Returns string
- Defined in base/SpriteBase.ts:204

getFrameNumber

getFrameNumber(action, animation): number
Parameters
- action: any
- animation: any
Returns number
- Defined in base/SpriteBase.ts:222

getFrameRate

getFrameRate(action, animation): any
Parameters
- action: any
- animation: any
Returns any
- Defined in base/SpriteBase.ts:209

getSpriteKey

getSpriteKey(action): string
Parameters
- action: any
Returns string
- Defined in base/SpriteBase.ts:235

hasAction

hasAction(action): boolean
Parameters
- action: string
Returns boolean
- Defined in base/SpriteBase.ts:126

hasAnimation

hasAnimation(action, animation): boolean
Parameters
- action: string
- animation: string
Returns boolean
- Defined in base/SpriteBase.ts:130

loadSpritesheets

loadSpritesheets(game, force_load, on_load_complete?): void
Parameters
- game: Game
- force_load: boolean
- Optional on_load_complete: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in base/SpriteBase.ts:134

setActionAlias

setActionAlias(game, alias, reference_action): void
Parameters
- game: Game
- alias: any
- reference_action: any
Returns void
- Defined in base/SpriteBase.ts:111

setActionAnimations

setActionAnimations(action, animations, frame_counts): void
Parameters
- action: any
- animations: any
- frame_counts: any
Returns void
- Defined in base/SpriteBase.ts:41

setActionFrameRate

setActionFrameRate(action, frame_rate): void
Parameters
- action: any
- frame_rate: any
Returns void
- Defined in base/SpriteBase.ts:64

setActionLoop

setActionLoop(action, loop): void
Parameters
- action: any
- loop: any
Returns void
- Defined in base/SpriteBase.ts:100

setActionSpritesheet

setActionSpritesheet(action, spritesheet_image_url, spritesheet_json_url): void
Parameters
- action: any
- spritesheet_image_url: any
- spritesheet_json_url: any
Returns void
- Defined in base/SpriteBase.ts:104

setAnimation

setAnimation(sprite, action): void
Parameters
- sprite: Sprite
- action: any
Returns void
- Defined in base/SpriteBase.ts:162

`Static` getKeyName

getKeyName(sprite): string
Parameters
- sprite: any
Returns string
- Defined in base/SpriteBase.ts:248

`Static` getSpriteAction

getSpriteAction(sprite): string
Parameters
- sprite: any
Returns string
- Defined in base/SpriteBase.ts:243

Class SpriteBase

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SpriteBase

Properties

Private action_aliases

Type declaration

[alias: string]: string

Private actions

Type declaration

[action: string]: { animations?: string[]; frame_counts?: any; frame_names?: { [animation: string]: string[]; }; frame_rate?: { [animation: string]: any; }; loop?: boolean | boolean[]; spritesheet?: { image: string; json: string; }; }

Optional animations?: string[]

Optional frame_counts?: any

Optional frame_names?: { [animation: string]: string[]; }

[animation: string]: string[]

Optional frame_rate?: { [animation: string]: any; }

[animation: string]: any

Optional loop?: boolean | boolean[]

Optional spritesheet?: { image: string; json: string; }

image: string

json: string

Private data

key_name

Static Readonly ACTION_ANIM_SEPARATOR

Accessors

all_actions

Returns string[]

Methods

generateAllFrames

Returns void

Private generateFrameNames

Parameters

Returns void

getActionRefFromAlias

Parameters

Returns string

getAnimationKey

Parameters

Returns string

getFrameName

Parameters

Returns string

getFrameNumber

Parameters

Returns number

getFrameRate

Parameters

Returns any

getSpriteKey

Parameters

Returns string

hasAction

Parameters

Returns boolean

hasAnimation

Parameters

Returns boolean

loadSpritesheets

Parameters

Returns void

Returns void

setActionAlias

Parameters

Returns void

setActionAnimations

Parameters

Returns void

setActionFrameRate

Parameters

Returns void

setActionLoop

Parameters

Returns void

setActionSpritesheet

`Private` action_aliases

`Private` actions

[action: string]: {
animations?: string[];
frame_counts?: any;
frame_names?: {
[animation: string]: string[];
};
frame_rate?: {
[animation: string]: any;
};
loop?: boolean | boolean[];
spritesheet?: {
image: string;
json: string;
};
}

`Optional` animations?: string[]

`Optional` frame_counts?: any

`Optional` frame_names?: {
[animation: string]: string[];
}

`Optional` frame_rate?: {
[animation: string]: any;
}

`Optional` loop?: boolean | boolean[]

`Optional` spritesheet?: {
image: string;
json: string;
}

`Private` data

`Static` `Readonly` ACTION_ANIM_SEPARATOR

`Private` generateFrameNames

`Static` getKeyName

`Static` getSpriteAction