@minecraft/server-ui
    Preparing search index...

    Class ObservableString

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

    Index

    Constructors

    constructor

    Methods

    getData getFilteredText setData subscribe unsubscribe

    Constructors

    • Parameters

      • data: string

        The initial string value for this observable.

      • Optionaloptions: ObservableOptions

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

      Returns ObservableString

      Creates a new ObservableString with the provided initial string value.

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

      This function can be called in early-execution mode.

    Methods

    • Returns string

      Returns the current string 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

      • player: Player

      Returns Promise<string | TextFilteringError[]>

      Gets filtered data from the Observable (only available for strings). In case of failure, it will return an array of TextFilteringError that can provide more context about the filtering process. For testing purposes, the options are available under 'Creator -> Text Filtering' settings menu. This delay is only applied to the getFilteredText function and can be used to simulate network latency when testing.

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

      This function can throw errors.

      minecraftcommon.EngineError

      minecraftserver.InvalidEntityError

    • Parameters

      • data: string

        The new string value to set.

      Returns void

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

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

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