API:Class/SpringConstraint

Warning:When using Constraints, the PGS Physics Solver must be enabled.


ExplorerImageIndex91.pngSpringConstraint : Object Icon.pngConstraint : Object Icon.pngInstance

A SpringConstraint applies a force to its Attachments based on spring and damper behavior. Assuming the SpringConstraint has Stiffness, it will apply forces based on how far apart the Attachments are. If the Attachments are further apart than the SpringConstraint’s 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 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

PropertiesmemberhiddenProperties [toggle]

floatCoils

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

|RMD member="API:Class/SpringConstraint/Coils"|The number of coils visualized on the SpringConstraint. This can only be set between 0 and 8.|/RMD|
floatCurrentLength [readonly]

The current distance between the SpringConstant’s Attachments.

|RMD member="API:Class/SpringConstraint/CurrentLength"|The current distance between the SpringConstant’s Attachments.|/RMD|
floatDamping

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

|RMD member="API:Class/SpringConstraint/Damping"|Damping constant for the SpringConstraint. Multiplied to the velocity of the constraint’s Attachments to reduce the spring force applied.|/RMD|
floatFreeLength

Natural resting length of the spring.

|RMD member="API:Class/SpringConstraint/FreeLength"|Natural resting length of the spring.|/RMD|
boolLimitsEnabled

Sets whether the SpringConstraint enforces a minimum and maximum length.

|RMD member="API:Class/SpringConstraint/LimitsEnabled"|Sets whether the SpringConstraint enforces a minimum and maximum length.|/RMD|
floatMaxForce

The maximum force the SpringConstraint can apply on its Attachments.

|RMD member="API:Class/SpringConstraint/MaxForce"|The maximum force the SpringConstraint can apply on its Attachments.|/RMD|
floatMaxLength

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

|RMD member="API:Class/SpringConstraint/MaxLength"|The maximum separation the SpringConstraint will allow if LimitsEnabled is true.|/RMD|
floatMinLength

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

|RMD member="API:Class/SpringConstraint/MinLength"|The minimum separation the SpringConstraint will allow if LimitsEnabled is true.|/RMD|
floatRadius

The visualized radius of the spring's coils.

|RMD member="API:Class/SpringConstraint/Radius"|The visualized radius of the spring's coils.|/RMD|
floatStiffness

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.

|RMD member="API:Class/SpringConstraint/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 FreeLength.|/RMD|
floatThickness

The visualized thickness of the spring's coils.

|RMD member="API:Class/SpringConstraint/Thickness"|The visualized thickness of the spring's coils.|/RMD|
The number of coils visualized on the SpringConstraint. This can only be set between 0 and 8.
CurrentLength [readonly]
The current distance between the SpringConstant’s Attachments.
Damping constant for the SpringConstraint. Multiplied to the velocity of the constraint’s Attachments to reduce the spring force applied.
Natural resting length of the spring.
Sets whether the SpringConstraint enforces a minimum and maximum length.
The maximum force the SpringConstraint can apply on its Attachments.
The maximum separation the SpringConstraint will allow if LimitsEnabled is true.
The minimum separation the SpringConstraint will allow if LimitsEnabled is true.
The visualized radius of the spring's coils.
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.
The visualized thickness of the spring's coils.
Inherited from Object Icon.pngConstraint:
Ref<Attachment>Attachment0

The ExplorerImageIndex81.pngAttachment that is connected to Attachment1.

|RMD member="API:Class/Constraint/Attachment0"|The ExplorerImageIndex81.pngAttachment that is connected to Attachment1.|/RMD|
Ref<Attachment>Attachment1

The ExplorerImageIndex81.pngAttachment that is connected to Attachment0.

|RMD member="API:Class/Constraint/Attachment1"|The ExplorerImageIndex81.pngAttachment that is connected to Attachment0.|/RMD|
BrickColorColor

The color of the constraint.

|RMD member="API:Class/Constraint/Color"|The color of the constraint.|/RMD|
boolEnabled

Toggles whether or not this Constraint is enabled.

|RMD member="API:Class/Constraint/Enabled"|Toggles whether or not this Constraint is enabled.|/RMD|
boolVisible

Toggles the visibility of this Constraint.

|RMD member="API:Class/Constraint/Visible"|Toggles the visibility of this Constraint.|/RMD|
The ExplorerImageIndex81.pngAttachment that is connected to Attachment1.
The ExplorerImageIndex81.pngAttachment that is connected to Attachment0.
The color of the constraint.
Toggles whether or not this Constraint is enabled.
Toggles the visibility of this Constraint.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
Ref<Instance>Parent

The hierarchical parent of the object.

|RMD member="API:Class/Instance/Parent"|The hierarchical parent of the object.|/RMD|
intDataCost [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

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

|RMD member="API:Class/Instance/RobloxLocked"|If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
The hierarchical parent of the object.
DataCost [LocalUserSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

|RMD member="API:Class/Instance/Clone"|Returns a copy of the object, including descendants, but only if the object is Archivable.|/RMD|
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
Instanceclone ( ) [deprecated]

Deprecated in favor of Clone.

|RMD member="API:Class/Instance/clone"|Deprecated in favor of Clone.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
voidremove ( ) [deprecated]

Deprecated in favor of Remove.

|RMD member="API:Class/Instance/remove"|Deprecated in favor of Remove.|/RMD|
Removes all descendants of the object.
Clone ( )
Returns a copy of the object, including descendants, but only if the object is Archivable.
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
clone ( ) [deprecated]
Deprecated in favor of Clone.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.
remove ( ) [deprecated]
Deprecated in favor of Remove.


Events

EventsmemberhiddenEvents [toggle]

Inherited from Object Icon.pngInstance:
AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

|RMD member="API:Class/Instance/AncestryChanged"|Fires when the Parent property of the object or one of its ancestors is changed.|/RMD|
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Fires when the Parent property of the object or one of its ancestors is changed.
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.
|RMD member="API:Class/SpringConstraint"|A SpringConstraint applies a force to its Attachments based on spring and damper behavior. Assuming the SpringConstraint has Stiffness, it will apply forces based on how far apart the Attachments are. If the Attachments are further apart than the SpringConstraint’s 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 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. |/RMD|