Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TorsionSpringConstraint

A rotational spring that opposes the angular motion between two axes.

Memory categoryBaseParts

Member index 10

HistoryMember
731Coils: float
731CurrentAngle: float
731Damping: float
731LimitsEnabled: bool
731MaxAngle: float
731MaxTorque: float
731Radius: float
731Restitution: float
731Stiffness: float
inherited from Constraint
731Active: bool
731Attachment0: Attachment
731Attachment1: Attachment
731Color: BrickColor
731Enabled: bool
731Visible: bool
604GetDebugAppliedForce(bodyId: int): Vector3
604GetDebugAppliedTorque(bodyId: int): Vector3
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

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.

History 57

Members 10

Coils

TypeDefault
float8

This property indicates the number of spring coils for visualization. Default value is 8.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

CurrentAngle

TypeDefault
float0

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.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryDerived
Loaded/Savedfalse/true

History 5

Tags: [ReadOnly, NotReplicated]

Damping

TypeDefault
float0.00999999978

Damping constant for the TorsionSpringConstraint. Multiplied to the velocity of the constraint's Attachments to reduce the spring force applied.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

LimitsEnabled

TypeDefault
boolfalse

This property, when enabled, limits the relative angular motion of the secondary axes of attachments through a cone constraint. The default value is false.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 4

MaxAngle

TypeDefault
float45

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.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 6

MaxTorque

TypeDefault
floatINF

This property determines the maximum torque supported by the torsion spring. Defaults to 1000.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

Radius

TypeDefault
float0.400000006

This property indicates the visualization radius of the spring, in studs. Default value is 0.4.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Restitution

TypeDefault
float0

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.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 6

Stiffness

TypeDefault
float100

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.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

Settings