@minecraft/server-ui / ObservableBoolean
Class: ObservableBoolean
Defined in: @minecraft/server-ui/index.d.ts:1179
An observable that holds a boolean value. Listeners are notified whenever the value changes.
Constructors
Constructor
new ObservableBoolean(
data,options?):ObservableBoolean
Defined in: @minecraft/server-ui/index.d.ts:1195
Parameters
data
boolean
The initial boolean value for this observable.
options?
Optional configuration for the observable, such as whether the value can be written by the client.
Returns
ObservableBoolean
Remarks
Creates a new ObservableBoolean with the provided initial boolean value.
This function can't be called in restricted-execution mode.
This function can be called in early-execution mode.
Methods
getData()
getData():
boolean
Defined in: @minecraft/server-ui/index.d.ts:1205
Returns
boolean
Remarks
Returns the current boolean 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:1219
Parameters
data
boolean
The new boolean value to set.
Returns
void
Remarks
Updates the boolean 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:1234
Parameters
callback
(arg0) => void
A function that receives the new boolean 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:1248
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.