Class
RopeConstraint
Simulates rope dynamics, preventing two attachments from separating further than a defined length.
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.
Properties 9#
CurrentDistancefloat | The current distance between the constraint's
Attachments.ReadSafeReadOnlyNotReplicated |
Lengthfloat | The maximum distance apart the two Attachments can be.ReadSafe |
Restitutionfloat | Elasticity of the Attachments connected by the
constraint when reaching the maximum defined
Length. Constrained between 0 and 1.ReadSafe |
Thicknessfloat | The visualized thickness of the RopeConstraint.ReadSafe |
WinchEnabledboolean | Enables the winch motor.ReadSafe |
WinchForcefloat | The maximum force that the winch motor can apply.ReadSafe |
WinchResponsivenessfloat | The sharpness of the winch motor in reaching the
WinchTarget.ReadSafe |
WinchSpeedfloat | A positive desired velocity at which the winch motor changes the rope length.ReadSafe |
WinchTargetfloat | The target length for the winch motor.ReadSafe |
CurrentDistance: float#
ReadOnlyNotReplicatedReadSafe
The current distance between the constraint's
Attachments.
Length: float#
ReadSafe
The maximum distance apart the two Attachments can be.
Measured in studs.
Restitution: float#
ReadSafe
Elasticity of the Attachments connected by the
constraint when reaching the maximum defined
Length. Constrained between 0 and 1.
Thickness: float#
ReadSafe
The visualized thickness of the RopeConstraint.
WinchEnabled: boolean#
ReadSafe
Enables the winch motor which has the effect or reeling in/out the length
of the rope to WinchTarget.
WinchForce: float#
ReadSafe
The maximum force that the winch motor can apply.
WinchResponsiveness: float#
ReadSafe
The sharpness of the winch motor in reaching the
WinchTarget.
WinchSpeed: float#
ReadSafe
A positive desired velocity at which the winch motor changes the rope length.
WinchTarget: float#
ReadSafe
The target length for the winch motor.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild