# 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: Constraint
type: class
memory_category: BaseParts
summary: |
  The base class for constraint-based objects.
description: |
  The base class for constraint-based objects. See
  [mover constraints](../../../physics/mover-constraints.md) and
  [mechanical constraints](../../../physics/mechanical-constraints.md) for more
  details.
code_samples: []
inherits:
  - Instance
descendants:
  - AlignOrientation
  - AlignPosition
  - AngularVelocity
  - AnimationConstraint
  - BallSocketConstraint
  - HingeConstraint
  - LineForce
  - LinearVelocity
  - PlaneConstraint
  - RigidConstraint
  - RodConstraint
  - RopeConstraint
  - SlidingBallConstraint
  - SpringConstraint
  - Torque
  - TorsionSpringConstraint
  - UniversalConstraint
  - VectorForce
tags:
  - NotCreatable
deprecation_message: ''
properties:
  - name: Constraint.Active
    summary: |
      Indicates if the constraint is currently active in the world.
    description: |
      This property is `true` if the constraint and both of its parts are in the
      `Class.Workspace` and the constraint's `Class.Constraint.Enabled` property
      is `true`.
    code_samples: []
    type: boolean
    tags:
      - ReadOnly
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Behavior
    serialization:
      can_load: false
      can_save: false
    capabilities:
      - Physics
  - name: Constraint.Attachment0
    summary: |
      The `Class.Attachment` that is connected to
      `Class.Constraint.Attachment1`.
    description: |
      The `Class.Attachment` that is connected to `Class.Constraint.Attachment1`
    code_samples: []
    type: Attachment
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Attachments
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Physics
  - name: Constraint.Attachment1
    summary: |
      The `Class.Attachment` that is connected to
      `Class.Constraint.Attachment0`.
    description: |
      The `Class.Attachment` that is connected to `Class.Constraint.Attachment0`
    code_samples: []
    type: Attachment
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Attachments
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Physics
  - name: Constraint.Color
    summary: |
      The color of the constraint.
    description: |
      The color of the constraint.
    code_samples: []
    type: BrickColor
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Physics
  - name: Constraint.Enabled
    summary: |
      Toggles whether or not the constraint is enabled.
    description: |
      Toggles whether or not the constraint is enabled.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Behavior
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Physics
  - name: Constraint.Visible
    summary: |
      Toggles the constraint's visibility.
    description: |
      Toggles the constraint's visibility.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Physics
methods:
  - name: Constraint:GetDebugAppliedForce
    summary: ''
    description: ''
    code_samples: []
    parameters:
      - name: bodyId
        type: int
        default:
        summary: ''
    returns:
      - type: Vector3
        summary: ''
    tags:
      - Deprecated
    deprecation_message: |
      This method should not be used in new work.
    security: None
    thread_safety: Unsafe
    capabilities:
      - Physics
  - name: Constraint:GetDebugAppliedTorque
    summary: ''
    description: ''
    code_samples: []
    parameters:
      - name: bodyId
        type: int
        default:
        summary: ''
    returns:
      - type: Vector3
        summary: ''
    tags:
      - Deprecated
    deprecation_message: |
      This method should not be used in new work.
    security: None
    thread_safety: Unsafe
    capabilities:
      - Physics
events: []
callbacks: []