Class ObservableString`Beta`

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

Index

Constructors

Methods

getData getFilteredText setData subscribe unsubscribe

Constructors

constructor

new ObservableString(
data: string,
options?: ObservableOptions,
): ObservableString
World mutation Early execution
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
Remarks
Creates a new ObservableString with the provided initial string value.
- Defined in @minecraft/server-ui.d.ts:1033

Methods

getData

getData(): string
World mutation Early execution
Returns string
Remarks
Returns the current string value held by this observable.
- Defined in @minecraft/server-ui.d.ts:1043

getFilteredText

getFilteredText(player: Player): Promise<string | TextFilteringError[]>
World mutation
Parameters
- player: Player
Returns Promise<string | TextFilteringError[]>
Remarks
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.

Throws
This function can throw errors.

EngineError

InvalidEntityError
- Defined in @minecraft/server-ui.d.ts:1062

setData

setData(data: string): void
World mutation Early execution
Parameters
- data: string
  The new string value to set.
Returns void
Remarks
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.
- Defined in @minecraft/server-ui.d.ts:1076

subscribe(callback: (arg0: string) => void): (arg0: string) => void
World mutation Early execution
Parameters
- callback: (arg0: string) => void
  A function that receives the new string value each time the observable changes.
Returns (arg0: string) => void
Remarks
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.
- Defined in @minecraft/server-ui.d.ts:1091

unsubscribe

unsubscribe(callback: (arg0: string) => void): boolean
World mutation Early execution
Parameters
- callback: (arg0: string) => void
  The callback handle previously returned by subscribe.
Returns boolean
Remarks
Removes a previously registered listener from this observable. Returns true if the listener was found and removed, false if it was not found.
- Defined in @minecraft/server-ui.d.ts:1105