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

CylindricalConstraint

Show deprecated

CylindricalConstraint

Show deprecated

A CylindricalConstraint allows its Attachment to slide along an axis and rotate about another axis. It can be thought of like a combination of a PrismaticConstraint and a HingeConstraint. The sliding axis is determined by the x axis of the constraint’s Constraint/Attachment0. The rotation axis is centered at the constraint’s Constraint/Attachment1 and is angled off of the sliding constraint by the constraint’s CylindricalConstraint/InclinationAngle.

This constraint, along with a SpringConstraint, is ideal for building vehicle suspension.


Properties

ActuatorType

AngularActuatorType

Type of angular actuator: None, Motor, or Servo.

bool

AngularLimitsEnabled

Enables the angular limits around the rotation axis.

float

AngularRestitution

Restitution of the two limits, or how elastic they are. Value in [0, 1].

float

AngularSpeed

Target angular speed. This value is unsigned as the servo will always move toward its target. In radians per second. Value in [0, inf).

float

AngularVelocity

The target angular velocity of the motor in radians per second around the rotation axis. Value in [0, inf).

float

CurrentAngle

[ReadOnly] [NotReplicated]

Signed angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Value in [-180, 180].

float

InclinationAngle

Direction of the rotation axis as an angle from the x-axis in the xy-plane of Attachment0. Value in [-180, 180].

float

LowerAngle

Lower limit for the angle (in degrees) between the reference axis and the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].

float

MotorMaxAngularAcceleration

The maximum angular acceleration of the motor in radians per second squared. Value in [0, inf).

float

MotorMaxTorque

The maximum torque the motor can apply to achieve the target angular velocity. The units are mass * studs^2 / second^2. Value in [0, inf).

bool

RotationAxisVisible

Enable the visibility of the rotation axis.

float

ServoMaxTorque

Maximum torque the servo motor can apply. The units are mass * studs^2 / second^2. Value in [0, inf).

float

TargetAngle

Target angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Value in [-180, 180].

float

UpperAngle

Upper limit for the angle (in degrees) between the reference axis and the SecondaryAxis of Attachment1 around the rotation axis. Value in [-180, 180].

Vector3

WorldRotationAxis

[ReadOnly] [NotReplicated]

The unit vector direction of the rotation axis in world coordinates.

Inherited from SlidingBallConstraint: Show Hide

bool

LimitsEnabled

Sets whether the SlidingBallConstraint will limit the range of translation.
ActuatorType

ActuatorType

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

CurrentPosition

[ReadOnly] [NotReplicated]
The current offset between the SlidingBallConstraint's `Attachment`.
float

Restitution

How elastic `Attachment` connected by a SlidingBallConstraint will be when they reach the end of the range specified by `SlidingBallConstraint/UpperLimit` and `SlidingBallConstraint/LowerLimit` when `SlidingBallConstraint/LimitsEnabled` is set to true. Constrained between 0 and 1.
float

Velocity

The velocity a SlidingBallConstraint with `SlidingBallConstraint/ActuatorType` set to `Enum/ActuatorType` will attempt to achieve. Measured in studs/second.
float

UpperLimit

The upper position limit along the x-axis of `Constraint/Attachment0` for a SlidingBallConstraint if `SlidingBallConstraint/LimitsEnabled` is true.
float

TargetPosition

The target position a SlidingBallConstraint will attempt to translate to if its `SlidingBallConstraint/ActuatorType` is set to `Enum/ActuatorType`. Measured in studs.
float

Speed

The desired speed a SlidingBallConstraint with `SlidingBallConstraint/ActuatorType` set to `Enum/ActuatorType` will attempt to maintain while translating towards its `SlidingBallConstraint/TargetPosition`. Measured in studs/second.
float

Size

The visualized size of the SlidingBallConstraint.
float

ServoMaxForce

The maximum force a SlidingBallConstraint with `SlidingBallConstraint/ActuatorType` set to `Enum/ActuatorType` can apply when trying to reach its desired `SlidingBallConstraint/Speed`.
float

MotorMaxForce

The maximum force a SlidingBallConstraint with `SlidingBallConstraint/ActuatorType` set to `Enum/ActuatorType` can apply when trying to reach its desired `SlidingBallConstraint/Velocity`.
float

MotorMaxAcceleration

The maximum acceleration a SlidingBallConstraint with `SlidingBallConstraint/ActuatorType` set to `Enum/ActuatorType` can apply when trying to reach its desired `SlidingBallConstraint/Velocity`.
float

LowerLimit

The lower position limit along the x-axis of `Constraint/Attachment0` for a SlidingBallConstraint if `SlidingBallConstraint/LimitsEnabled` is true.

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

string

GetFullName ( )

Returns a string describing the `Instance`'s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
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

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.
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

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
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

Changed ( string property )

Fired immediately after a property of an object changes.