Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Position Constraint component

Constrain a GameObject's position to follow one or more source objects.
Read time 2 minutesLast updated 18 days ago

A Position Constraint component moves a GameObject to follow its source GameObjects.

Position Constraint component

Properties

Property

Description

ActivateAfter you position the constrained GameObject and its source GameObjects, click Activate to save this information. Activate saves the current offset from the source GameObjects in Position At Rest and Position Offset, then enables Is Active and Lock.
ZeroSets the position of the constrained GameObject to the source GameObjects. Zero resets the Position At Rest and Position Offset fields, then enables Is Active and Lock.
Is ActiveEnable to evaluate the Constraint. To also apply the Constraint, make sure Lock is enabled.
WeightThe strength of the Constraint. A weight of 1 causes the Constraint to move this GameObject at the same rate as its source GameObjects. A weight of 0 removes the effect of the Constraint completely. This weight affects all source GameObjects. Each GameObject in the Sources list also has a weight.

Constraint Settings

Property

Description

LockEnable to let the Constraint move the GameObject. Disable this property to edit the position of this GameObject. You can also edit the Position At Rest and Position Offset properties. If Is Active is enabled, the Constraint updates the At Rest or Offset properties for you as you move the GameObject or its Source GameObjects. When you are satisfied with your changes, check Lock to let the Constraint control this GameObject. This property has no effect in Play mode.
Position At RestThe X, Y, and Z values to use when Weight is 0 or when the corresponding Freeze Position Axes is not enabled. To edit these fields, disable Lock.
Position OffsetThe X, Y, and Z offset from the Transform that is imposed by the Constraint. To edit these fields, disable Lock.
Freeze Position AxesEnable X, Y, or Z to allow the Constraint to control the corresponding axes. Disable an axis to stop the Constraint from controlling it. This allows you to edit, animate, or script the unfrozen axis.

Sources

The list of GameObjects that constrain this GameObject. Each source has a weight from 0 to 1.