RopeConstraint¶
Simulates rope dynamics, preventing two attachments from separating further than a defined length.
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.
Inheritance¶
Object → Instance → Constraint → RopeConstraint
Nova inheritance: Instance → Constraint → RopeConstraint
Properties¶
CurrentDistance Supported Property The current distance between the constraint's Attachments.
The current distance between the constraint's Attachments.
Length Supported Property The maximum distance apart the two Attachments can be.
The maximum distance apart the two Attachments can be. Measured in studs.
Restitution Supported Property Elasticity of the Attachments connected by the constraint when reaching the maximum defined Length. Constrained between 0 and 1.
Elasticity of the Attachments connected by the constraint when reaching the maximum defined Length. Constrained between 0 and 1.
Thickness Supported Property The visualized thickness of the RopeConstraint.
WinchEnabled Supported Property Enables the winch motor.
Enables the winch motor.
Enables the winch motor which has the effect or reeling in/out the length of the rope to WinchTarget.
WinchForce Supported Property The maximum force that the winch motor can apply.
WinchResponsiveness Supported Property The sharpness of the winch motor in reaching the WinchTarget.
The sharpness of the winch motor in reaching the WinchTarget.
WinchSpeed Supported Property A positive desired velocity at which the winch motor changes the rope length.
A positive desired velocity at which the winch motor changes the rope length.
WinchTarget Supported Property The target length for the winch motor.
Inherited members¶
Inherited from Constraint: 14 properties, 36 methods, 7 events. They are documented on the base class page.
Roblox reference: RopeConstraint
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.