CylindricalConstraint

Show Deprecated

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

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.

Summary

Properties

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

Enables the angular limits around the rotation axis.

Specifies the sharpness of the angular servo motor in reaching the CylindricalConstraint.TargetAngle.

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

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

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

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

READ ONLY
NOT REPLICATED

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

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

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

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

Enable the visibility of the rotation axis.

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

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

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

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

READ ONLY
NOT REPLICATED

Events

Methods

Properties

AngularActuatorType

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

AngularLimitsEnabled

Enables the angular limits around the rotation axis.

AngularResponsiveness

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

AngularRestitution

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

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

AngularVelocity

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

CurrentAngle

Read Only
Not Replicated

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

InclinationAngle

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

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

MotorMaxAngularAcceleration

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

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

RotationAxisVisible

Enable the visibility of the rotation axis.

ServoMaxTorque

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

TargetAngle

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

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

WorldRotationAxis

Read Only
Not Replicated

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

Events

Methods