Class default<T>

An action argument which is an entry from the given key in an object Performs validation when an object is passed

Type Parameters

  • T extends Record<string, any>

Hierarchy

Constructors

constructor

Properties

bufferSize byteArray byteOffset connection dataView registrarId

Accessors

constructorFunction

Methods

getIndexSize getRegistrarId getType read readBool readContainer readCorpse readCreature readDoodad readEntity readFloat32 readFloat64 readFrom readHuman readIndexedBool readIndexedCorpse readIndexedCreature readIndexedDoodad readIndexedEntity readIndexedFloat64 readIndexedHuman readIndexedInt8 readIndexedItem readIndexedItems readIndexedMovementIntent readIndexedNPC readIndexedObject readIndexedPlayer readIndexedString readIndexedStringArray readIndexedTileEvent readIndexedUint16 readIndexedUint16Array readIndexedUint32 readIndexedUint32NumberArray readIndexedUint8 readIndexedUint8Array readIndexedVector2 readIndexedVector2Array readIndexedVector3 readInt16 readInt32 readInt8 readIsland readItem readItems readMovementIntent readNPC readObject readOptionalBool readOptionalDoodad readOptionalInt16 readOptionalItem readOptionalItems readOptionalString readOptionalTile readOptionalUint8 readOptionalVector3 readPlayer readString readStringArray readTile readTileArray readTileEvent readTruthiness readUint16 readUint16Array readUint32 readUint32NumberArray readUint8 readUint8Array readVector2 readVector2Array readVector3 resetIndexes validate validateObject write writeBool writeContainer writeCorpse writeCreature writeDoodad writeEntity writeFloat32 writeFloat64 writeHuman writeIndexedBool writeIndexedCorpse writeIndexedCreature writeIndexedDoodad writeIndexedEntity writeIndexedFloat64 writeIndexedHuman writeIndexedInt8 writeIndexedItem writeIndexedItems writeIndexedMovementIntent writeIndexedNPC writeIndexedObject writeIndexedPlayer writeIndexedString writeIndexedStringArray writeIndexedTileEvent writeIndexedUint16 writeIndexedUint16Array writeIndexedUint32 writeIndexedUint32NumberArray writeIndexedUint8 writeIndexedUint8Array writeIndexedVector2 writeIndexedVector2Array writeIndexedVector3 writeInt16 writeInt32 writeInt8 writeIsland writeItem writeItems writeMovementIntent writeNPC writeObject writeOptionalBool writeOptionalDoodad writeOptionalInt16 writeOptionalItem writeOptionalItems writeOptionalString writeOptionalTile writeOptionalUint8 writeOptionalVector3 writePlayer writeString writeStringArray writeTile writeTileArray writeTileEvent writeTo writeTruthiness writeUint16 writeUint16Array writeUint32 writeUint32NumberArray writeUint8 writeUint8Array writeVector2 writeVector2Array writeVector3 applyHelperToActionArgument getRegistrarId setRegistrarId

Constructors

constructor

  • Type Parameters

    • T extends Record<string, any>

    Parameters

    • Optional object: T

    Returns default<T>

Properties

Protected bufferSize

bufferSize: number

Protected byteArray

byteArray: Uint8Array

Protected byteOffset

byteOffset: number

Protected connection

connection: IConnection

Protected dataView

dataView: DataView

Static Protected registrarId

registrarId: number

Accessors

constructorFunction

  • get constructorFunction(): typeof default

  • Returns typeof default

Methods

Protected getIndexSize

  • Returns number

getRegistrarId

getType

read

  • Returns keyof T

Protected readBool

Protected readContainer

Protected readCorpse

Protected readCreature

Protected readDoodad

Protected readEntity

Protected readFloat32

Protected readFloat64

readFrom

Protected readHuman

Protected readIndexedBool

  • Returns undefined | boolean

Protected readIndexedCorpse

Protected readIndexedCreature

Protected readIndexedDoodad

Protected readIndexedEntity

Protected readIndexedFloat64

Protected readIndexedHuman

Protected readIndexedInt8

  • Returns undefined | number

Protected readIndexedItem

Protected readIndexedItems

Protected readIndexedMovementIntent

Protected readIndexedNPC

Protected readIndexedObject

Protected readIndexedPlayer

Protected readIndexedString

Protected readIndexedStringArray

Protected readIndexedTileEvent

Protected readIndexedUint16

Protected readIndexedUint16Array

Protected readIndexedUint32

Protected readIndexedUint32NumberArray

Protected readIndexedUint8

Protected readIndexedUint8Array

Protected readIndexedVector2

Protected readIndexedVector2Array

Protected readIndexedVector3

Protected readInt16

Protected readInt32

Protected readInt8

Protected readIsland

Protected readItem

Protected readItems

Protected readMovementIntent

Protected readNPC

Protected readObject

Protected readOptionalBool

Protected readOptionalDoodad

Protected readOptionalInt16

Protected readOptionalItem

Protected readOptionalItems

Protected readOptionalString

Protected readOptionalTile

Protected readOptionalUint8

Protected readOptionalVector3

Protected readPlayer

Protected readString

Protected readStringArray

Protected readTile

Protected readTileArray

Protected readTileEvent

Protected readTruthiness

Protected readUint16

Protected readUint16Array

Protected readUint32

Protected readUint32NumberArray

Protected readUint8

Protected readUint8Array

Protected readVector2

Protected readVector2Array

Protected readVector3

Protected resetIndexes

  • Parameters

    • write: boolean

    Returns void

validate

validateObject

  • Parameters

    • value: unknown

    Returns value is keyof T extends object ? Partial<object & keyof T> : never

write

Protected writeBool

  • Parameters

    • value: boolean

    Returns boolean

Protected writeContainer

Protected writeCorpse

Protected writeCreature

Protected writeDoodad

Protected writeEntity

Protected writeFloat32

  • Parameters

    • value: number

    Returns void

Protected writeFloat64

  • Parameters

    • value: number

    Returns void

Protected writeHuman

Protected writeIndexedBool

  • Parameters

    • Optional value: boolean

    Returns void

Protected writeIndexedCorpse

Protected writeIndexedCreature

Protected writeIndexedDoodad

Protected writeIndexedEntity

Protected writeIndexedFloat64

  • Parameters

    • Optional value: number

    Returns void

Protected writeIndexedHuman

Protected writeIndexedInt8

  • Parameters

    • Optional value: number

    Returns void

Protected writeIndexedItem

Protected writeIndexedItems

Protected writeIndexedMovementIntent

Protected writeIndexedNPC

Protected writeIndexedObject

  • Parameters

    • Optional value: unknown

    Returns void

Protected writeIndexedPlayer

Protected writeIndexedString

  • Parameters

    • Optional value: string

    Returns void

Protected writeIndexedStringArray

  • Parameters

    • Optional value: string[]

    Returns void

Protected writeIndexedTileEvent

Protected writeIndexedUint16

  • Parameters

    • Optional value: number

    Returns void

Protected writeIndexedUint16Array

  • Parameters

    • Optional value: Uint16Array

    Returns void

Protected writeIndexedUint32

  • Parameters

    • Optional value: number

    Returns void

Protected writeIndexedUint32NumberArray

Protected writeIndexedUint8

  • Parameters

    • Optional value: number

    Returns void

Protected writeIndexedUint8Array

  • Parameters

    • Optional value: Uint8Array

    Returns void

Protected writeIndexedVector2

Protected writeIndexedVector2Array

Protected writeIndexedVector3

Protected writeInt16

  • Parameters

    • value: number

    Returns void

Protected writeInt32

  • Parameters

    • value: number

    Returns void

Protected writeInt8

  • Parameters

    • value: number

    Returns void

Protected writeIsland

Protected writeItem

Protected writeItems

Protected writeMovementIntent

Protected writeNPC

Protected writeObject

  • Parameters

    • value: unknown

    Returns void

Protected writeOptionalBool

  • Parameters

    • Optional value: boolean

    Returns void

Protected writeOptionalDoodad

Protected writeOptionalInt16

  • Parameters

    • Optional value: number

    Returns void

Protected writeOptionalItem

Protected writeOptionalItems

Protected writeOptionalString

  • Parameters

    • Optional value: string

    Returns void

Protected writeOptionalTile

Protected writeOptionalUint8

  • Parameters

    • Optional value: number

    Returns void

Protected writeOptionalVector3

Protected writePlayer

Protected writeString

  • Parameters

    • value: string

    Returns void

Protected writeStringArray

  • Parameters

    • value: string[]

    Returns void

Protected writeTile

Protected writeTileArray

Protected writeTileEvent

writeTo

  • Parameters

    Returns void

Protected writeTruthiness

  • Writes & returns a boolean of whether the given value is truthy

    Type Parameters

    • T

    Parameters

    • Optional value: T

    Returns value is Exclude<T, undefined | null | false | "" | 0>

Protected writeUint16

  • Parameters

    • value: number

    Returns void

Protected writeUint16Array

  • Parameters

    • value: Uint16Array

    Returns void

Protected writeUint32

  • Parameters

    • value: number

    Returns void

Protected writeUint32NumberArray

Protected writeUint8

  • Parameters

    • value: number

    Returns void

Protected writeUint8Array

  • Parameters

    • value: Uint8Array

    Returns void

Protected writeVector2

Protected writeVector2Array

Protected writeVector3

Static applyHelperToActionArgument

  • Returns void

Static getRegistrarId

Static setRegistrarId

  • Parameters

    • id: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc