Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RodConstraint

Keeps two attachments separated by its defined Length.

Memory categoryBaseParts

Member index 6

HistoryMember
726CurrentDistance: float
726Length: float
726LimitAngle0: float
726LimitAngle1: float
726LimitsEnabled: bool
726Thickness: float
inherited from Constraint
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

A RodConstraint keeps two attachments separated by its defined Length. By default, both attachments can rotate freely, although you can enable limits to restrict rotational tilt.

Note that if this constraint attaches one part (A) to another part (B) that is anchored or connected to an anchored part (Z), part A will not be locally simulated when interacting with a player.

Limits

You can limit rotation of the attachments within a cone, independently of each other, by enabling the LimitsEnabled property and setting LimitAngle0 and LimitAngle1 respectively.

History 32

Members 6

CurrentDistance

TypeDefault
float

The current distance between the constraint's Attachments.

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
CategoryDerived
Loaded/Savedfalse/true

History 5

Tags: [ReadOnly, NotReplicated]

Length

TypeDefault
float

The distance apart at which the constraint attempts to keep its Attachments. Measured in studs.

Thread safetyReadSafe
CategoryRod
Loaded/Savedtrue

History 5

LimitAngle0

TypeDefault
float

This property determines the maximum angle between the rod and Attachment0 when LimitsEnabled is true.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 4

LimitAngle1

TypeDefault
float

This property determines the maximum angle between the rod and Attachment1 when LimitsEnabled is true.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 4

LimitsEnabled

TypeDefault
bool

This property determines whether the LimitAngle0 and LimitAngle1 properties control the angles between the rod and the respective attachments.

Thread safetyReadSafe
CategoryRod
Loaded/Savedtrue

History 4

Thickness

TypeDefault
float

The visualized thickness of the RodConstraint.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Settings