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

Members 6

CurrentDistance

TypeDefault
float0

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 6

Tags: [ReadOnly, NotReplicated]

Length

TypeDefault
float5

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

Thread safetyReadSafe
CategoryRod
Loaded/Savedtrue

History 6

LimitAngle0

TypeDefault
float90

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

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

LimitAngle1

TypeDefault
float90

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

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

LimitsEnabled

TypeDefault
boolfalse

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 5

Thickness

TypeDefault
float0.100000001

The visualized thickness of the RodConstraint.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 6

Settings