Reference API Roblox

Engine API

Website

Related

Reference API Roblox

CylindricalConstraint

Constrains two attachments on two parts to have a relative linear and rotational motion.

Memory categoryBaseParts

Member index 17

HistoryMember
726AngularActuatorType: ActuatorType
726AngularLimitsEnabled: bool
726AngularResponsiveness: float
726AngularRestitution: float
726AngularSpeed: float
726AngularVelocity: float
726CurrentAngle: float
726InclinationAngle: float
726LowerAngle: float
726MotorMaxAngularAcceleration: float
726MotorMaxTorque: float
726RotationAxisVisible: bool
726ServoMaxTorque: float
726SoftlockAngularServoUponReachingTarget: bool
726TargetAngle: float
726UpperAngle: float
726WorldRotationAxis: Vector3
inherited from SlidingBallConstraint
726ActuatorType: ActuatorType
726CurrentPosition: float
726LimitsEnabled: bool
726LinearResponsiveness: float
726LowerLimit: float
726MotorMaxAcceleration: float
726MotorMaxForce: float
726Restitution: float
726ServoMaxForce: float
726Size: float
726SoftlockServoUponReachingTarget: bool
726Speed: float
726TargetPosition: float
726UpperLimit: float
726Velocity: float
inherited from Constraint
726Active: bool
726Attachment0: Attachment
726Attachment1: Attachment
726Color: BrickColor
726Enabled: bool
726Visible: bool
604GetDebugAppliedForce(bodyId: int): Vector3
604GetDebugAppliedTorque(bodyId: int): Vector3
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
313AzimuthalAngle: float

Description

A CylindricalConstraint allows its attachments to slide along one 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 Attachment0. The rotation axis is centered at the constraint's Attachment1 and is angled off of the sliding constraint by the constraint's InclinationAngle.

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

Note that if this constraint attaches one part (A) to another part (B) that is anchored or connected to an anchored part (Z), part A will not be locally simulated when interacting with a player.

When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.

Angular Power

If a cylindrical's AngularActuatorType is set to Motor, it attempts to rotate the attachments with the goal of reaching its AngularVelocity. You can further control this rotation through both MotorMaxAngularAcceleration and MotorMaxTorque. If a cylindrical's AngularActuatorType is set to Servo, it attempts to rotate to an angle specified by TargetAngle. This rotation is controlled by AngularSpeed, AngularResponsiveness, and ServoMaxTorque.

Linear Power

If a cylindrical'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 a cylindrical'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 both the sliding range and rotation of a cylindrical constraint. 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. Enabling the AngularLimitsEnabled property exposes the LowerAngle and UpperAngle limits, as well as AngularRestitution which defines the elasticity of the attachments when they reach either limit.

Inclination Angle

InclinationAngle defines the direction of the rotation axis as an angle from the X axis in the XY plane of Attachment0, from -180 to 180. This lets you tilt the rotating element without changing the sliding axis.

History 90

Members 17

AngularActuatorType

TypeDefault
ActuatorType

If a cylindrical's AngularActuatorType is set to Motor, it attempts to rotate the attachments with the goal of reaching its AngularVelocity. You can further control this rotation through both MotorMaxAngularAcceleration and MotorMaxTorque.

If a cylindrical's AngularActuatorType is set to Servo, it attempts to rotate to an angle specified by TargetAngle. This rotation is controlled by AngularSpeed, AngularResponsiveness, and ServoMaxTorque.

Thread safetyReadSafe
CategoryCylinder
Loaded/Savedtrue

History 5

AngularLimitsEnabled

TypeDefault
bool

Enables the angular limits around the rotation axis.

Thread safetyReadSafe
CategoryCylinder
Loaded/Savedtrue

History 5

AngularResponsiveness

TypeDefault
float

This property specifies the sharpness of the angular servo motor in reaching the TargetAngle, when AngularActuatorType is set to Servo. Larger values correspond to a faster response and smaller values results in more damping and a slower response.

Thread safetyReadSafe
CategoryAngularServo
Loaded/Savedtrue

History 4

AngularRestitution

TypeDefault
float

Restitution of the two limits, or how elastic they are. Constrained between 0 and 1.

Thread safetyReadSafe
CategoryAngularLimits
Loaded/Savedtrue

History 5

AngularSpeed

TypeDefault
float

Target angular speed. This value is unsigned as the servo will always move toward its target. In radians per second.

Thread safetyReadSafe
CategoryAngularServo
Loaded/Savedtrue

History 5

AngularVelocity

TypeDefault
float

The target angular velocity of the motor in radians per second around the rotation axis.

Thread safetyReadSafe
CategoryAngularMotor
Loaded/Savedtrue

History 5

CurrentAngle

TypeDefault
float

Signed angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Valid range between -180 and 180.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryDerived
Loaded/Savedfalse/true

History 5

Tags: [ReadOnly, NotReplicated]

InclinationAngle

TypeDefault
float

Direction of the rotation axis as an angle from the X axis in the XY plane of Attachment0. Valid range between -180 and 180.

Thread safetyReadSafe
CategoryCylinder
Loaded/Savedtrue

History 5

LowerAngle

TypeDefault
float

Lower limit for the angle (in degrees) between the reference axis and the SecondaryAxis of Attachment1 around the rotation axis. Valid range between -180 and 180.

Thread safetyReadSafe
CategoryAngularLimits
Loaded/Savedtrue

History 5

MotorMaxAngularAcceleration

TypeDefault
float

The maximum angular acceleration of the motor in radians per second squared.

Thread safetyReadSafe
CategoryAngularMotor
Loaded/Savedtrue

History 6

MotorMaxTorque

TypeDefault
float

The maximum torque the motor can apply to achieve the target angular velocity. Units are mass × studs²/second².

Thread safetyReadSafe
CategoryAngularMotor
Loaded/Savedtrue

History 5

RotationAxisVisible

TypeDefault
bool

Enable the visibility of the rotation axis.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

ServoMaxTorque

TypeDefault
float

Maximum torque the servo motor can apply. Units are mass × studs²/second².

Thread safetyReadSafe
CategoryAngularServo
Loaded/Savedtrue

History 5

SoftlockAngularServoUponReachingTarget

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyReadSafe
CategoryAngularServo
Loaded/Savedtrue

History 3

Tags: [Deprecated]

TargetAngle

TypeDefault
float

Target angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Valid range between -180 and 180.

Thread safetyReadSafe
CategoryAngularServo
Loaded/Savedtrue

History 5

UpperAngle

TypeDefault
float

Upper limit for the angle (in degrees) between the reference axis and the secondary axis of Attachment1 around the rotation axis. Valid range between -180 and 180.

Thread safetyReadSafe
CategoryAngularLimits
Loaded/Savedtrue

History 5

WorldRotationAxis

TypeDefault
Vector3

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryDerived
Loaded/Savedfalse/true

History 5

Tags: [ReadOnly, NotReplicated]

Removed members 1

AzimuthalAngle

TypeDefault
float
Category
Loaded/Savedfalse

History 2

Settings