ObservedBoolean

ObservedBoolean

Wrapper around a boolean value that signals change via onChanged signal.

Kind: global class
Author: Alex Goldring
Copyright: Company Named Limited (c) 2025

• ObservedBoolean
  • new ObservedBoolean([value])
  • instance
    • .onChanged : Signal.<boolean, boolean>
    • .isObservedBoolean : boolean
    • .hashCode : function
    • .valueOf() ⇒ boolean
    • .toString() ⇒ string
    • .set(value) ⇒ ObservedBoolean
    • .setTrue()
    • .setFalse()
    • .copy(other)
    • .equals(other) ⇒ boolean
    • .hash() ⇒ number
    • .process(f, [thisArg]) ⇒ this
    • .getValue() ⇒ boolean
    • .invert()
    • .toBinaryBuffer(buffer)
    • .fromBinaryBuffer(buffer)
  • static
    • .FALSE : ObservedBoolean
    • .TRUE : ObservedBoolean

new ObservedBoolean([value])

Param	Type	Default
[value]	boolean	false

Example

const v = new ObservedBoolean(false);

 v.getValue(); // false

 v.set(true);

 v.getValue(); // true

observedBoolean.onChanged : Signal.<boolean, boolean>

Signals current value and previously held value. Only fires when the value actually changes.

Kind: instance property of ObservedBoolean
Read only: true

observedBoolean.isObservedBoolean : boolean

Kind: instance property of ObservedBoolean
Read only: true

observedBoolean.hashCode : function

Deprecated

Kind: instance property of ObservedBoolean

observedBoolean.valueOf() ⇒ boolean

Kind: instance method of ObservedBoolean

observedBoolean.toString() ⇒ string

Kind: instance method of ObservedBoolean

observedBoolean.set(value) ⇒ ObservedBoolean

Kind: instance method of ObservedBoolean

Param	Type
value	boolean

observedBoolean.setTrue()

Equivalent to set with true argument.

Kind: instance method of ObservedBoolean

observedBoolean.setFalse()

Equivalent to set with false argument.

Kind: instance method of ObservedBoolean

observedBoolean.copy(other)

Kind: instance method of ObservedBoolean

Param	Type
other	ObservedBoolean

observedBoolean.equals(other) ⇒ boolean

Kind: instance method of ObservedBoolean

Param	Type
other	ObservedBoolean

observedBoolean.hash() ⇒ number

Kind: instance method of ObservedBoolean

observedBoolean.process(f, [thisArg]) ⇒ this

Kind: instance method of ObservedBoolean

Param	Type
f	function
[thisArg]	*

observedBoolean.getValue() ⇒ boolean

Kind: instance method of ObservedBoolean

observedBoolean.invert()

Flip value. If the value is true - it becomes false, if it was false it becomes true

Kind: instance method of ObservedBoolean

observedBoolean.toBinaryBuffer(buffer)

Kind: instance method of ObservedBoolean

Param	Type
buffer	BinaryBuffer

observedBoolean.fromBinaryBuffer(buffer)

Kind: instance method of ObservedBoolean

Param	Type
buffer	BinaryBuffer

ObservedBoolean.FALSE : ObservedBoolean

Kind: static property of ObservedBoolean
Read only: true

ObservedBoolean.TRUE : ObservedBoolean

Kind: static property of ObservedBoolean
Read only: true