Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
SlidingBallConstraint
Inherits from: Constraint → Instance → Object
SlidingBallConstraint is the base class for constraints that allow their attachments to slide along an axis, including PrismaticConstraint and CylindricalConstraint. The base class does not restrict rotation. PrismaticConstraint prevents rotation, while CylindricalConstraint allows rotation about an axis.
When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.
Linear Power
If this constraint's ActuatorType is set to Motor, it attempts to translate the attachments with the goal of reaching Velocity. You can further control this translation through both MotorMaxAcceleration and MotorMaxForce.
If this constraint's ActuatorType is set to Servo, it attempts to translate the attachments to a set separation specified by TargetPosition. This translation is controlled by Speed, LinearResponsiveness, and ServoMaxForce.
Limits
You can set limits to restrict this constraint's sliding range. Enabling the LimitsEnabled property exposes the LowerLimit and UpperLimit values, as well as Restitution which defines the elasticity of the attachments when they reach either limit.
Inherits from: Constraint
Descendants: CylindricalConstraint, PrismaticConstraint
Memory category: BaseParts
Tags: NotCreatable
Properties
| Name | Type / Returns | Description |
|---|---|---|
| SlidingBallConstraint.ActuatorType | ActuatorType | Sets whether the translation of the SlidingBallConstraint is actuated and, if so, what kind of actuation. |
| SlidingBallConstraint.CurrentPosition | float | The current offset between the constraint's Attachments. |
| SlidingBallConstraint.LimitsEnabled | boolean | Sets whether the SlidingBallConstraint will limit the range of translation. |
| SlidingBallConstraint.LinearResponsiveness | float | Specifies the "sharpness" of the linear servo motor in reaching the TargetPosition. |
| SlidingBallConstraint.LowerLimit | float | The lower positional limit along the X axis of Attachment0 if LimitsEnabled is true. |
| SlidingBallConstraint.MotorMaxAcceleration | float | The constraint's maximum acceleration when ActuatorType is set to Motor as the constraint attempts to reach its desired Velocity. |
| SlidingBallConstraint.MotorMaxForce | float | The constraint's maximum force when ActuatorType is set to Motor, as the constraint attempts to reach its desired Velocity. |
| SlidingBallConstraint.Restitution | float | The elasticity of the constraint's Attachments when they reach the end of the range specified by UpperLimit and LowerLimit, assuming LimitsEnabled is set to true. |
| SlidingBallConstraint.ServoMaxForce | float | The constraint's maximum force when ActuatorType is set to Servo, as the constraint attempts to reach its desired Speed. |
| SlidingBallConstraint.Size | float | The constraint's visualized size. |
| SlidingBallConstraint.SoftlockServoUponReachingTarget | boolean | |
| SlidingBallConstraint.Speed | float | The constraint's desired speed when ActuatorType is set to Servo, as the constraint translates towards its TargetPosition. Measured in studs per second. |
| SlidingBallConstraint.TargetPosition | float | The constraint's attempted target position when ActuatorType is set to Servo. Measured in studs. |
| SlidingBallConstraint.UpperLimit | float | The upper positional limit along the X axis of Attachment0 if LimitsEnabled is true. |
| SlidingBallConstraint.Velocity | float | The constraint's attempted velocity when ActuatorType is set to Motor. Measured in studs per second. |
Inherited from Constraint
| Name | Type / Returns | Description |
|---|---|---|
| Constraint.Active | boolean | Indicates if the constraint is currently active in the world. |
| Constraint.Attachment0 | Attachment | The Attachment that is connected to Constraint.Attachment1. |
| Constraint.Attachment1 | Attachment | The Attachment that is connected to Constraint.Attachment0. |
| Constraint.Color | BrickColor | The color of the constraint. |
| Constraint.Enabled | boolean | Toggles whether or not the constraint is enabled. |
| Constraint.Visible | boolean | Toggles the constraint's visibility. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
SlidingBallConstraint.ActuatorType
Sets whether the translation of the SlidingBallConstraint is actuated and, if so, what kind of actuation.
If
ActuatorTypeis set toNone, the joint can slide freely.If
ActuatorTypeis set toMotor, it attempts to translate the attachments with the goal of reachingVelocity. You can further control this translation through bothMotorMaxAccelerationandMotorMaxForce.If this constraint's
ActuatorTypeis set toServo, it attempts to translate the attachments to a set separation specified byTargetPosition. This translation is controlled bySpeed,LinearResponsiveness, andServoMaxForce.
| Field | Value |
|---|---|
| type | ActuatorType |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Slider |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.CurrentPosition
The current offset between the constraint's Attachments.
| Field | Value |
|---|---|
| type | float |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Derived |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.LimitsEnabled
Sets whether the SlidingBallConstraint will limit the range of translation. If true, this property exposes the LowerLimit and UpperLimit values, as well as Restitution which defines the elasticity of the attachments when they reach either limit.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Slider |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.LinearResponsiveness
Specifies the "sharpness" of the linear servo motor in reaching the TargetPosition when the derived classes' actuator type is set to Servo. Larger values correspond to faster a response and smaller values results in more damping and a slower response.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Servo |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.LowerLimit
The lower positional limit along the X axis of Attachment0 if LimitsEnabled is true.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Limits |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.MotorMaxAcceleration
The constraint's maximum acceleration when ActuatorType is set to Motor, as the constraint attempts to reach its desired Velocity.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Motor |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.MotorMaxForce
The constraint's maximum force when ActuatorType is set to Motor, as the constraint attempts to reach its desired Velocity.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Motor |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.Restitution
The elasticity of the constraint's Attachments when they reach the end of the range specified by UpperLimit and LowerLimit, assuming LimitsEnabled is set to true. The valid range is between 0–1.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Limits |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.ServoMaxForce
The constraint's maximum force when ActuatorType is set to Servo, as the constraint attempts to reach its desired Speed.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Servo |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.Size
The constraint's visualized size.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.SoftlockServoUponReachingTarget
Deprecated. This property should not be used in new work.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["Deprecated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Servo |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.Speed
The constraint's desired speed when ActuatorType is set to Servo, as the constraint translates towards its TargetPosition. Measured in studs per second.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Servo |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.TargetPosition
The constraint's attempted target position when ActuatorType is set to Servo Measured in studs.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Servo |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.UpperLimit
The upper positional limit along the X axis of Attachment0 if LimitsEnabled is true.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Limits |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
SlidingBallConstraint.Velocity
The constraint's attempted velocity when ActuatorType is set to Motor. Measured in studs per second.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Motor |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
| simulationAccess | true |
Methods
Inherited from Constraint
| Name | Type / Returns | Description |
|---|---|---|
| Constraint:GetDebugAppliedForce | Vector3 | |
| Constraint:GetDebugAppliedTorque | Vector3 |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | 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. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |