Engine

SlidingBallConstraint

Show Deprecated
not creatable

SlidingBallConstraint is the base class for constraints that allow their attachments to slide along an axis but not rotate, including PrismaticConstraint and CylindricalConstraint. This constrains the attachments so that their X axes are collinear but pointing in opposite directions. It also constrains the attachments so that their Y axes are parallel.

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.

Summary

Properties

Properties inherited from Constraint

Properties

ActuatorType

read parallel

Sets whether the translation of the SlidingBallConstraint is actuated and, if so, what kind of actuation.

CurrentPosition

read only
not replicated
read parallel

The current offset between the constraint's Attachments.

LimitsEnabled

read parallel

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.

LinearResponsiveness

read parallel

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.

LowerLimit

read parallel

The lower positional limit along the X axis of Attachment0 if LimitsEnabled is true.

MotorMaxAcceleration

read parallel

The constraint's maximum acceleration when ActuatorType is set to Motor, as the constraint attempts to reach its desired Velocity.

MotorMaxForce

read parallel

The constraint's maximum force when ActuatorType is set to Motor, as the constraint attempts to reach its desired Velocity.

Restitution

read parallel

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.

ServoMaxForce

read parallel

The constraint's maximum force when ActuatorType is set to Servo, as the constraint attempts to reach its desired Speed.

Size

read parallel

The constraint's visualized size.

Speed

read parallel

The constraint's desired speed when ActuatorType is set to Servo, as the constraint translates towards its TargetPosition. Measured in studs per second.

TargetPosition

read parallel

The constraint's attempted target position when ActuatorType is set to Servo Measured in studs.

UpperLimit

read parallel

The upper positional limit along the X axis of Attachment0 if LimitsEnabled is true.

Velocity

read parallel

The constraint's attempted velocity when ActuatorType is set to Motor. Measured in studs per second.

Methods

Events