Class SpriteData

Used by the SpriteRenderer to hold the sprite sheet and the currently active sprite index.

Index

Constructors

Properties

index spriteSheet?

Accessors

Methods

clone update create

Constructors

constructor

new SpriteData(): SpriteData
Returns SpriteData

Properties

index

index: number = 0

The index of the sprite to be rendered in the currently assigned sprite sheet

`Optional`spriteSheet

spriteSheet?: SpriteSheet

The spritesheet holds all sprites that can be rendered by the sprite renderer

Accessors

sprite

get sprite(): undefined | Sprite
The currently active sprite

Returns undefined | Sprite
set sprite(sprite: undefined | Sprite): void
Set the sprite to be rendered in the currently assigned sprite sheet at the currently active index index
Parameters
- sprite: undefined | Sprite
Returns void

Methods

clone

clone(): SpriteData
Returns SpriteData

update

update(material: undefined | Material): void
Parameters
- material: undefined | Material
Returns void

`Static`create

create(): SpriteData
Returns SpriteData