VectorForce

Show deprecated

A VectorForce is used to apply a force to a part or assembly of parts. The direction and strength of the force is determined by a `DataType/Vector3` and can be relative to an attachment on the part, another attachment, or the world coordinate system.

Location of force

A VectorForce will apply its force on the Parent of its `Constraint/Attachment0|Attachment0`, but the location where the force is applied is determined by the `VectorForce/ApplyAtCenterOfMass` property.

When `VectorForce/ApplyAtCenterOfMass` is false, which it is by default, the force will be applied to the part at the Attachement0’s location. This means that if the attachment is not at the center of the part, it can create a torque on the part.

When ApplyAtCenterOfMass is set to true, the force will check if any other parts are rigidly connected to the parent part of its Attachment0. If there are, then the force will apply at the center of mass of all of the connected parts. If there are no rigid connections to other parts, the force will simply be applied at the center of mass of the part.

Direction of force

The direction of the force is determined by the Vector3 defined by force, but it will also be affected by the `VectorForce/RelativeTo` property.

By default, `VectorForce/RelativeTo` is set to `Enum/ActuatorRelativeTo|Enum.ActuatorRelativeTo.Attachment0`, meaning the force will be applied in the space local to the attachment. Remember that when visualizing an attachment, the yellow arrow shows the direction of positive X, and the orange bar shows the direction of positive Y. If the part the attachment is connected to rotates, the force will change direction to make sure it is still in the context of the attachment.

RelativeTo can also be set to `Enum/ActuatorRelativeTo|Enum.ActuatorRelativeTo.Attachment1`. In this case, the force will be applied in the space local to `Constraint/Attachment1|Attachment1`, regardless of the orientation of Attachment0 or its connected part. If Attachment1 rotates, then the force will change to stay oriented correctly.

Lastly, RelativeTo can also be set to `Enum/ActuatorRelativeTo|Enum.ActuatorRelativeTo.World`. In this mode, the force is applied in world coordinates, regardless of the orientation of Attachment0 or its part.

Properties

 ``` bool``` ``` ApplyAtCenterOfMass ``` When true, applies force at center of mass of Attachment0’s parent Part. When false, applied at Attachment0.
 ``` Vector3``` ``` Force ``` The strength and direction of the force.
 ``` ActuatorRelativeTo``` ``` RelativeTo ``` The CFrame in which the force is expressed.

Inherited from Constraint:

 ``` bool``` ``` Active ``` ``` [ReadOnly] ``` ``` [NotReplicated] ``` Indicates if the constraint is currently active in the world
 ``` Attachment``` ``` Attachment0 ``` The `Attachment` that is connected to `Constraint/Attachment1`
 ``` Attachment``` ``` Attachment1 ``` The `Attachment` that is connected to `Constraint/Attachment0`
 ``` BrickColor``` ``` Color ``` The color of the constraint.
 ``` bool``` ``` Enabled ``` Toggles whether or not this Constraint is enabled.
 ``` bool``` ``` Visible ``` Toggles the visibility of this Constraint.

Inherited from Instance:

 ``` 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 ``` ``` [ReadOnly] ``` ``` [NotReplicated] ``` ``` [Deprecated] ``` The cost of saving the instance using data persistence.
 ``` string``` ``` Name ``` A non-unique identifier of the `Instance`
 ``` Instance``` ``` Parent ``` Determines the hierarchical parent of the `Instance`
 ``` bool``` ``` RobloxLocked ``` If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted
 ``` bool``` ``` archivable ``` ``` [Hidden] ``` ``` [NotReplicated] ``` ``` [Deprecated] ```
 ``` string``` ``` className ``` ``` [ReadOnly] ``` ``` [NotReplicated] ``` ``` [Deprecated] ```

Functions

Inherited from Instance:

 ``` void``` ``` ClearAllChildren ( ) ``` This function destroys all of an `Instance`'s children.
 ``` Instance``` ``` Clone ( ) ``` Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
 ``` 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.
 ``` Variant``` ``` GetAttribute ( string attribute ) ```
 ``` RBXScriptSignal``` ``` GetAttributeChangedSignal ( string attribute ) ```
 ``` Dictionary``` ``` GetAttributes ( ) ```
 ``` Objects``` ``` GetChildren ( ) ``` Returns an array containing all of the `Instance`'s children.
 ``` string``` ``` GetDebugId ( int scopeLength ) ``` ``` [NotBrowsable] ``` Returns a coded string of the `Instance`s 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 ) ```
 ``` 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

Inherited from Instance:

 ``` 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 ) ```
 ``` RBXScriptSignal``` ``` Changed ( string property ) ``` Fired immediately after a property of an object changes.
 ``` RBXScriptSignal``` ``` ChildAdded ( Instance child ) ``` Fires when an object is parented to this `Instance`.
 ``` RBXScriptSignal``` ``` ChildRemoved ( Instance child ) ``` Fires when a child is removed from this `Instance`.
 ``` RBXScriptSignal``` ``` DescendantAdded ( Instance descendant ) ``` Fires when a descendant is added to the `Instance`
 ``` RBXScriptSignal``` ``` DescendantRemoving ( Instance descendant ) ``` Fires immediately before a descendant of the `Instance` is removed.
 ``` RBXScriptSignal``` ``` childAdded ( Instance child ) ``` ``` [Deprecated] ```