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

    Class ObservableNumberBeta

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

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

    Constructors

    constructor

    Methods

    getData setData subscribe unsubscribe

    Constructors

    • Parameters

      • data: number

        The initial numeric value for this observable.

      • Optionaloptions: ObservableOptions

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

      Returns ObservableNumber

      Creates a new ObservableNumber with the provided initial numeric value.

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

      This function can be called in early-execution mode.

    Methods

    • Returns number

      Returns the current numeric 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: number

        The new numeric value to set.

      Returns void

      Updates the numeric 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: number) => void

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

      Returns (arg0: number) => 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: number) => 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