Class PortraitUpdate

A single update in a portrait animation.

Index

Methods

getNumPatches getPatch getPatches read

Methods

getNumPatches

getNumPatches(): number
Returns the number of patches.

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

getPatch

getPatch(index: number): PortraitPatch
Returns the patch with the given index.
Parameters
- index: number
  The index of the patch to return.
Returns PortraitPatch
The patch.
- Defined in portrait/PortraitUpdate.ts:40

getPatches

getPatches(): PortraitPatch[]
Returns the patches to apply to the image.

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

`Static`read

read(reader: BinaryReader): PortraitUpdate
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.
- Defined in portrait/PortraitUpdate.ts:63