Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
BodyPosition
Inherits from: BodyMover → Instance → Object
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.
Inherits from: BodyMover
Memory category: Instances
Tags: Deprecated
Deprecated: This object is deprecated and should not be used for new work. Use AlignPosition instead, and see the legacy conversion notes.
Properties
| Name | Type / Returns | Description |
|---|---|---|
| BodyPosition.D | float | Determines the amount of dampening to use in reaching the goal Position. |
| BodyPosition.MaxForce | Vector3 | Determines the limit on how much force that may be applied to each axis. |
| BodyPosition.maxForce | Vector3 | |
| BodyPosition.P | float | Determines how aggressive of a force is applied in reaching the goal position. |
| BodyPosition.Position | Vector3 | Determines the goal position towards which force will be applied. |
| BodyPosition.position | Vector3 |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
BodyPosition.D
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.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Goals |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
BodyPosition.MaxForce
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.
| Field | Value |
|---|---|
| type | Vector3 |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Goals |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
BodyPosition.maxForce
Deprecated. This property is a deprecated variant of BodyPosition.MaxForce which should be used instead.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["NotReplicated","Deprecated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Goals |
| serialization | {"can_load":true,"can_save":false} |
| capabilities | ["Physics"] |
BodyPosition.P
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.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Goals |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
BodyPosition.Position
This property determines the goal position towards which the BodyPosition will apply force.
| Field | Value |
|---|---|
| type | Vector3 |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Goals |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Physics"] |
BodyPosition.position
Deprecated. This is a deprecated variant of BodyPosition.Position which should be used instead.
| Field | Value |
|---|---|
| type | Vector3 |
| tags | ["NotReplicated","Deprecated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Goals |
| serialization | {"can_load":true,"can_save":false} |
| capabilities | ["Physics"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| BodyPosition:GetLastForce | Vector3 | Returns the last force in the object. |
| BodyPosition:lastForce | Vector3 | Returns the last force in the object. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
BodyPosition:GetLastForce
This function returns the last force in the object.
Returns
| Type | Description |
|---|---|
| Vector3 |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Physics"] |
BodyPosition:lastForce
Deprecated. This property has been superseded by BodyPosition:GetLastForce() which should be used in new work instead,
The lastForce function returns the last force in the object.
Returns
| Type | Description |
|---|---|
| Vector3 |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Physics"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| BodyPosition.ReachedTarget | 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 from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
BodyPosition.ReachedTarget
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.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Physics"] |