Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SpringConstraint

Simulates spring and damper behavior between two attachments.

Memory categoryBaseParts

Member index 11

HistoryMember
726Coils: float
726CurrentLength: float
726Damping: float
726FreeLength: float
726LimitsEnabled: bool
726MaxForce: float
726MaxLength: float
726MinLength: float
726Radius: float
726Stiffness: float
726Thickness: float
inherited from Constraint
726Active: bool
726Attachment0: Attachment
726Attachment1: Attachment
726Color: BrickColor
726Enabled: bool
726Visible: bool
604GetDebugAppliedForce(bodyId: int): Vector3
604GetDebugAppliedTorque(bodyId: int): Vector3
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

A SpringConstraint applies a force to its Attachments based on spring and damper behavior. This constraint, along with a CylindricalConstraint, is ideal for building vehicle suspension.

Note that if this constraint attaches one part (A) to another part (B) that is anchored or connected to an anchored part (Z), part A will not be locally simulated when interacting with a player.

When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.

Free Length

FreeLength defines the natural resting length of the spring. If the attachments are further apart than the free length, they are forced together; if the attachments are closer together than the free length, they are forced apart.

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 strength of the spring. Higher values create a spring that responds with more force when its attachments are closer together or further apart than FreeLength.

Limits

Enabling the LimitsEnabled property exposes the MinLength and MaxLength values for setting the minimum and maximum length of the spring. If the spring's attachments reach these limits, they stop moving apart from one another without restitution.

History 60

Members 11

Coils

TypeDefault
float

The number of coils visualized on the SpringConstraint. This can only be set between 0 and 8.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

CurrentLength

TypeDefault
float

The current distance between the constraint's Attachments.

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
float

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

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

FreeLength

TypeDefault
float

Natural resting length of the spring.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

LimitsEnabled

TypeDefault
bool

Sets whether the SpringConstraint enforces a minimum and maximum length. If the constraint's Attachments reach these limits, they will simply stop moving apart from one another without restitution. If you need restitution or elasticity at the ends of the range of motion, you can combine a SpringConstraint with another constraint that allows restitution at the end of its range, such as a PrismaticConstraint or RopeConstraint.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

MaxForce

TypeDefault
float

The maximum force the SpringConstraint can apply on its Attachments. Some spring systems can give rise to forces that grow fast leading to instability. In such cases it is recommended to set MaxForce to a reasonable value.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

MaxLength

TypeDefault
float

The maximum separation the SpringConstraint will allow if LimitsEnabled is true.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

MinLength

TypeDefault
float

The minimum separation the SpringConstraint will allow if LimitsEnabled is true.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

Radius

TypeDefault
float

The visualized radius of the spring's coils.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Stiffness

TypeDefault
float

The strength of the spring. The higher this value the more force will be applied when the attachments are separated a different length than the FreeLength.

Thread safetyReadSafe
CategorySpring
Loaded/Savedtrue

History 5

Thickness

TypeDefault
float

The visualized thickness of the spring's coils.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Settings