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