BoolValue
A container object for a single boolean value.
| Memory category | Instances |
|---|
Member index 3
Description
Stores a single boolean value. The value can be used for many things, including to communicate between scripts.
Like all ValueBase objects, this single value is stored in the
Value property. The Changed event fires with the new
value being stored in the object, instead of a string representing the
property being changed.
History 11
- 553 Change PreferredDescriptor of changed from to Changed
- 553 Change Default of Value from to false
- 486 Change ThreadSafety of Value from ReadOnly to ReadSafe
- 462 Change ThreadSafety of changed from to Unsafe
- 462 Change ThreadSafety of Changed from to Unsafe
- 462 Change ThreadSafety of Value from to ReadOnly
- 335 Change Superclass of BoolValue from Instance to ValueBase
- 50 Add changed
- 47 Add Changed
- 47 Add Value
- 47 Add BoolValue
Members 3
Changed
| Parameters (1) | |
|---|---|
| value | bool |
Fires whenever the BoolValue.Value changes. It runs with the new value being stored in the argument object, instead of a string representing the property being changed.
Listening for the Changed signal can be useful in games that use
BoolValues to track switch or enabled states.
| Thread safety | Unsafe |
|---|
Value
| Type | Default | |
|---|---|---|
| bool | false | |
Used to hold a boolean value.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
changed
| Parameters (1) | |
|---|---|
| value | bool |
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. Changed should be used instead.
| Thread safety | Unsafe |
|---|