@rbxts/fletchette
    Preparing search index...

    Class AbstractPropertyPacket<T>Abstract

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    className

    Methods

    clearFilter clearFor clearForList destroy get getFor observe set setFilter setFor setForList

    Constructors

    Properties

    className: string

    Class name of the packet, used for debugging purposes.

    Methods

    • 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

    • 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

    • 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

    • 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

    • 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

      Use get instead.

    • 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

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

      Parameters

      • value: T

        The new value of the property

      Returns 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

    • Sets the value of the property for a specific player.

      Parameters

      • player: Player

        The player to set the value for

      • value: T

        The new value of the property

      Returns 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods