SpringConstraint
Applies spring and damping forces between two attachments.
- Creatable
Instance.new("SpringConstraint")- Inherits
- ConstraintInstance
- Replication
- Standard
Behavior
SpringConstraint applies spring and damping forces between two attachments.
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 number of coils used to visualize the spring.
The color of the constraint visualization.
The current distance between the connected attachments, in studs.
The spring's damping coefficient.
Whether the physics solver processes this constraint.
The spring length at which it applies no restoring force, in studs.
Whether the constraint enforces its positional or angular limits.
The maximum force the actuator can apply.
The maximum length permitted by the constraint, in studs.
The minimum length permitted by the constraint, in studs.
The radius of the constraint visualization.
The spring's restoring-force coefficient.
The thickness of the stroke or shell.
Whether the constraint visualization is displayed.
Returns this instance if it is an ExecutionGroup.
Properties
Active
SpringConstraint.Active: boolean = falseWhether the constraint is currently active in the physics simulation.
Attachment0
SpringConstraint.Attachment0: Attachment? = nilThe first attachment used by the constraint or effect.
Attachment1
SpringConstraint.Attachment1: Attachment? = nilThe second attachment used by the constraint or effect.
Coils
SpringConstraint.Coils: number = 3The number of coils used to visualize the spring.
Color
SpringConstraint.Color: Color3 = Color3.new(1, 0.686, 0)The color of the constraint visualization.
CurrentLength
SpringConstraint.CurrentLength: number = 0The current distance between the connected attachments, in studs.
Damping
SpringConstraint.Damping: number = 1The spring's damping coefficient.
Enabled
SpringConstraint.Enabled: boolean = trueWhether the physics solver processes this constraint.
FreeLength
SpringConstraint.FreeLength: number = 2The spring length at which it applies no restoring force, in studs.
LimitsEnabled
SpringConstraint.LimitsEnabled: boolean = falseWhether the constraint enforces its positional or angular limits.
MaxForce
SpringConstraint.MaxForce: number = infThe maximum force the actuator can apply.
MaxLength
SpringConstraint.MaxLength: number = 10The maximum length permitted by the constraint, in studs.
MinLength
SpringConstraint.MinLength: number = 0The minimum length permitted by the constraint, in studs.
Radius
SpringConstraint.Radius: number = 0.2The radius of the constraint visualization.
Stiffness
SpringConstraint.Stiffness: number = 10The spring's restoring-force coefficient.
Thickness
SpringConstraint.Thickness: number = 0.1The thickness of the stroke or shell.
Visible
SpringConstraint.Visible: boolean = falseWhether the constraint visualization is displayed.
Methods
GetExecutionGroup
SpringConstraint: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