Reference API Roblox

Engine API

Website

Related

Reference API Roblox

BodyForce

Applies a constant force to an object.

This class is deprecated. It exists only for backward compatibility, and should not be used for new work.
Memory categoryInstances
Tags: [Deprecated]

Member index 2

HistoryMember
726Force: Vector3
726force: Vector3
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Description

The BodyForce object applies (or exerts) a force on the assembly to which it is parented. If the magnitude of such a force is great enough, assemblies can begin to accelerate. The force is determined by the Force property, and is defined on the three world axes.

A BodyForce alone cannot apply a torque (it cannot cause the parent to rotate on its own). To apply a force at a specific point or apply forces relative to the orientation of the assembly, use a BodyThrust instead.

History 17

Members 2

Force

TypeDefault
Vector3

This property determines the magnitude of force exerted on each axis, relative to the world.

Thread safetyReadSafe
CategoryGoals
Loaded/Savedtrue

History 5

force

TypeDefault
Vector3

A deprecated variant of BodyForce.Force that indicates the amount of force applied on each axis.

This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryGoals
Loaded/Savedtrue/false

History 8

  • 726 Change PreferredDescriptor of force from Force to
  • 726 Change Default of force from Vector3(0, 1, 0) to
  • 553 Change PreferredDescriptor of force from to Force
  • 553 Change Default of force from to Vector3(0, 1, 0)
  • 486 Change ThreadSafety of force from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of force from to ReadOnly
  • 213 Change Tags of force from [NotReplicated] to [NotReplicated, Deprecated]
  • 47 Add force
Tags: [NotReplicated, Deprecated]

Settings