Class BatchedPropertyPacket<T>

constructor

• new BatchedPropertyPacket<T>(
      id: string,
      batchIntervalMs: number,
      initialValue?: T,
      isUnreliable?: boolean,
      meta?: Many<["tuple", [value: SerializerMetadata<T>], undefined]>,
  ): BatchedPropertyPacket<T>

  Type Parameters

  • T

  Parameters

  • id: string
  • batchIntervalMs: number
  • OptionalinitialValue: T
  • OptionalisUnreliable: boolean
  • Optionalmeta: Many<["tuple", [value: SerializerMetadata<T>], undefined]>

  Returns BatchedPropertyPacket<T>

ReadonlybatchIntervalMs

changed

ReadonlyclassName

OptionalperPlayer

ReadonlysignalPacket

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

clearFor

• clearFor(player: Player): void

  Clears the value of the property for a specific player. Should only be used on the server.

  Parameters

  • player: Player

    The player to clear the value for

  Returns void

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

destroy

• destroy(): void

  Cleans up any resources used by the packet.

  Returns void

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

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.

observe

• observe(handler: (value: T) => void): Connection

  Observes the property for changes. Triggers the handler after each flush.

  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

set

• set(value: T): void

  Sets the value of the property. This will clear the perPlayer map and broadcast the value to all players after the batch interval. Should only be used on the server.

  Parameters

  • value: T

    The new value of the property

  Returns void

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

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

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

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

StaticsetPlayersProvider

• setPlayersProvider(provider?: () => Player[]): void

  Overrides the provider used to retrieve players when broadcasting filtered updates. Primarily intended for testing. Passing no provider resets to the default behavior.

  Parameters

  • Optionalprovider: () => Player[]

  Returns void