Script API - v1.26.30.28
    Preparing search index...

    Class ObservableBooleanBeta

    An observable that holds a boolean value. Listeners are notified whenever the value changes.

    export class ObservableBoolean {
        constructor(data: boolean, options?: ObservableOptions);
        getData(): boolean;
        setData(data: boolean): void;
        subscribe(callback: (arg0: boolean) => void): (arg0: boolean) => void;
        unsubscribe(callback: (arg0: boolean) => void): boolean;
    }
    Index

    Constructors

    constructor

    Methods

    getData setData subscribe unsubscribe

    Constructors

    • Parameters

      • data: boolean

        The initial boolean value for this observable.

      • Optionaloptions: ObservableOptions

        Optional configuration for the observable, such as whether the value can be written by the client.

      Returns ObservableBoolean

      Creates a new ObservableBoolean with the provided initial boolean value.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    Methods

    • Returns boolean

      Returns the current boolean value held by this observable.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    • Parameters

      • data: boolean

        The new boolean value to set.

      Returns void

      Updates the boolean value held by this observable. If the new value differs from the current value, all subscribed listeners are notified with the new value.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    • Parameters

      • callback: (arg0: boolean) => void

        A function that receives the new boolean value each time the observable changes.

      Returns (arg0: boolean) => void

      Registers a callback to be invoked whenever the observable's value changes. Returns the callback, which can be passed to unsubscribe to remove the listener.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    • Parameters

      • callback: (arg0: boolean) => void

        The callback handle previously returned by subscribe.

      Returns boolean

      Removes a previously registered listener from this observable. Returns true if the listener was found and removed, false if it was not found.

      This function can't be called in restricted-execution mode.

      This function can be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods