Class ExactSetPropertyPacket<T>

constructor

• new ExactSetPropertyPacket<T>(
      id: string,
      initialValues?: ReadonlySet<T>,
      isUnreliable?: boolean,
      meta?: Many<
          [
              "tuple",
              [
                  payload: [
                      "object_raw",
                      (
                          | ["full", ["boolean"]]
                          | [
                              "changes",
                              [
                                  "array",
                                  ((...) extends (...) ? (...) : (...)) extends true
                                      ? [(...), (...), (...), (...)]
                                      : [(...), (...)],
                              ],
                          ]
                      )[],
                  ],
              ],
              undefined,
          ],
      >,
  ): ExactSetPropertyPacket<T>

  Type Parameters

  • T

  Parameters

  • id: string
  • OptionalinitialValues: ReadonlySet<T>
  • OptionalisUnreliable: boolean
  • Optionalmeta: Many<
        [
            "tuple",
            [
                payload: [
                    "object_raw",
                    (
                        | ["full", ["boolean"]]
                        | [
                            "changes",
                            [
                                "array",
                                ((...) extends (...) ? (...) : (...)) extends true
                                    ? [(...), (...), (...), (...)]
                                    : [(...), (...)],
                            ],
                        ]
                    )[],
                ],
            ],
            undefined,
        ],
    >

  Returns ExactSetPropertyPacket<T>

ReadonlyclassName

ReadonlysignalPacket

add

• add(value: T): boolean

  Parameters

  • value: T

  Returns boolean

clear

• clear(): void

  Returns void

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

delete

• delete(value: T): boolean

  Parameters

  • value: T

  Returns boolean

destroy

• destroy(): void

  Cleans up any resources used by the packet.

  Returns void

get

• get(player?: Player): Set<T>

  Returns the current value of the property.

  Parameters

  • Optionalplayer: Player

    The player to get the value for. Does nothing on the client.

  Returns Set<T>

  The current value of the property

getSnapshot

• getSnapshot(): Set<T>

  Returns Set<T>

observe

• observe(handler: (snapshot: Set<T>, diff: DiffPayload<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: (snapshot: Set<T>, diff: DiffPayload<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(values: Set<T>): void

  Sets the value of the property for all players. Should only be used on the server.

  Parameters

  • values: Set<T>

  Returns void

setFor

• setFor(player: Player, value: Set<T>): void

  Sets the value of the property for a specific player.

  Parameters

  • player: Player

    The player to set the value for
  • value: Set<T>

    The new value of the property

  Returns void