PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. BodyPosition

BodyPosition

Show deprecated
Hide content
  1. apireference
  2. bodyposition

BodyPosition

Show deprecated

The BodyPosition object applies a force on a BasePart such that it will maintain a constant position in the world. The BodyPosition/Position|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 BodyPosition/P|P (power). The present velocity will also dampen the force applied by this object, and this is amplified by BodyPosition/D|D (dampening). The resulting force is then capped by BodyPosition/MaxForce|MaxForce. Note the force applied on the part to achieve the goal position may vary on a per-axis basis.

Troubleshooting

  • If the assembly isn’t moving, it’s likely the BodyPosition/MaxForce|MaxForce is too low. Also check for any BasePart/Anchored|Anchored parts within the assembly or in the way of the assembly.
  • If the assembly is moving horizontally but not vertically, it’s likely the BodyPosition/MaxForce|MaxForce is strong enough to overcome friction but not gravity. Consider raising the Y component of BodyPosition/MaxForce|MaxForce in order to get the object off the ground.
  • If the assembly is overshooting the goal position and springing back, it’s likely the BodyPosition/D|D (dampening) is too low. Alternatively, the BodyPosition/MaxForce|MaxForce and/or BodyPosition/P|P may be too high.
  • Any assembly containing a part that contains a BodyPosition or a BodyGyro will not be simulated when interacting with a player unless that player is the /articles/Network Ownership|network owner of the assembly.

Properties

float

D

Determines the amount of dampening to use in reaching the goal BodyPostion/Position|Position
Vector3

MaxForce

Determines the limit on how much force that may be applied to each axis
float

P

Determines how aggressive of a force is applied in reaching the goal position
Vector3

Position

Determines the goal position towards which force will be applied
Vector3

maxForce

[NotReplicated] [Deprecated]
Vector3

position

[NotReplicated] [Deprecated]

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Vector3

GetLastForce ( )

Returns the last force in the object.
Vector3

lastForce ( )

[Deprecated]

Returns the last force in the object

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

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.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

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: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

BodyPosition

This code will make a brick fly and hover in the center of the map, a little bit off the ground.

Copy Code Light Theme
BodyGyro BodyThrust