Reference API Roblox

Engine API

Website

Related

Reference API Roblox

HingeConstraint

Constrains its attachments to rotate about a single axis.

Memory categoryBaseParts

Member index 15

HistoryMember
726ActuatorType: ActuatorType
726AngularResponsiveness: float
726AngularSpeed: float
726AngularVelocity: float
726CurrentAngle: float
726LimitsEnabled: bool
726LowerAngle: float
726MotorMaxAcceleration: float
726MotorMaxTorque: float
726Radius: float
726Restitution: float
726ServoMaxTorque: float
726SoftlockServoUponReachingTarget: bool
726TargetAngle: float
726UpperAngle: 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)

Description

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.

History 78

Members 15

ActuatorType

TypeDefault
ActuatorType

Sets whether the rotation of the HingeConstraint is actuated and, if so, what kind of actuation.

Note that both actuated and free spinning rotation can be limited by setting LimitsEnabled to true.

Thread safetyReadSafe
CategoryHinge
Loaded/Savedtrue

History 5

AngularResponsiveness

TypeDefault
float

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.

Thread safetyReadSafe
CategoryServo
Loaded/Savedtrue

History 4

AngularSpeed

TypeDefault
float

The desired angular speed a HingeConstraint with ActuatorType set to Servo will attempt to maintain while rotating towards its TargetAngle. Measured in radians/second.

Thread safetyReadSafe
CategoryServo
Loaded/Savedtrue

History 5

AngularVelocity

TypeDefault
float

The angular velocity a HingeConstraint with ActuatorType set to Motor will attempt to achieve. Measured in radians/second.

Thread safetyReadSafe
CategoryMotor
Loaded/Savedtrue

History 5

CurrentAngle

TypeDefault
float

The current angle of the HingeConstraint. This angle is calculated by measuring the angle separation of the Y axes of the Attachments.

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]

LimitsEnabled

TypeDefault
bool

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.

Thread safetyReadSafe
CategoryHinge
Loaded/Savedtrue

History 5

LowerAngle

TypeDefault
float

The minimum rotation angle the HingeConstraint will allow if LimitsEnabled is true. Measured in degrees.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

MotorMaxAcceleration

TypeDefault
float

The maximum angular acceleration a HingeConstraint with ActuatorType set to Motor can apply to achieve its AngularVelocity. Measured in radians/second².

Thread safetyReadSafe
CategoryMotor
Loaded/Savedtrue

History 6

MotorMaxTorque

TypeDefault
float

The maximum torque a HingeConstraint with ActuatorType set to Motor can apply when trying to reach its desired AngularVelocity.

Thread safetyReadSafe
CategoryMotor
Loaded/Savedtrue

History 5

Radius

TypeDefault
float

The visualized radius of the HingeConstraint.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Restitution

TypeDefault
float

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.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

ServoMaxTorque

TypeDefault
float

The maximum torque a HingeConstraint with ActuatorType set to Servo can apply when trying to reach its desired TargetAngle.

Thread safetyReadSafe
CategoryServo
Loaded/Savedtrue

History 5

SoftlockServoUponReachingTarget

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

History 3

Tags: [Deprecated]

TargetAngle

TypeDefault
float

The target angle a HingeConstraint will attempt to rotate to if its ActuatorType is set to Servo. Measured in degrees.

Thread safetyReadSafe
CategoryServo
Loaded/Savedtrue

History 5

UpperAngle

TypeDefault
float

The maximum rotation angle the HingeConstraint will allow if LimitsEnabled is true. Measured in degrees.

Thread safetyReadSafe
CategoryLimits
Loaded/Savedtrue

History 5

Settings