Class
HingeConstraint
Constrains its attachments to rotate about a single axis.
A HingeConstraint allows two Attachments to rotate
about one axis, constraining the two Attachments so that
they both occupy the same position and that their X axes point in the same
direction.
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#
Hinges can be configured to actuate rotation. If a hinge's
ActuatorType 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
MotorMaxAcceleration and
MotorMaxTorque. If a hinge's
ActuatorType is set to
Servo, it attempts to rotate to an angle specified by
TargetAngle. This rotation is controlled
by both AngularSpeed and
ServoMaxTorque.
Limits#
You can set limits to restrict the rotation of a hinge, useful for mechanisms
like doors which should only swing open or closed within a set range. Enabling
the LimitsEnabled property exposes the
LowerAngle and
UpperAngle limits, as well as
Restitution which defines the elasticity
of the attachments when they reach either limit.
Properties 15#
ActuatorTypeActuatorType | Sets whether the rotation of the HingeConstraint is actuated and,
if so, what kind of actuation it uses.ReadSafe |
AngularResponsivenessfloat | Specifies the sharpness of the servo motor in reaching the
TargetAngle.ReadSafe |
AngularSpeedfloat | The desired angular speed a HingeConstraint with
ActuatorType set to
Servo will attempt to maintain while rotating towards
its TargetAngle. Measured in
radians/second.ReadSafe |
AngularVelocityfloat | The angular velocity a HingeConstraint with
ActuatorType set to
Motor will attempt to achieve. Measured in
radians/second.ReadSafe |
CurrentAnglefloat | The current angle of the HingeConstraint.ReadSafeReadOnlyNotReplicated |
LimitsEnabledboolean | Sets whether the HingeConstraint will limit the range of rotation.ReadSafe |
LowerAnglefloat | The minimum rotation angle the HingeConstraint will allow if
LimitsEnabled is true.ReadSafe |
MotorMaxAccelerationfloat | The maximum angular acceleration a HingeConstraint with
ActuatorType set to
Motor can apply to achieve its
AngularVelocity. Measured in
radians/second².ReadSafe |
MotorMaxTorquefloat | The maximum torque a HingeConstraint with
ActuatorType set to
Motor can apply when trying to reach its desired
AngularVelocity.ReadSafe |
Radiusfloat | The visualized radius of the HingeConstraint.ReadSafe |
Restitutionfloat | How elastic Attachment connected by a HingeConstraint will
be when they reach the end of the range when
LimitsEnabled is true. Constrained
between 0 and 1.ReadSafe |
ServoMaxTorquefloat | The maximum torque a HingeConstraint with
ActuatorType set to
Servo can apply when trying to reach its desired
TargetAngle.ReadSafe |
SoftlockServoUponReachingTargetboolean | ReadSafeDeprecated |
TargetAnglefloat | The target angle a HingeConstraint will attempt to rotate to if
its ActuatorType is set to
Servo. Measured in degrees.ReadSafe |
UpperAnglefloat | The maximum rotation angle the HingeConstraint will allow if
LimitsEnabled is true.ReadSafe |
ActuatorType: ActuatorType#
ReadSafe
Sets whether the rotation of the HingeConstraint is actuated and,
if so, what kind of actuation.
- If
ActuatorTypeis set toMotor, the hinge will attempt to rotate the attachments with the goal of reachingAngularVelocity. This rotation is limited by bothMotorMaxAccelerationandMotorMaxTorque. - If
ActuatorTypeis set toServo, the hinge will attempt to rotate to an angle specified byTargetAngle. This rotation is limited by bothAngularSpeedandServoMaxTorque.
Note that both actuated and free spinning rotation can be limited by
setting LimitsEnabled to true.
AngularResponsiveness: float#
ReadSafe
This property specifies the sharpness of the servo motor in reaching the
TargetAngle, when
ActuatorType is set to
Servo. Larger values correspond to a faster response
and smaller values results in more damping and a slower response.
AngularSpeed: float#
ReadSafe
The desired angular speed a HingeConstraint with
ActuatorType set to
Servo will attempt to maintain while rotating towards
its TargetAngle. Measured in
radians/second.
AngularVelocity: float#
ReadSafe
The angular velocity a HingeConstraint with
ActuatorType set to
Motor will attempt to achieve. Measured in
radians/second.
CurrentAngle: float#
ReadOnlyNotReplicatedReadSafe
The current angle of the HingeConstraint. This angle is calculated
by measuring the angle separation of the Y axes of the
Attachments.
LimitsEnabled: boolean#
ReadSafe
Sets whether the HingeConstraint will limit the range of rotation.
If enabled, the constraint will only allow the
CurrentAngle to be between
LowerAngle and
UpperAngle. If the Attachment
reach the end of the limited range of rotation then they will stop
rotating. If Restitution is greater
than 0 then the attachments will bounce when they hit the ends of the
limited range.
LowerAngle: float#
ReadSafe
The minimum rotation angle the HingeConstraint will allow if
LimitsEnabled is true. Measured in
degrees.
MotorMaxAcceleration: float#
ReadSafe
The maximum angular acceleration a HingeConstraint with
ActuatorType set to
Motor can apply to achieve its
AngularVelocity. Measured in
radians/second².
MotorMaxTorque: float#
ReadSafe
The maximum torque a HingeConstraint with
ActuatorType set to
Motor can apply when trying to reach its desired
AngularVelocity.
Radius: float#
ReadSafe
The visualized radius of the HingeConstraint.
Restitution: float#
ReadSafe
How elastic Attachment connected by a HingeConstraint will
be when they reach the end of the range when
LimitsEnabled is true. Constrained
between 0 and 1.
ServoMaxTorque: float#
ReadSafe
The maximum torque a HingeConstraint with
ActuatorType set to
Servo can apply when trying to reach its desired
TargetAngle.
SoftlockServoUponReachingTarget: boolean#
DeprecatedReadSafeDeprecated
Deprecated. This property should not be used in new work.
TargetAngle: float#
ReadSafe
The target angle a HingeConstraint will attempt to rotate to if
its ActuatorType is set to
Servo. Measured in degrees.
UpperAngle: float#
ReadSafe
The maximum rotation angle the HingeConstraint will allow if
LimitsEnabled is true. Measured in
degrees.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild