CylindricalConstraint
Allows translation and rotation along a shared attachment axis.
- Creatable
Instance.new("CylindricalConstraint")- Inherits
- SlidingBallConstraintConstraintInstance
- Replication
- Standard
Behavior
CylindricalConstraint allows translation and rotation along a shared attachment axis.
Summary
Whether the constraint is currently active in the physics simulation.
Selects no actuator, a velocity motor, or a position servo.
Selects the rotational actuator independently of the linear actuator.
Whether the constraint enforces its angular limits.
The lower permitted rotation angle, in degrees.
The restitution applied when an angular limit is reached.
The rotational speed used by the angular servo.
The upper permitted rotation angle, in degrees.
The target angular velocity of the rotational motor.
The first attachment used by the constraint or effect.
The second attachment used by the constraint or effect.
The color of the constraint visualization.
The current relative rotation angle of the attachments, in degrees.
The current displacement along the constraint axis, in studs.
Whether the physics solver processes this constraint.
The angle between the cylindrical constraint's translation and rotation axes.
Whether the constraint enforces its positional or angular limits.
The response strength of the linear servo.
The minimum permitted translation along the constraint axis, in studs.
The maximum linear acceleration permitted for the motor.
The maximum angular acceleration permitted for the motor.
The maximum force the linear motor can apply.
The maximum torque the angular motor can apply.
The restitution applied when a constraint limit is reached.
The maximum force the position servo can apply.
The maximum torque the orientation servo can apply.
The size of the constraint visualization.
The speed at which the linear servo approaches its target.
The angular position sought by a servo, in degrees.
The linear position sought by a servo, in studs.
The maximum permitted translation along the constraint axis, in studs.
The target linear velocity along the constraint axis.
Whether the constraint visualization is displayed.
Whether the configured translation limits are evaluated in world space.
Returns this instance if it is an ExecutionGroup.
Properties
Active
CylindricalConstraint.Active: boolean = falseWhether the constraint is currently active in the physics simulation.
ActuatorType
CylindricalConstraint.ActuatorType: Enum.ActuatorType = Enum.ActuatorType.NoneSelects no actuator, a velocity motor, or a position servo.
AngularActuatorType
CylindricalConstraint.AngularActuatorType: Enum.ActuatorType = Enum.ActuatorType.NoneSelects the rotational actuator independently of the linear actuator.
AngularLimitsEnabled
CylindricalConstraint.AngularLimitsEnabled: boolean = falseWhether the constraint enforces its angular limits.
AngularLowerLimit
CylindricalConstraint.AngularLowerLimit: number = -45The lower permitted rotation angle, in degrees.
AngularRestitution
CylindricalConstraint.AngularRestitution: number = 0The restitution applied when an angular limit is reached.
AngularSpeed
CylindricalConstraint.AngularSpeed: number = 0The rotational speed used by the angular servo.
AngularUpperLimit
CylindricalConstraint.AngularUpperLimit: number = 45The upper permitted rotation angle, in degrees.
AngularVelocity
CylindricalConstraint.AngularVelocity: number = 0The target angular velocity of the rotational motor.
Attachment0
CylindricalConstraint.Attachment0: Attachment? = nilThe first attachment used by the constraint or effect.
Attachment1
CylindricalConstraint.Attachment1: Attachment? = nilThe second attachment used by the constraint or effect.
Color
CylindricalConstraint.Color: Color3 = Color3.new(1, 0.686, 0)The color of the constraint visualization.
CurrentAngle
CylindricalConstraint.CurrentAngle: number = 0The current relative rotation angle of the attachments, in degrees.
CurrentPosition
CylindricalConstraint.CurrentPosition: number = 0The current displacement along the constraint axis, in studs.
Enabled
CylindricalConstraint.Enabled: boolean = trueWhether the physics solver processes this constraint.
InclinationAngle
CylindricalConstraint.InclinationAngle: number = 0The angle between the cylindrical constraint's translation and rotation axes.
LimitsEnabled
CylindricalConstraint.LimitsEnabled: boolean = falseWhether the constraint enforces its positional or angular limits.
LinearResponsiveness
CylindricalConstraint.LinearResponsiveness: number = 45The response strength of the linear servo.
LowerLimit
CylindricalConstraint.LowerLimit: number = -5The minimum permitted translation along the constraint axis, in studs.
MotorMaxAcceleration
CylindricalConstraint.MotorMaxAcceleration: number = infThe maximum linear acceleration permitted for the motor.
MotorMaxAngularAcceleration
CylindricalConstraint.MotorMaxAngularAcceleration: number = infThe maximum angular acceleration permitted for the motor.
MotorMaxForce
CylindricalConstraint.MotorMaxForce: number = infThe maximum force the linear motor can apply.
MotorMaxTorque
CylindricalConstraint.MotorMaxTorque: number = infThe maximum torque the angular motor can apply.
Restitution
CylindricalConstraint.Restitution: number = 0The restitution applied when a constraint limit is reached.
ServoMaxForce
CylindricalConstraint.ServoMaxForce: number = infThe maximum force the position servo can apply.
ServoMaxTorque
CylindricalConstraint.ServoMaxTorque: number = infThe maximum torque the orientation servo can apply.
Size
CylindricalConstraint.Size: number = 1The size of the constraint visualization.
Speed
CylindricalConstraint.Speed: number = 0The speed at which the linear servo approaches its target.
TargetAngle
CylindricalConstraint.TargetAngle: number = 0The angular position sought by a servo, in degrees.
TargetPosition
CylindricalConstraint.TargetPosition: number = 0The linear position sought by a servo, in studs.
UpperLimit
CylindricalConstraint.UpperLimit: number = 5The maximum permitted translation along the constraint axis, in studs.
Velocity
CylindricalConstraint.Velocity: number = 0The target linear velocity along the constraint axis.
Visible
CylindricalConstraint.Visible: boolean = falseWhether the constraint visualization is displayed.
WorldLimitsEnabled
CylindricalConstraint.WorldLimitsEnabled: boolean = falseWhether the configured translation limits are evaluated in world space.
Methods
GetExecutionGroup
CylindricalConstraint:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying