PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. AlignOrientation

AlignOrientation

Show deprecated
Hide content
  1. apireference
  2. alignorientation

AlignOrientation

Show deprecated

An AlignOrientation attempts to constrain its Constraint/Attachment0|Attachment0’s orientation to the goal orientation, which is determined by Constraint/Attachment1|Attachment1 or AlignOrientation/CFrame|CFrame depending on the AlignOrientation/Mode|Mode.

AlignOrientation Demo

By default, this constraint only applies torque on Constraint/Attachment0|Attachment0’s parent, although it can be configured to apply torque on both attachments. This torque can be limited to a max amount via AlignOrientation/MaxTorque.

Primary axis

The behavior of an AlignOrientation is determined by its AlignOrientation/PrimaryAxisOnly property. By default this value is false and an AlignOrientation will work so that the orientation of its Attachment0 exactly matches the orientation of its goal. It will apply torque about all 3 axes to achieve this goal.

If PrimaryAxisOnly is set to true, then the AlignOrientation will only apply torque if the primary axis of its Attachment0 becomes unaligned with the goal. This means that any rotation about the Attachment0’s primary axis will not create a torque.

Torque magnitude

The torque used to constrain an AlignOrientation can either be configured or set to the maximum that constraints allow. Whether the torque is configurable is determined by the AlignOrientation/RigidityEnabled property.

When RigidityEnabled is true, the physics solver reacts as quickly as possible to complete the alignment. This is the same scale of force used to align other constraints, such as prismatics when their attachments are misaligned.

When RigidityEnabled is false, then the force will be determined by the MaxTorque, MaxAngularVelocity, and Responsiveness. MaxForce and MaxVelocity are caps to the torque and angular velocity respectively. The actual scale of the torque is determined by the Responsiveness. The mechanism for responsiveness is a little complicated, but put simply the higher the responsiveness, the quicker the constraint will try to reach its goal.

Reaction Torque

AlignOrientations by default only apply a torque on Attachment0’s parent Part. The parent Part of Attachment1 remains unaffected. However, a torque can also be applied to Attachment1 by enabling the AlignOrientation/ReactionTorqueEnabled. This will cause a torque to be applied to both Attachment0 and Attachment1 in equal and opposite directions.

See also

Properties

AlignType

AlignType

The constraint’s axis alignment type (parallel or perpendicular).
CFrame

CFrame

The goal orientation of the AlignOrientation (the translation component is ignored).
float

MaxAngularVelocity

The maximum angular velocity the constraint can use to reach its goal.
float

MaxTorque

The maximum torque the constraint can use to reach its goal.
OrientationAlignmentMode

Mode

The way the constraint determines its goal orientation.
Vector3

PrimaryAxis

The direction of the goal’s X-Axis, represented as a unit Vector3.
bool

PrimaryAxisOnly

If true, the AlignOrientation applies torque if the primary axis of its Constraint/Attachment0|Attachment0 becomes unaligned with the goal.
bool

ReactionTorqueEnabled

When true the constraint will apply torque on both Attachments to achieve the goal.
float

Responsiveness

Controls how quickly the constraint will reach its goal. Higher values will cause the attachment to align quicker. Value can be between 5 and 200.
bool

RigidityEnabled

When true, the solver reacts as quickly as possible to complete the alignment. When false, the torque is dependent on AlignOrientation/MaxTorque|MaxTorque, AlignOrientation/MaxAngularVelocity|MaxAngularVelocity, and AlignOrientation/Responsiveness|Responsiveness.
Vector3

SecondaryAxis

The direction of the goal’s Y-Axis, represented as a unit Vector3.

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

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
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 copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
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.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
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.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
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

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

Creating an AlignOrientation

This example demos the functionality of AlignOrientation.

In order to do this, we must first create two BaseParts, one with the AlignOrientation, and the other being that part that will move according to the torque applied by the AlignOrientation in the first part. Note that the part that we apply torque on, named part2, cannot be anchored or it will not move when the torque is applied.

Then, we create two attachments, attachment0 and attachment1. The first of these attachments, attachment0 will apply torque to its parent part, part1 to allign with attachment1, which is parented to part2.

For these attachments to work as described, we create a new AlignOrientation and parent it to part1. We then connect attachment0 to AlignOrientation/Attachment0 and attachment1 to AlignOrientation/Attachment1. In this example, we set AlignOrientation/RigidityEnabled to true because it helps to smooth the alignment - but this is optional.

Finally, to demo the alignment the example relies on RunService’s RunService/RenderStepped to slowly rotate part1. Due to the AlignmentOrientation, part2 also rotates as attachment0 aligns itself with attachment1.

Copy Code Light Theme
WedgePart AlignPosition