Class Sprites

Container for the sprites defined in the ic0_9.wlf and masks.wlf files.

Implements

Iterable<Sprite>

Index

Methods

[iterator] getSprite getSpriteCount fromArrays fromBlobs

Methods

[iterator]

"[iterator]"(): Generator<Sprite>
Returns Generator<Sprite>
Yields
The sprites.
Implementation of Iterable.[iterator]
- Defined in sprite/Sprites.ts:27

getSprite

getSprite(index: number): Sprite
Returns the sprite image with the given index.
Parameters
- index: number
  The index of the sprite.
Returns Sprite
The sprite image.

Throws
RangeError if the index is out of bounds.
- Defined in sprite/Sprites.ts:38

getSpriteCount

getSpriteCount(): number
Returns number
The number of sprites.
- Defined in sprite/Sprites.ts:48

`Static`fromArrays

fromArrays(imageArray: Uint8Array, maskArray: Uint8Array): Sprites
Parses sprites from the given arrays and returns it.
Parameters
- imageArray: Uint8Array
  The image data array with the IC0_9.wlf file content to parse.
- maskArray: Uint8Array
  The transparency mask array with the MASKS.WLF file content to parse.
Returns Sprites
The parsed sprites.
- Defined in sprite/Sprites.ts:59

`Static`fromBlobs

fromBlobs(imagesBlob: Blob, masksBlob: Blob): Promise<Sprites>
Reads sprites from the given blobs and returns it.
Parameters
- imagesBlob: Blob
  The IC0_9.WLF blob to read.
- masksBlob: Blob
  The MASKS.WLF blob to read.
Returns Promise<Sprites>
The read sprites.
- Defined in sprite/Sprites.ts:79