Class ObservableUIRawMessage`Preview`

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

Index

Constructors

Methods

getData setData subscribe unsubscribe

Constructors

constructor

new ObservableUIRawMessage(
data: UIRawMessage,
options?: ObservableOptions,
): ObservableUIRawMessage
World mutation Early execution
Parameters
- data: UIRawMessage
  The initial UIRawMessage value for this observable.
- Optionaloptions: ObservableOptions
  Optional configuration for the observable, such as whether the value can be written by the client.
Returns ObservableUIRawMessage
Remarks
Creates a new ObservableUIRawMessage with the provided initial UIRawMessage value.
- Defined in @minecraft/server-ui.d.ts:1164

Methods

getData

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

setData

setData(data: UIRawMessage): void
World mutation Early execution
Parameters
- data: UIRawMessage
  The new UIRawMessage value to set.
Returns void
Remarks
Updates the UIRawMessage 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:1189

subscribe(callback: (arg0: UIRawMessage) => void): (arg0: UIRawMessage) => void
World mutation Early execution
Parameters
- callback: (arg0: UIRawMessage) => void
  A function that receives the new UIRawMessage value each time the observable changes.
Returns (arg0: UIRawMessage) => 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:1204

unsubscribe

unsubscribe(callback: (arg0: UIRawMessage) => void): boolean
World mutation Early execution
Parameters
- callback: (arg0: UIRawMessage) => 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:1218