RopeConstraint

Show Deprecated

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.

Summary

Properties

Properties inherited from Constraint

Properties

CurrentDistance

read only
not replicated
read parallel

The current distance between the constraint's Attachments.

Length

read parallel

The maximum distance apart the two Attachments can be. Measured in studs.

Restitution

read parallel

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

Thickness

read parallel

The visualized thickness of the RopeConstraint.

WinchEnabled

read parallel

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

WinchForce

read parallel

The maximum force that the winch motor can apply.

WinchResponsiveness

read parallel

The sharpness of the winch motor in reaching the WinchTarget.

WinchSpeed

read parallel

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

WinchTarget

read parallel

The target length for the winch motor.

Methods

Events