8 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

RopeConstraint

Inherits from: Constraint → Instance → Object

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.

Inherits from: Constraint

Memory category: BaseParts

Properties

NameType / ReturnsDescription
RopeConstraint.CurrentDistancefloatThe current distance between the constraint's Attachments.
RopeConstraint.LengthfloatThe maximum distance apart the two Attachments can be.
RopeConstraint.RestitutionfloatElasticity of the Attachments connected by the constraint when reaching the maximum defined Length. Constrained between 0 and 1.
RopeConstraint.ThicknessfloatThe visualized thickness of the RopeConstraint.
RopeConstraint.WinchEnabledbooleanEnables the winch motor.
RopeConstraint.WinchForcefloatThe maximum force that the winch motor can apply.
RopeConstraint.WinchResponsivenessfloatThe sharpness of the winch motor in reaching the WinchTarget.
RopeConstraint.WinchSpeedfloatA positive desired velocity at which the winch motor changes the rope length.
RopeConstraint.WinchTargetfloatThe target length for the winch motor.

Inherited from Constraint

NameType / ReturnsDescription
Constraint.ActivebooleanIndicates if the constraint is currently active in the world.
Constraint.Attachment0AttachmentThe Attachment that is connected to Constraint.Attachment1.
Constraint.Attachment1AttachmentThe Attachment that is connected to Constraint.Attachment0.
Constraint.ColorBrickColorThe color of the constraint.
Constraint.EnabledbooleanToggles whether or not the constraint is enabled.
Constraint.VisiblebooleanToggles the constraint's visibility.

Inherited from Instance

NameType / ReturnsDescription
Instance.ArchivablebooleanDetermines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivableboolean
Instance.CapabilitiesSecurityCapabilitiesThe set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandboxbooleanIndicates whether the instance is inside a sandboxed container.
Instance.NamestringA non-unique identifier of the Instance.
Instance.ParentInstanceDetermines the hierarchical parent of the Instance.
Instance.PredictionModePredictionModeReflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLockedbooleanA deprecated property that used to protect CoreGui objects.
Instance.SandboxedbooleanWhen enabled, the instance can only access abilities in its Capabilities list.
Instance.UniqueIdUniqueIdA unique identifier for the instance.

Inherited from Object

NameType / ReturnsDescription
Object.ClassNamestringA read-only string representing the class this Object belongs to.
Object.classNamestring

RopeConstraint.CurrentDistance

The current distance between the constraint's Attachments.

FieldValue
typefloat
tags["ReadOnly","NotReplicated"]
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryDerived
serialization{"can_load":false,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.Length

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

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryRope
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.Restitution

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

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryRope
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.Thickness

The visualized thickness of the RopeConstraint.

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryAppearance
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.WinchEnabled

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

FieldValue
typeboolean
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryRope
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.WinchForce

The maximum force that the winch motor can apply.

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryWinch
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.WinchResponsiveness

The sharpness of the winch motor in reaching the WinchTarget.

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryWinch
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.WinchSpeed

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

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryWinch
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

RopeConstraint.WinchTarget

The target length for the winch motor.

FieldValue
typefloat
security{"read":"None","write":"None"}
thread safetyReadSafe
categoryWinch
serialization{"can_load":true,"can_save":true}
capabilities["Physics"]
simulationAccesstrue

Methods

Inherited from Constraint

NameType / ReturnsDescription
Constraint:GetDebugAppliedForceVector3
Constraint:GetDebugAppliedTorqueVector3

Inherited from Instance

NameType / ReturnsDescription
Instance:AddTag()Applies a tag to the instance.
Instance:childrenInstancesReturns an array of the object's children.
Instance:ClearAllChildren()This method destroys all of an instance's children.
Instance:CloneInstanceCreate a copy of an instance and all its descendants, ignoring instances that are not Archivable.
Instance:cloneInstance
Instance:Destroy()Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:destroy()
Instance:FindFirstAncestorInstance?Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
Instance:FindFirstAncestorOfClassInstance?Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
Instance:FindFirstAncestorWhichIsAInstance?Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
Instance:FindFirstChildInstance?Returns the first child of the Instance found with the given name.
Instance:findFirstChildInstance
Instance:FindFirstChildOfClassInstance?Returns the first child of the Instance whose ClassName is equal to the given class name.
Instance:FindFirstChildWhichIsAInstance?Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
Instance:FindFirstDescendantInstance?Returns the first descendant found with the given Instance.Name.
Instance:GetActorActor?Returns the Actor associated with the Instance, if any.
Instance:GetAttributeVariantReturns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignalRBXScriptSignalReturns an event that fires when the given attribute changes.
Instance:GetAttributesDictionaryReturns a dictionary of the instance's attributes.
Instance:GetChildrenInstancesReturns an array containing all of the instance's children.
Instance:getChildrenInstances
Instance:GetDebugIdstringReturns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendantsInstancesReturns an array containing all of the descendants of the instance.
Instance:GetFullNamestringReturns a string describing the instance's ancestry.
Instance:GetStyledVariantReturns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignalRBXScriptSignalReturns an event that fires when the given style property changes on the instance.
Instance:GetTagsArrayGets an array of all tags applied to the instance.
Instance:HasTagbooleanCheck whether the instance has a given tag.
Instance:IsAncestorOfbooleanReturns true if an Instance is an ancestor of the given descendant.
Instance:IsDescendantOfbooleanReturns true if an Instance is a descendant of the given ancestor.
Instance:isDescendantOfboolean
Instance:IsPropertyModifiedbooleanReturns true if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendantsInstancesReturns an array containing all descendants of the instance that match the selector string.
Instance:Remove()Sets the object's Parent to nil, and does the same for all its descendants.
Instance:remove()
Instance:RemoveTag()Removes a tag from the instance.
Instance:ResetPropertyToDefault()Resets a property to its default value.
Instance:SetAttribute()Sets the attribute with the given name to the given value.
Instance:WaitForChildInstanceReturns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

NameType / ReturnsDescription
Object:GetPropertyChangedSignalRBXScriptSignalGet an event that fires when a given property of the object changes.
Object:IsAbooleanReturns true if an object's class matches or inherits from a given class.
Object:isAboolean

Events

Inherited from Instance

NameType / ReturnsDescription
Instance.AncestryChangedFires when the Instance.Parent property of this object or one of its ancestors is changed.
Instance.AttributeChangedFires whenever an attribute is changed on the Instance.
Instance.ChildAddedFires after an object is parented to this Instance.
Instance.childAdded
Instance.ChildRemovedFires after a child is removed from this Instance.
Instance.DescendantAddedFires after a descendant is added to the Instance.
Instance.DescendantRemovingFires immediately before a descendant of the Instance is removed.
Instance.DestroyingFires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChangedFires whenever any style property is changed on the instance, including when a property is set to nil.

Inherited from Object

NameType / ReturnsDescription
Object.ChangedFires immediately after a property of the object changes, with some limitations.