Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BoolValue

A container object for a single boolean value.

Memory categoryInstances

Member index 3

HistoryMember
731Value: bool
462Changed(value: bool)
731changed(value: bool)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

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 15

Members 3

Changed

Parameters (1)
valuebool

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 safetyUnsafe

History 2

Value

TypeDefault
boolfalse

Used to hold a boolean value.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 6

  • 731 Change Default of Value from to false
  • 726 Change Default of Value from false to
  • 553 Change Default of Value from to false
  • 486 Change ThreadSafety of Value from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Value from to ReadOnly
  • 47 Add Value

changed

Parameters (1)
valuebool
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. Changed should be used instead.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

Settings