Class PortraitUpdate

A single update in a portrait animation.

Hierarchy

PortraitUpdate

Index

Methods

Methods

getNumPatches

getNumPatches(): number

- Defined in portrait/PortraitUpdate.ts:52
Returns the number of patches.

Returns number

The number of patches.

getPatch

getPatch(index: number): PortraitPatch

- Defined in portrait/PortraitUpdate.ts:40
Returns the patch with the given index.

Parameters
- index: number
  
  The index of the patch to return.
Returns PortraitPatch

The patch.

getPatches

getPatches(): PortraitPatch[]

- Defined in portrait/PortraitUpdate.ts:30
Returns the patches to apply to the image.

Returns PortraitPatch[]

The patches to apply to the image.

Static read

read(reader: BinaryReader): PortraitUpdate

- Defined in portrait/PortraitUpdate.ts:63
Reads an animation update from the given reader. If the end of the animation has been reached then null is returned.

Parameters
- reader: BinaryReader
  
  The reader to read the animation update from.
Returns PortraitUpdate

The read animation update or null if end of animation has been reached.

Generated using TypeDoc