AlignPosition
Applies force to move an attachment toward a target position.
- Creatable
Instance.new("AlignPosition")- Inherits
- ConstraintInstance
- Replication
- Standard
Behavior
AlignPosition applies force to move an attachment toward a target position.
Summary
Whether the constraint is currently active in the physics simulation.
Whether force is applied at the assembly's center of mass to avoid additional torque.
The first attachment used by the constraint or effect.
The second attachment used by the constraint or effect.
The color of the constraint visualization.
Whether the physics solver processes this constraint.
The maximum force the actuator can apply.
The maximum linear speed permitted while approaching the target.
Whether alignment targets a world-space position or another attachment.
The target world-space position used in one-attachment mode.
Whether the actuator applies an equal and opposite force to the second assembly.
The response strength used to approach the actuator's target.
Whether the solver treats alignment as a rigid constraint rather than a force-limited response.
Whether the constraint visualization is displayed.
Returns this instance if it is an ExecutionGroup.
Properties
Active
AlignPosition.Active: boolean = falseWhether the constraint is currently active in the physics simulation.
ApplyAtCenterOfMass
AlignPosition.ApplyAtCenterOfMass: boolean = falseWhether force is applied at the assembly's center of mass to avoid additional torque.
Attachment0
AlignPosition.Attachment0: Attachment? = nilThe first attachment used by the constraint or effect.
Attachment1
AlignPosition.Attachment1: Attachment? = nilThe second attachment used by the constraint or effect.
Color
AlignPosition.Color: Color3 = Color3.new(1, 0.686, 0)The color of the constraint visualization.
Enabled
AlignPosition.Enabled: boolean = trueWhether the physics solver processes this constraint.
MaxForce
AlignPosition.MaxForce: number = 10000The maximum force the actuator can apply.
MaxVelocity
AlignPosition.MaxVelocity: number = infThe maximum linear speed permitted while approaching the target.
Mode
AlignPosition.Mode: Enum.PositionAlignmentMode = Enum.PositionAlignmentMode.OneAttachmentWhether alignment targets a world-space position or another attachment.
Position
AlignPosition.Position: Vector3 = Vector3.new(0, 0, 0)The target world-space position used in one-attachment mode.
ReactionForceEnabled
AlignPosition.ReactionForceEnabled: boolean = falseWhether the actuator applies an equal and opposite force to the second assembly.
Responsiveness
AlignPosition.Responsiveness: number = 10The response strength used to approach the actuator's target.
RigidityEnabled
AlignPosition.RigidityEnabled: boolean = falseWhether the solver treats alignment as a rigid constraint rather than a force-limited response.
Visible
AlignPosition.Visible: boolean = falseWhether the constraint visualization is displayed.
Methods
GetExecutionGroup
AlignPosition:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying