We use cookies on this site to enhance your user experience
Collapse Sidebar

SpringConstraint

Deprecated

SpringConstraint

Deprecated

A SpringConstraint applies a force to its Attachment based on spring and damper behavior. Assuming the SpringConstraint has SpringConstraint/Stiffness, it will apply forces based on how far apart the Attachments are. If the Attachments are further apart than the SpringConstraint’s SpringConstraint/FreeLength then the Attachments will be forced together. If they are closer than the FreeLength then the Attachments will be forced apart. In addition, if SpringConstraint/Damping is set then there will be a damping component to the applied force that scales with the velocity of the attachments.

The following code shows how the force of a SpringConstraint is calculated:

length = constraint.CurrentLength
if constraint.LimitsEnabled then
length = clamp(constraint.CurrentLength, constraint.MinLength, constraint.MaxLength) – Constrain the length between the Min/Max length.
end
axis = (Attachment0.Position - Attachment1.Position).unit
deltaV = Attachment0.Velocity - Attachment1.Velocity
force = -constraint.Stiffness * length - constraint.Damping * deltaV:Dot(axis)
force = clamp(force, -constraint.MaxForce, constraint.MaxForce)
force * axis will be applied to Attachment0’s part at Attachment0’s Position. -force * axis will be applied to Attachment1’s part at Attachment1’s Position.


Properties

float

Coils

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

float

CurrentLength

[ReadOnly] [NotReplicated]

The current distance between the SpringConstant’s Attachment.

float

Damping

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

float

FreeLength

Natural resting length of the spring.

bool

LimitsEnabled

Sets whether the SpringConstraint enforces a minimum and maximum length.

float

MaxForce

The maximum force the SpringConstraint can apply on its Attachment.

float

MaxLength

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

float

MinLength

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

float

Radius

The visualized radius of the spring’s coils.

float

Stiffness

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 SpringConstraint/FreeLength.

float

Thickness

The visualized thickness of the spring’s coils.

Inherited from Constraint: Show Hide

bool

Visible

Toggles the visibility of this Constraint.
bool

Enabled

Toggles whether or not this Constraint is enabled.
BrickColor

Color

The color of the constraint.
Attachment

Attachment1

The `Attachment` that is connected to `Constraint/Attachment0`
Attachment

Attachment0

The `Attachment` that is connected to `Constraint/Attachment1`

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.