Reference API Roblox

Engine API

Website

Related

Reference API Roblox

JointInstance

The base class for joints.

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

Member index 7

HistoryMember
553Active: bool
553C0: CFrame
553C1: CFrame
553Enabled: bool
553Part0: BasePart
553Part1: BasePart
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

JointInstance is the base class for joints such as Welds and Motors.

Weld, WeldConstraint, Motor, and Motor6D all combine multiple parts into the same assembly. Every assembly has a root part (BasePart:GetRootPart()) and when C0/C1 of a JointInstance is modified, the root part will stay where it was.

Welds do not have any directionality. You can imagine rigid joints forming a tree branching down from the root part. All the parts down the tree from root will move, and their welded "children" in this tree will move with them.

History 36

Members 7

Active

TypeDefault
bool

This property determines if the joint is currently active in the world. If true, the joint is active.

If the JointInstance is not in Workspace or JointsService, or one of its parts is not in Workspace the joint will be inactive.

Rigid joints like Weld, Snap, WeldConstraint, Motor, or Motor6D may also be disabled due to conflicts with other rigid joints, such as joints between the same two parts or indirect cycles in the weld graph. Joints disabled this way may be re-enabled later when another joint or part is added or removed.

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 5

Tags: [ReadOnly, NotReplicated]

C0

TypeDefault
CFrame

C0 is the position aspect of the orientation between two parts in a weld. JointInstance.Part0 and JointInstance.Part1 move accordingly to this value, which denotes their respective positions.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

  • 553 Change Default of C0 from to
  • 486 Change ThreadSafety of C0 from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of C0 from to ReadOnly
  • 47 Add C0

C1

TypeDefault
CFrame

Is subtracted from the JointInstance.C0 property to create an offset point for JointInstance.Part1.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

  • 553 Change Default of C1 from to
  • 486 Change ThreadSafety of C1 from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of C1 from to ReadOnly
  • 47 Add C1

Enabled

TypeDefault
bool

This property sets whether the joint is active or not.

When this property is set to true, if the joints's JointInstance.Part0 and JointInstance.Part1 properties are set, then the joint will ensure that its two parts will be connected and behave according to joint type (e.g. Welds, and Snaps).

See also:

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 5

Part0

TypeDefault
BasePart

The first BasePart that the joint connects.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 5

Part1

TypeDefault
BasePart

The second BasePart that the joint connects.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 5

Settings