@minecraft/server-ui / ObservableUIRawMessage
Class: ObservableUIRawMessage
Defined in: @minecraft/server-ui/index.d.ts:1426
An observable that holds a UIRawMessage value. Listeners are notified whenever the value changes.
Constructors
Constructor
new ObservableUIRawMessage(
data,options?):ObservableUIRawMessage
Defined in: @minecraft/server-ui/index.d.ts:1442
Parameters
data
The initial UIRawMessage value for this observable.
options?
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.
This function can't be called in restricted-execution mode.
This function can be called in early-execution mode.
Methods
getData()
getData():
UIRawMessage
Defined in: @minecraft/server-ui/index.d.ts:1453
Returns
Remarks
Returns the current UIRawMessage value held by this observable.
This function can't be called in restricted-execution mode.
This function can be called in early-execution mode.
setData()
setData(
data):void
Defined in: @minecraft/server-ui/index.d.ts:1467
Parameters
data
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.
This function can't be called in restricted-execution mode.
This function can be called in early-execution mode.
subscribe()
subscribe(
callback): (arg0) =>void
Defined in: @minecraft/server-ui/index.d.ts:1482
Parameters
callback
(arg0) => void
A function that receives the new UIRawMessage value each time the observable changes.
Returns
(arg0) => 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.
This function can't be called in restricted-execution mode.
This function can be called in early-execution mode.
unsubscribe()
unsubscribe(
callback):boolean
Defined in: @minecraft/server-ui/index.d.ts:1496
Parameters
callback
(arg0) => 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.
This function can't be called in restricted-execution mode.
This function can be called in early-execution mode.