Class Packet<T>Abstract

Type Parameters

  • T = void

Hierarchy

Implements

Constructors

constructor

Properties

bufferSize byteArray byteOffset connection dataView synchronizationCheckData registrarId

Accessors

constructorFunction

Methods

getAllowedStates getArrayBuffer getDebugInfo getIndexSize getInitialBufferSize getRegistrarId getSynchronizationCheckData getType isAllowedWhenPaused isSyncCheckEnabled preProcess preReadData preWriteData process processAndSend processSerializedData readBool readContainer readCorpse readCreature readData readDoodad readEntity readFloat32 readFloat64 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 send sendTo serializeData writeBool writeContainer writeCorpse writeCreature writeData 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 writeTruthiness writeUint16 writeUint16Array writeUint32 writeUint32NumberArray writeUint8 writeUint8Array writeVector2 writeVector2Array writeVector3 getRegistrarId setRegistrarId

Constructors

constructor

Properties

Protected bufferSize

bufferSize: number

Protected byteArray

byteArray: Uint8Array

Protected byteOffset

byteOffset: number

Protected connection

connection: IConnection

Protected dataView

dataView: DataView

Protected synchronizationCheckData

synchronizationCheckData: ISynchronizationCheckData = {}

Static Protected registrarId

registrarId: number

Accessors

constructorFunction

  • get constructorFunction(): typeof default

  • Returns typeof default

Methods

getAllowedStates

getArrayBuffer

  • Parameters

    • Optional id: number

    Returns ArrayBuffer

Abstract getDebugInfo

  • Returns string

Protected getIndexSize

  • Returns number

Protected getInitialBufferSize

  • Returns number

getRegistrarId

getSynchronizationCheckData

Abstract getType

isAllowedWhenPaused

  • Returns boolean

isSyncCheckEnabled

  • Returns boolean

Protected preProcess

  • Returns void

Protected preReadData

  • Returns void

Protected preWriteData

  • Returns void

Abstract process

  • Returns T

processAndSend

  • Parameters

    Returns undefined | T

processSerializedData

  • Parameters

    • dataView: DataView

    Returns void

Protected readBool

  • Returns boolean

Protected readContainer

Protected readCorpse

Protected readCreature

Protected readData

  • Returns void

Protected readDoodad

Protected readEntity

Protected readFloat32

  • Returns number

Protected readFloat64

  • Returns number

Protected readHuman

Protected readIndexedBool

  • Returns undefined | boolean

Protected readIndexedCorpse

Protected readIndexedCreature

Protected readIndexedDoodad

Protected readIndexedEntity

Protected readIndexedFloat64

  • Returns undefined | number

Protected readIndexedHuman

Protected readIndexedInt8

  • Returns undefined | number

Protected readIndexedItem

Protected readIndexedItems

Protected readIndexedMovementIntent

Protected readIndexedNPC

Protected readIndexedObject

  • Returns unknown

Protected readIndexedPlayer

Protected readIndexedString

  • Returns undefined | string

Protected readIndexedStringArray

  • Returns undefined | string[]

Protected readIndexedTileEvent

Protected readIndexedUint16

  • Returns undefined | number

Protected readIndexedUint16Array

  • Returns undefined | Uint16Array

Protected readIndexedUint32

  • Returns undefined | number

Protected readIndexedUint32NumberArray

  • Returns undefined | number[]

Protected readIndexedUint8

  • Returns undefined | number

Protected readIndexedUint8Array

  • Returns undefined | Uint8Array

Protected readIndexedVector2

Protected readIndexedVector2Array

Protected readIndexedVector3

Protected readInt16

  • Returns number

Protected readInt32

  • Returns number

Protected readInt8

  • Returns number

Protected readIsland

Protected readItem

Protected readItems

Protected readMovementIntent

Protected readNPC

  • Returns undefined | default

Protected readObject

  • Returns unknown

Protected readOptionalBool

  • Returns undefined | boolean

Protected readOptionalDoodad

Protected readOptionalInt16

  • Returns undefined | number

Protected readOptionalItem

Protected readOptionalItems

Protected readOptionalString

  • Returns undefined | string

Protected readOptionalTile

Protected readOptionalUint8

  • Returns undefined | number

Protected readOptionalVector3

Protected readPlayer

Protected readString

  • Returns string

Protected readStringArray

  • Returns string[]

Protected readTile

Protected readTileArray

Protected readTileEvent

Protected readTruthiness

  • Returns undefined | true

Protected readUint16

  • Returns number

Protected readUint16Array

  • Returns Uint16Array

Protected readUint32

  • Returns number

Protected readUint32NumberArray

  • Returns number[]

Protected readUint8

  • Returns number

Protected readUint8Array

  • Returns Uint8Array

Protected readVector2

Protected readVector2Array

Protected readVector3

Protected resetIndexes

  • Parameters

    • write: boolean

    Returns void

send

  • Parameters

    Returns void

sendTo

  • Parameters

    Returns void

serializeData

  • Returns number

Protected writeBool

  • Parameters

    • value: boolean

    Returns boolean

Protected writeContainer

Protected writeCorpse

  • Parameters

    Returns void

Protected writeCreature

  • Parameters

    Returns void

Protected writeData

  • Returns void

Protected writeDoodad

  • Parameters

    Returns void

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

  • Parameters

    Returns void

Protected writeIndexedItems

  • Parameters

    Returns void

Protected writeIndexedMovementIntent

Protected writeIndexedNPC

  • Parameters

    Returns void

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

  • Parameters

    • Optional value: number[]

    Returns void

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

  • Parameters

    Returns void

Protected writeItem

  • Parameters

    Returns void

Protected writeItems

  • Parameters

    Returns void

Protected writeMovementIntent

Protected writeNPC

  • Parameters

    Returns void

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

  • Parameters

    Returns void

Protected writeOptionalString

  • Parameters

    • Optional value: string

    Returns void

Protected writeOptionalTile

Protected writeOptionalUint8

  • Parameters

    • Optional value: number

    Returns void

Protected writeOptionalVector3

Protected writePlayer

  • Parameters

    Returns void

Protected writeString

  • Parameters

    • value: string

    Returns void

Protected writeStringArray

  • Parameters

    • value: string[]

    Returns void

Protected writeTile

  • Parameters

    Returns void

Protected writeTileArray

  • Parameters

    Returns void

Protected writeTileEvent

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

  • Parameters

    • value: number[]

    Returns void

Protected writeUint8

  • Parameters

    • value: number

    Returns void

Protected writeUint8Array

  • Parameters

    • value: Uint8Array

    Returns void

Protected writeVector2

Protected writeVector2Array

Protected writeVector3

Static getRegistrarId

  • Returns number

Static setRegistrarId

  • Parameters

    • id: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc