RopeConstraint
Limits the distance between two attachments and optionally drives a winch.
- Creatable
Instance.new("RopeConstraint")- Inherits
- ConstraintInstance
- Replication
- Standard
Behavior
RopeConstraint limits the distance between two attachments and optionally drives a winch.
Summary
Whether the constraint is currently active in the physics simulation.
The first attachment used by the constraint or effect.
The second attachment used by the constraint or effect.
The color of the constraint visualization.
The current distance between the constraint's attachments, in studs.
Whether the physics solver processes this constraint.
The configured length of the rod or rope, in studs.
The restitution applied when a constraint limit is reached.
The thickness of the stroke or shell.
Whether the constraint visualization is displayed.
Whether the rope's winch actuator is enabled.
The maximum force applied by the winch.
The speed at which the winch approaches its target length.
The target rope length for the winch, in studs.
Returns this instance if it is an ExecutionGroup.
Properties
Active
RopeConstraint.Active: boolean = falseWhether the constraint is currently active in the physics simulation.
Attachment0
RopeConstraint.Attachment0: Attachment? = nilThe first attachment used by the constraint or effect.
Attachment1
RopeConstraint.Attachment1: Attachment? = nilThe second attachment used by the constraint or effect.
Color
RopeConstraint.Color: Color3 = Color3.new(1, 0.686, 0)The color of the constraint visualization.
CurrentDistance
RopeConstraint.CurrentDistance: number = 0The current distance between the constraint's attachments, in studs.
Enabled
RopeConstraint.Enabled: boolean = trueWhether the physics solver processes this constraint.
Length
RopeConstraint.Length: number = 5The configured length of the rod or rope, in studs.
Restitution
RopeConstraint.Restitution: number = 0The restitution applied when a constraint limit is reached.
Thickness
RopeConstraint.Thickness: number = 0.05The thickness of the stroke or shell.
Visible
RopeConstraint.Visible: boolean = falseWhether the constraint visualization is displayed.
WinchEnabled
RopeConstraint.WinchEnabled: boolean = falseWhether the rope's winch actuator is enabled.
WinchForce
RopeConstraint.WinchForce: number = 0The maximum force applied by the winch.
WinchSpeed
RopeConstraint.WinchSpeed: number = 0The speed at which the winch approaches its target length.
WinchTarget
RopeConstraint.WinchTarget: number = 0The target rope length for the winch, in studs.
Methods
GetExecutionGroup
RopeConstraint:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying