BodyPosition¶
Applies a force to maintain a constant position.
Description¶
The BodyPosition object applies a force on an assembly such that it will
maintain a constant position in the world. The
Position property, not to be confused with
BasePart.Position, controls the target world position. This is the
translational counterpart to a BodyGyro.
If you need further control on a force applied to an object, consider using a BodyForce or BodyThrust instead.
The strength of the force applied by this object is controlled by several factors, namely the distance to the goal position: the force is stronger when farther away from the goal. This is amplified by P (power). The present velocity will also dampen the force applied by this object, and this is amplified by D (dampening). The resulting force is then capped by MaxForce. Note the force applied on the assembly to achieve the goal position may vary on a per-axis basis.
Inheritance¶
Object → Instance → BodyMover → BodyPosition
Nova inheritance: Instance → BodyMover → BodyPosition
Properties¶
D Supported Property Determines the amount of dampening to use in reaching the goal Position.
Determines the amount of dampening to use in reaching the goal Position.
This property determines how much dampening will be applied to the force used toward reaching the goal Position. When the assembly approaches the goal position it needs to decelerate, otherwise it will move past the goal and have to stop and re-accelerate back toward the goal. This is often creates an undesirable "rubber‑banding" effect, avoided by applying dampening. The higher this value is set, the greater the dampening curve becomes, or the slower the assembly will approach the goal position.
MaxForce Supported Property Determines the limit on how much force that may be applied to each axis.
Determines the limit on how much force that may be applied to each axis.
This property determines the limit on the amount of force that may be applied on each axis in reaching the goal Position. If an assembly isn't moving, consider increasing this value and also check that it is not Anchored or attached to any anchored assemblies.
maxForce Supported Property Deprecated Use MaxForce instead
Use MaxForce instead
P Supported Property Determines how aggressive of a force is applied in reaching the goal position.
Determines how aggressive of a force is applied in reaching the goal position.
This property determines how much power is used while applying force in order to reach the goal Position. The higher this value, the more power will be used and the faster it will be used. The force the BodyPosition exerts increases as the difference between the assembly's current position and the goal position increases. This property is multiplied to this force to either amplify or diminish it.
Position Supported Property Determines the goal position towards which force will be applied.
Determines the goal position towards which force will be applied.
This property determines the goal position towards which the BodyPosition will apply force.
position Supported Property Deprecated Use position instead
Use position instead
Methods¶
GetLastForce Supported Function Returns the last force in the object.
This function returns the last force in the object.
lastForce Supported Function Deprecated Returns the last force in the object.
The lastForce function returns the last force in the object.
Events¶
ReachedTarget Supported Event Fired when the Parent of the BodyPosition reaches the desired BodyPosition.Position (within .1 studs). Once this event fires it will not fire again u…
Fired when the Parent of the BodyPosition reaches the desired BodyPosition.Position (within .1 studs). Once this event fires it will not fire again until BodyPosition.Position is updated.
Inherited members¶
Inherited from BodyMover: 8 properties, 36 methods, 7 events. They are documented on the base class page.
Roblox reference: BodyPosition
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.