PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

HingeConstraint

Show Show deprecated

HingeConstraint

Show deprecated

A HingeConstraint allows two Attachment|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.

Hinges can also be configured to actuate rotation, as follows:

  • If HingeConstraint/ActuatorType is set to Enum/ActuatorType|Motor, the hinge will attempt to rotate the attachments with the goal of reaching HingeConstraint/AngularVelocity. This rotation is limited by both HingeConstraint/MotorMaxAcceleration and HingeConstraint/MotorMaxTorque.
  • If HingeConstraint/ActuatorType is set to Enum/ActuatorType|Servo, the hinge will attempt to rotate to an angle specified by HingeConstraint/TargetAngle. This rotation is limited by both HingeConstraint/AngularSpeed and HingeConstraint/ServoMaxTorque.

Note that both actuated and free spinning rotation can be limited by setting HingeConstraint/LimitsEnabled to true. Also 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.

Properties

ActuatorType

ActuatorType

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

float

AngularSpeed

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

float

AngularVelocity

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

float

CurrentAngle

[ReadOnly] [NotReplicated]

The current angle of the HingeConstraint.

bool

LimitsEnabled

Sets whether the HingeConstraint will limit the range of rotation.

float

LowerAngle

The minimum rotation angle the HingeConstraint will allow if HingeConstraint/LimitsEnabled is true.

float

MotorMaxAcceleration

The maximum angular acceleration a HingeConstraint with HingeConstraint/ActuatorType set to Enum/ActuatorType|Motor can apply to achieve its HingeConstraint/AngularVelocity. Measured in radians/(second squared).

float

MotorMaxTorque

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

float

Radius

The visualized radius of the HingeConstraint.

float

Restitution

How elastic Attachment connected by a HingeConstraint will be when they reach the end of the range when HingeConstraint/LimitsEnabled is true. Constrained between 0 and 1.

float

ServoMaxTorque

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

float

TargetAngle

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

float

UpperAngle

The maximum rotation angle the HingeConstraint will allow if HingeConstraint/LimitsEnabled is true.

Inherited from Constraint: Show Hide

bool

Active

[ReadOnly] [NotReplicated]

Indicates if the constraint is currently active in the world

Attachment

Attachment0

The Attachment that is connected to Constraint/Attachment1

Attachment

Attachment1

The Attachment that is connected to Constraint/Attachment0

BrickColor

Color

The color of the constraint.

bool

Enabled

Toggles whether or not this Constraint is enabled.

bool

Visible

Toggles the visibility of this Constraint.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

Determines the hierarchical parent of the Instance

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]