Class
TorsionSpringConstraint
A rotational spring that opposes the angular motion between two axes.
A TorsionSpringConstraint applies a torque based on a relative angle and a relative angular velocity. Specifically, torsion springs try to bring two axes from two parts together in a compliant way.
Correct orientation of a torsion spring's attachments is important. The
constraint will attempt to bring the
SecondaryAxis of each attachment into
alignment. When building mechanisms like swinging doors, ensure that the
secondary axes are perpendicular to the intended axis of rotation.
When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.
Damping#
The Damping value controls how fast
the spring's oscillation dies down. A value of 0 allows the spring to
oscillate endlessly, while higher values bring the spring to a rest more
quickly.
Stiffness#
Stiffness sets the torsional
strength of the spring. Higher values create a spring that responds with more
force.
Limits#
Enabling the LimitsEnabled
property exposes the MaxAngle value
to restrict the spring's range within a cone; it also exposes the
Restitution value which defines
the elasticity of the attachments when they reach their limit.
Properties 10#
Coilsfloat | The number of coils visualized for the constraint.ReadSafe |
CurrentAnglefloat | The current angle, in degrees, of the limiting cone.ReadSafeReadOnlyNotReplicated |
Dampingfloat | Damping constant for the TorsionSpringConstraint. Multiplied to
the velocity of the constraint's Attachments to reduce
the spring force applied.ReadSafe |
LimitEnabledboolean | ReadSafeDeprecatedHidden |
LimitsEnabledboolean | Limits the relative angular motion of the secondary axes of attachments through a cone constraint.ReadSafe |
MaxAnglefloat | The maximum angle of the constraint's limiting cone.ReadSafe |
MaxTorquefloat | The maximum allowable torque provided by the torsion spring.ReadSafe |
Radiusfloat | The visualization radius of the spring.ReadSafe |
Restitutionfloat | The restitution coefficient of the cone constraint.ReadSafe |
Stiffnessfloat | The torsional stiffness of the spring.ReadSafe |
Coils: float#
ReadSafe
This property indicates the number of spring coils for visualization. Default value is 8.
CurrentAngle: float#
ReadOnlyNotReplicatedReadSafe
The current angle, in degrees, of the torsion spring's limiting cone. The
limiting cone is formed at the position of the constraint's
Attachment0 around its secondary axis with
an angle equal to MaxAngle.
Damping: float#
ReadSafe
Damping constant for the TorsionSpringConstraint. Multiplied to
the velocity of the constraint's Attachments to reduce
the spring force applied.
LimitEnabled: boolean#
HiddenDeprecatedReadSafeDeprecated
Deprecated. This property is deprecated. Use
LimitsEnabled instead.
LimitsEnabled: boolean#
ReadSafe
This property, when enabled, limits the relative angular motion of the secondary axes of attachments through a cone constraint. The default value is false.
MaxAngle: float#
ReadSafe
This property determines the maximum angle (in degrees) of the torsion
spring's limiting cone. The limiting cone is formed at the position of the
constraint's Attachment0 around its
secondary axis with an angle equal to
MaxAngle. Default value is 45
degrees.
MaxTorque: float#
ReadSafe
This property determines the maximum torque supported by the torsion spring. Defaults to 1000.
Radius: float#
ReadSafe
This property indicates the visualization radius of the spring, in studs. Default value is 0.4.
Restitution: float#
ReadSafe
This property defines how elastic Attachments connected
by a TorsionSpringConstraint are when they reach the end of the
range specified by MaxAngle, when
LimitEnabled is true. The
value defaults to 0 and can be any floating number within the range of 0
and 1.
Stiffness: float#
ReadSafe
In the absence of damping, this property is proportional to the opposing torque of the spring. For instance, higher stiffness results in a larger opposing torque, and smaller stiffness results in a smaller opposing torque. The larger the torque value, the faster the axes are pushed together when the relative angle is positive (or away from each other if the relative angle is negative). The value defaults to 100.
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