# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: BoolValue
type: class
memory_category: Instances
summary: |
  A container object for a single boolean value.
description: |
  Stores a single boolean value. The value can be used for many things,
  including to communicate between scripts.

  Like all `Class.ValueBase` objects, this single value is stored in the
  `Class.BoolValue.Value|Value` property. The `Changed` event fires with the new
  value being stored in the object, instead of a string representing the
  property being changed.
code_samples: []
inherits:
  - ValueBase
descendants: []
tags: []
deprecation_message: ''
properties:
  - name: BoolValue.Value
    summary: |
      Used to hold a boolean value.
    description: |
      Used to hold a boolean value.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities: []
methods: []
events:
  - name: BoolValue.Changed
    summary: |
      Fires whenever the `Class.BoolValue.Value` is changed.
    description: |
      Fires whenever the `Class.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.
    code_samples:
      - BoolValue-Changed1
    parameters:
      - name: value
        type: boolean
        default:
        summary: |
          The new value after the change.
    tags: []
    deprecation_message: ''
    security: None
    capabilities: []
  - name: BoolValue.changed
    summary: ''
    description: ''
    code_samples: []
    parameters:
      - name: value
        type: boolean
        default:
        summary: ''
    tags:
      - Deprecated
    deprecation_message: |
      This event is a deprecated variant of `Class.BoolValue.Changed` which
      should be used instead.
    security: None
    capabilities: []
callbacks: []