Class PropertyPacket<T>

PropertyPacket is a wrapper around SignalPacket that provides a type-safe way to send data between server and client. This implements a property system where the value can be set for all players, a specific player, or a filtered list of players.

Type Parameters

T
The type of the property

Hierarchy (View Summary)

AbstractPropertyPacket<T>
- PropertyPacket

Index

Constructors

constructor

new PropertyPacket<T>(
    id: string,
    initialValue?: T,
    isUnreliable?: boolean,
    meta?: Many<["tuple", [value: SerializerMetadata<T>], undefined]>,
): PropertyPacket<T>
Creates a new PropertyPacket.
Type Parameters
- T
Parameters
- id: string
  The id of the property
- OptionalinitialValue: T
  The initial value of the property
- OptionalisUnreliable: boolean
  Whether the property should be sent unreliably. Default is false.
- Optionalmeta: Many<["tuple", [value: SerializerMetadata<T>], undefined]>
  Metadata for the serializer
Returns PropertyPacket<T>
Overrides AbstractPropertyPacket.constructor
- Defined in PropertyPacket.ts:51

Properties

changed

changed: Signal<(value: T) => void>

Signal that fires when the property changes. Should only be used on the client since the server does not listen for changes.

`Readonly`className

className: "PropertyPacket"

Class name of the packet, used for debugging purposes.

`Optional`perPlayer

perPlayer?: Map<Player, undefined | T>

Map of player to their property value

signalPacket

signalPacket: SignalPacket<(value: T) => void>

SignalPacket used to send the property

Methods

clearFilter

clearFilter(predicate: (player: Player) => boolean): void
Clears the value of the property for players that pass the predicate. Should only be used on the server.
Parameters
- predicate: (player: Player) => boolean
  The predicate to filter players
Returns void
Inherited from AbstractPropertyPacket.clearFilter
- Defined in AbstractPropertyPacket.ts:73

clearFor

clearFor(player: Player): void
Clears the value of the property. This will clear the perPlayer map and fire the signal to all players. Should only be used on the server.
Parameters
- player: Player
Returns void
Overrides AbstractPropertyPacket.clearFor
- Defined in PropertyPacket.ts:159

clearForList

clearForList(players: Player[]): void
Clears the value of the property for a list of players. Should only be used on the server.
Parameters
- players: Player[]
  The list of players to clear the value for
Returns void
Inherited from AbstractPropertyPacket.clearForList
- Defined in AbstractPropertyPacket.ts:61

destroy

destroy(): void
Cleans up any resources used by the packet.

Returns void
Overrides AbstractPropertyPacket.destroy
- Defined in PropertyPacket.ts:205

get

get(player?: Player): T
Returns the current value of the property.
Parameters
- Optionalplayer: Player
  The player to get the value for. Does nothing on the client.
Returns T
The current value of the property
Overrides AbstractPropertyPacket.get
- Defined in PropertyPacket.ts:170

getFor

getFor(player: Player): T
Returns the value of the property for a specific player. Should only be used on the server.
Parameters
- player: Player
  The player to get the value for
Returns T
The value of the property for the player

Deprecated
Use get instead.
Inherited from AbstractPropertyPacket.getFor
- Defined in AbstractPropertyPacket.ts:95

observe

observe(handler: (value: T) => void): Connection
Observes the property for changes. Unlike changed, this will fire the handler immediately if the value is already set. Else, it will wait for the value to be set and then fire the handler.
Parameters
- handler: (value: T) => void
  The handler to call when the property changes
Returns Connection
A connection that can be disconnected to stop observing the property
Overrides AbstractPropertyPacket.observe
- Defined in PropertyPacket.ts:195

set

set(value: T): void
Sets the value of the property. This will clear the perPlayer map and fire the signal to all players. Should only be used on the server.
Parameters
- value: T
  The new value of the property
Returns void
Overrides AbstractPropertyPacket.set
- Defined in PropertyPacket.ts:114

setFilter

setFilter(predicate: (player: Player) => boolean, value: T): void
Sets the value of the property for players that pass the predicate. Should only be used on the server.
Parameters
- predicate: (player: Player) => boolean
  The predicate to filter players
- value: T
  The new value of the property
Returns void
Inherited from AbstractPropertyPacket.setFilter
- Defined in AbstractPropertyPacket.ts:20

setFor

setFor(player: Player, value: T): void
Sets the value of the property for a specific player. Should only be used on the server.
Parameters
- player: Player
  The player to set the value for
- value: T
  The new value of the property
Returns void
Overrides AbstractPropertyPacket.setFor
- Defined in PropertyPacket.ts:146

setForList

setForList(players: Player[], value: T): void
Sets the value of the property for a list of players. Should only be used on the server.
Parameters
- players: Player[]
  The list of players to set the value for
- value: T
  The new value of the property
Returns void
Inherited from AbstractPropertyPacket.setForList
- Defined in AbstractPropertyPacket.ts:42

setTop

setTop(value: T): void
Sets the value of the property for players that do not have a value set. Should only be used on the server.
Parameters
- value: T
  The new value of the property
Returns void
- Defined in PropertyPacket.ts:128

Class PropertyPacket<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PropertyPacket<T>

Properties

changed

ReadonlyclassName

OptionalperPlayer

signalPacket

Methods

clearFilter

Parameters

Returns void

clearFor

Parameters

Returns void

clearForList

Parameters

Returns void

destroy

Returns void

get

Parameters

Returns T

getFor

Parameters

Returns T

Deprecated

observe

Parameters

Returns Connection

set

Parameters

Returns void

setFilter

Parameters

Returns void

setFor

Parameters

Returns void

setForList

Parameters

Returns void

setTop

Parameters

Returns void

Settings

On This Page

`Readonly`className

`Optional`perPlayer