Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RopeConstraint

Simulates rope dynamics, preventing two attachments from separating further than a defined length.

Memory categoryBaseParts

Member index 9

HistoryMember
726CurrentDistance: float
726Length: float
726Restitution: float
726Thickness: float
726WinchEnabled: bool
726WinchForce: float
726WinchResponsiveness: float
726WinchSpeed: float
726WinchTarget: 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)

Removed member index 1

HistoryMember
249CurrentLength: float

Description

A RopeConstraint prevents two attachments from separating further than a defined Length. The attachments can move closer together than this length and both can freely rotate. This constraint can also be powered to behave as a motorized winch.

When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.

Winch

If a rope's WinchEnabled property is enabled, it attempts to translate the attachments to a set separation specified by WinchTarget, effectively the target length of the rope in studs. This translation is controlled by WinchSpeed, WinchResponsiveness, and WinchForce.

Note that WinchSpeed must be a positive value, used to either contract or extend the rope length to WinchTarget. Setting a negative speed will revert to 0, not reverse the winch servo direction.

History 42

Members 9

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 maximum distance apart the two Attachments can be. Measured in studs.

Thread safetyReadSafe
CategoryRope
Loaded/Savedtrue

History 5

Restitution

TypeDefault
float

Elasticity of the Attachments connected by the constraint when reaching the maximum defined Length. Constrained between 0 and 1.

Thread safetyReadSafe
CategoryRope
Loaded/Savedtrue

History 5

Thickness

TypeDefault
float

The visualized thickness of the RopeConstraint.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

WinchEnabled

TypeDefault
bool

Enables the winch motor which has the effect or reeling in/out the length of the rope to WinchTarget.

Thread safetyReadSafe
CategoryRope
Loaded/Savedtrue

History 3

WinchForce

TypeDefault
float

The maximum force that the winch motor can apply.

Thread safetyReadSafe
CategoryWinch
Loaded/Savedtrue

History 3

WinchResponsiveness

TypeDefault
float

The sharpness of the winch motor in reaching the WinchTarget.

Thread safetyReadSafe
CategoryWinch
Loaded/Savedtrue

History 3

WinchSpeed

TypeDefault
float

A positive desired velocity at which the winch motor changes the rope length.

Thread safetyReadSafe
CategoryWinch
Loaded/Savedtrue

History 3

WinchTarget

TypeDefault
float

The target length for the winch motor.

Thread safetyReadSafe
CategoryWinch
Loaded/Savedtrue

History 3

Removed members 1

CurrentLength

TypeDefault
float
This property is read-only. Its value can be read, but it cannot be modified.
Category
Loaded/Savedfalse

History 2

Tags: [ReadOnly]

Settings