Class SpriteSheet

The core building block in terms of optimized 2D batch rendering.

Create a SpriteSheet:

assets/gui.sheet.json              // create an empty json with '{}'
assets/gui/logo.single.png         // Insert as many source files you need.
assets/gui/title.single.png        // Useful naming convention avoids configuration
assets/gui/buttons.slices.aseprite // Nice format support (*)

*) Aseprite requires typesprite.config.mjs

Learn more about the Sprite Sheet generation: FIX: LINK!

Load a SpriteSheet:

export class MyComponent extends Component {

  @res('sheet', 'assets/gui.sheet.json)
  private guiSheet:SpriteSheeet;

  onInit() {
      const logoFrame = this.guiSheet.slices["logo"];
  }
}

Hierarchy

SpriteSheet

Index

Constructors

`Private` constructor

new SpriteSheet(animations: Record<string, SpriteSheetAnimation>, slices: Record<string, SpriteSheetFrame>, ninePatches: Record<string, SpriteSheetNinePatch>, fonts: Record<string, SpriteSheetFont>, frames: SpriteSheetFrame[]): SpriteSheet
Use SpriteSheetLoader or if needed: SpriteSheet.createFromXXX() methods.
Parameters
- animations: Record<string, SpriteSheetAnimation>
- slices: Record<string, SpriteSheetFrame>
- ninePatches: Record<string, SpriteSheetNinePatch>
- fonts: Record<string, SpriteSheetFont>
- frames: SpriteSheetFrame[]
Returns SpriteSheet
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:48

Properties

`Readonly` animations

animations: Record<string, SpriteSheetAnimation>

`Readonly` fonts

fonts: Record<string, SpriteSheetFont>

`Readonly` frames

frames: SpriteSheetFrame[]

`Readonly` ninePatches

ninePatches: Record<string, SpriteSheetNinePatch>

`Readonly` slices

slices: Record<string, SpriteSheetFrame>

Methods

getAnimation

getAnimation(name: string): SpriteSheetAnimation
Deprecated
use animations directly instead.
Parameters
- name: string
Returns SpriteSheetAnimation
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:102

getAnimationFrame

getAnimationFrame(animation: string, frameIndex?: number): SpriteSheetFrame
Returns the requested frame of the given animation. For legacy support this will also search slices if the frameIndex is 0

Deprecated
use slices or animations
Parameters
- animation: string
- frameIndex: number = 0
Returns SpriteSheetFrame
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:71

getAnimationNumFrames

getAnimationNumFrames(animation: string): number
Parameters
- animation: string
Returns number
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:58

getAnimations

getAnimations(): Record<string, SpriteSheetAnimation>
Deprecated
use animations directly instead.

Returns Record<string, SpriteSheetAnimation>
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:109

getFrame

getFrame(frameIndex: number): SpriteSheetFrame
Deprecated
use frames instead.
Parameters
- frameIndex: number
Returns SpriteSheetFrame
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:86

getNumFrames

getNumFrames(animation: string): number
Deprecated
use getAnimationNumFrames() instead.
Parameters
- animation: string
Returns number
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:95

`Static` createFromModel

createFromModel(textures: ManagedTexture[], model: SpriteSheetModel): SpriteSheet
New to TypeSprite?:

If you're not an advaned user you very likely don't want this.

Try this instead:
```
export class MyComponent extends Component {

  @res('sheet', 'path/to/my.sheet.json)
  private sheet:SpriteSheeet;

  // use this.sheet
}
```
For advanced devs:

Create an instance from SpriteSheetModel
Parameters
- textures: ManagedTexture[]
- model: SpriteSheetModel
Returns SpriteSheet
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/engine/tt2d/SpriteSheet.ts:133

Class SpriteSheet

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

animations: Record<string, SpriteSheetAnimation>

slices: Record<string, SpriteSheetFrame>

ninePatches: Record<string, SpriteSheetNinePatch>

fonts: Record<string, SpriteSheetFont>

frames: SpriteSheetFrame[]

Returns SpriteSheet

Properties

Readonly animations

Readonly fonts

Readonly frames

Readonly ninePatches

Readonly slices

Methods

getAnimation

Deprecated

Parameters

name: string

Returns SpriteSheetAnimation

getAnimationFrame

Deprecated

Parameters

animation: string

frameIndex: number = 0

Returns SpriteSheetFrame

getAnimationNumFrames

Parameters

animation: string

Returns number

getAnimations

Deprecated

Returns Record<string, SpriteSheetAnimation>

getFrame

Deprecated

Parameters

frameIndex: number

Returns SpriteSheetFrame

getNumFrames

Deprecated

Parameters

animation: string

Returns number

Static createFromModel

Parameters

textures: ManagedTexture[]

model: SpriteSheetModel

Returns SpriteSheet

Settings

Member Visibility

Theme

`Private` constructor

`Readonly` animations

`Readonly` fonts

`Readonly` frames

`Readonly` ninePatches

`Readonly` slices

`Static` createFromModel