Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Constraint

The base class for constraint-based objects.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryBaseParts
Tags: [NotCreatable]

Member index 8

HistoryMember
726Active: bool
726Attachment0: Attachment
726Attachment1: Attachment
726Color: BrickColor
726Enabled: bool
726Visible: bool
604GetDebugAppliedForce(bodyId: int): Vector3
604GetDebugAppliedTorque(bodyId: int): Vector3
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

The base class for constraint-based objects. See mover constraints and mechanical constraints for more details.

History 44

Members 8

Active

TypeDefault
bool

This property is true if the constraint and both of its parts are in the Workspace and the constraint's Constraint.Enabled property is true.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryBehavior
Loaded/Savedfalse

History 6

Tags: [ReadOnly, NotReplicated]

Attachment0

TypeDefault
Attachment

The Attachment that is connected to Constraint.Attachment1

Thread safetyReadSafe
CategoryAttachments
Loaded/Savedtrue

History 6

Attachment1

TypeDefault
Attachment

The Attachment that is connected to Constraint.Attachment0

Thread safetyReadSafe
CategoryAttachments
Loaded/Savedtrue

History 6

Color

TypeDefault
BrickColor

The color of the constraint.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Enabled

TypeDefault
bool

Toggles whether or not the constraint is enabled.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 5

GetDebugAppliedForce

Parameters (1)
bodyIdint
Returns (1)
Vector3
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

GetDebugAppliedTorque

Parameters (1)
bodyIdint
Returns (1)
Vector3
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

Visible

TypeDefault
bool

Toggles the constraint's visibility.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Settings