AlignPosition¶
Constraint which applies force to move two attachments together, or to move one attachment to a goal position.
Description¶
The AlignPosition constraint applies force to move two attachments together,
or to move one attachment to a goal position. As indicated by the name, it
only affects the position of the attachments, not their orientation (to
align attachments by orientation, see AlignOrientation).
When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.
Force Location¶
By default, force is applied to the parent of Attachment0 at that attachment's location, meaning that if the parent's center of mass is not aligned with the direction of the force, torque will be applied as well as force. Alternatively, force can be applied to the parents' center of mass by toggling on ApplyAtCenterOfMass.
Reactionary Force¶
By default, the constraint only applies force to Attachment0 while Attachment1 remains unaffected. If desired, force can be applied to both attachments in equal and opposite directions by enabling ReactionForceEnabled.
Force Limits¶
You can configure this constraint to apply the maximum force that constraints
allow through the RigidityEnabled
property. When true, the physics solver reacts as quickly as possible to
complete the alignment. When false, the force applied by the constraint is
limited based on ForceLimitMode,
MaxVelocity, and
Responsiveness. See
ForceLimitMode for further details.
Attachment Mode¶
This constraint can use either one or two attachments in calculating its goal. See Mode for details.
Inheritance¶
Object → Instance → Constraint → AlignPosition
Nova inheritance: Instance → Constraint → AlignPosition
Properties¶
ApplyAtCenterOfMass Supported Property Whether force is applied to the parent of Attachment0 at that attachment's location, or at the parents' center of mass.
Whether force is applied to the parent of Attachment0 at that attachment's location, or at the parents' center of mass.
When false (default), force is applied to the parent of
Attachment0 at that attachment's location,
meaning that if the parent's center of mass is not aligned with the
direction of the force, torque will be applied as well as force. When
true, force is applied at the parents' center of mass.
MaxForce Supported Property Maximum force magnitude the constraint can apply to achieve its goal.
Maximum force magnitude the constraint can apply to achieve its goal. Only
used if RigidityEnabled is false
and ForceLimitMode is
Magnitude.
Note that MaxForce, as well as MaxVelocity, are caps to the force and velocity respectively. The actual scale is determined by Responsiveness.
MaxVelocity Supported Property Maximum speed the attachments can move when converging.
Maximum speed the attachments can move when converging. Only used if
RigidityEnabled is false.
Note that MaxVelocity, as well as MaxForce, are caps to the velocity and force respectively. The actual scale is determined by Responsiveness.
Mode Supported Property Whether the constraint uses one or two attachments in calculating its goal.
Whether the constraint uses one or two attachments in calculating its goal.
Whether the constraint uses one or two attachments in calculating its goal. By default, this is TwoAttachment, meaning that the constraint disregards Position and attempts to move Attachment0 to the position of Attachment1.
If set to OneAttachment, the constraint disregards Attachment1 and attempts to move Attachment0 to Position.
Position Supported Property The position to which the constraint should move its Attachment0.
The position to which the constraint should move its Attachment0. Only used if Mode is set to OneAttachment, in which case Attachment1 is disregarded.
ReactionForceEnabled Supported Property Whether the constraint applies force only to Attachment0, or to both attachments in equal and opposite directions.
Whether the constraint applies force only to Attachment0, or to both attachments in equal and opposite directions.
If false (default), the constraint only applies force to
Attachment0 while
Attachment1 remains unaffected. If true,
the constraint applies force to both attachments in equal and opposite
directions.
Responsiveness Supported Property Controls how quickly the constraint reaches its goal. Higher values cause the attachment(s) to align more rapidly.
Controls how quickly the constraint reaches its goal. Higher values cause the attachment(s) to align more rapidly. Value can be between 5 and 200.
RigidityEnabled Supported Property Whether force is dependent on other properties, or if the physics solver reacts as quickly as possible to complete the alignment.
Whether force is dependent on other properties, or if the physics solver
reacts as quickly as possible to complete the alignment. If false
(default), the force is determined by
MaxForce,
MaxVelocity, and
Responsiveness. If true, the
physics solver reacts as quickly as possible to complete the alignment.
Inherited members¶
Inherited from Constraint: 14 properties, 36 methods, 7 events. They are documented on the base class page.
3 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's AlignPosition class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
ForceLimitMode |
ForceLimitMode: ForceLimitMode |
Not yet | Determines how the constraint force will be limited. Only used if RigidityEnabled is false. |
— |
ForceRelativeTo |
ForceRelativeTo: ActuatorRelativeTo |
Not yet | Determines the axes that the constraint uses to limit the force. Only applies when RigidityEnabled is false and [AlignPosition.Forc… |
— |
MaxAxesForce |
MaxAxesForce: Vector3 |
Not yet | Maximum force along each axis that the constraint can apply to achieve its goal. | — |
Roblox reference: AlignPosition
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.