Class
AlignPosition
Constraint which applies force to move two attachments together, or to move one attachment to a goal position.
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.
Properties 11#
ApplyAtCenterOfMassboolean | Whether force is applied to the parent of
Attachment0 at that attachment's location,
or at the parents' center of mass.ReadSafe |
ForceLimitModeForceLimitMode | Determines how the constraint force will be limited. Only used if
RigidityEnabled is false.ReadSafe |
ForceRelativeToActuatorRelativeTo | Determines the axes that the constraint uses to limit the force. Only
applies when RigidityEnabled is
false and AlignPosition.ForceLimitMode is
PerAxis. .ReadSafe |
MaxAxesForceVector3 | Maximum force along each axis that the constraint can apply to achieve its goal.ReadSafe |
MaxForcefloat | Maximum force magnitude the constraint can apply to achieve its goal.ReadSafe |
MaxVelocityfloat | Maximum speed the attachments can move when converging.ReadSafe |
ModePositionAlignmentMode | Whether the constraint uses one or two attachments in calculating its goal.ReadSafe |
PositionVector3 | The position to which the constraint should move its
Attachment0.ReadSafe |
ReactionForceEnabledboolean | Whether the constraint applies force only to
Attachment0, or to both attachments in
equal and opposite directions.ReadSafe |
Responsivenessfloat | Controls how quickly the constraint reaches its goal. Higher values cause the attachment(s) to align more rapidly.ReadSafe |
RigidityEnabledboolean | Whether force is dependent on other properties, or if the physics solver reacts as quickly as possible to complete the alignment.ReadSafe |
ApplyAtCenterOfMass: boolean#
ReadSafe
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.
ForceLimitMode: ForceLimitMode#
ReadSafe
Determines how the constraint force will be limited when
RigidityEnabled is false. When set
to Magnitude, the constraint force will be limited
such that the magnitude is less than
MaxForce. When set to
PerAxis, the constraint force along each axis will
be limited by MaxAxesForce. The axes
along which the force will be limited are based on the
ForceRelativeTo property.
ForceRelativeTo: ActuatorRelativeTo#
ReadSafe
Determines the axes that the constraint uses to limit the force. Only
applies when RigidityEnabled is
false and AlignPosition.ForceLimitMode is
PerAxis. When set to
World, the constraint force is computed in the
world reference frame and the force limits specified in
MaxAxesForce refer to the axes of the
world coordinate system. When set to Attachment0
or Attachment1, the force limits specified in
MaxAxesForce refer to the axes of the
specified attachment coordinate system.
MaxAxesForce: Vector3#
ReadSafe
Maximum force along each axis that the constraint can apply to achieve its
goal. Only used if RigidityEnabled
is false and ForceLimitMode is
PerAxis. The axes used to apply to the limit are
specified using the ForceRelativeTo
property.
MaxForce: float#
ReadSafe
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: float#
ReadSafe
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: PositionAlignmentMode#
ReadSafe
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: Vector3#
ReadSafe
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: boolean#
ReadSafe
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: float#
ReadSafe
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: boolean#
ReadSafe
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 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