Class EndingUpdate

A single ending animation update.

Hierarchy

EndingUpdate

Index

Methods

Methods

getDelay

getDelay(): number

- Defined in ending/EndingUpdate.ts:36
Returns the delay to wait before applying this update. The unit is unknown but good results can be achieved by multiplying this value with 50 to get a millisecond value.

Returns number

The delay in time units.

getNumPatches

getNumPatches(): number

- Defined in ending/EndingUpdate.ts:67
Returns the number of update patches.

Returns number

The number of update patches.

getPatch

getPatch(index: number): EndingPatch

- Defined in ending/EndingUpdate.ts:55
Returns the update patch with the given index.

Parameters
- index: number
  
  Update patch index.
Returns EndingPatch

The animation patch.

getPatches

getPatches(): EndingPatch[]

- Defined in ending/EndingUpdate.ts:45
Returns the set of update patches.

Returns EndingPatch[]

The set of update patches.

Static read

read(reader: BinaryReader): EndingUpdate | null

- Defined in ending/EndingUpdate.ts:78
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 frame from.
Returns EndingUpdate | null

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

Generated using TypeDoc