addForce: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |= Game " to " ")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command
|arma3
 
|1.72
|game1= arma3
 
|version1= 1.72
 
|arg= global
|arg= global
|eff= global
|eff= global


|gr1= Object Manipulation
|gr1= Object Manipulation


| Applies force to given object at given position. Force is defined as vector [x, y, z] in world space, position is vector [x, y, z] in model space. If you need to define force in model space, use [[vectorModelToWorld]] or [[vectorModelToWorldVisual]] commands first. The force applied as impulse. For more information see [http://docs.nvidia.com/gameworks/content/gameworkslibrary/physx/apireference/files/classPxRigidBody.html#a22b0a1ef0b6c5656a6063c5c38f5679c NVIDIA docs]
|descr= Applies force to given object at given position. Force is defined as vector [x, y, z] in world space, position is vector [x, y, z] in model space. If you need to define force in model space, use [[vectorModelToWorld]] or [[vectorModelToWorldVisual]] commands first. The force applied as impulse. For more information see [http://docs.nvidia.com/gameworks/content/gameworkslibrary/physx/apireference/files/classPxRigidBody.html#a22b0a1ef0b6c5656a6063c5c38f5679c NVIDIA docs]
{{Feature|Informative|Since Arma 3 v2.03.147267 this command can be used on units. It will send the unit into unconscious ragdoll state, similar to how [[setUnconscious]] does it (see example 3). In multiplayer, the unit has to be [[local]] {{Icon|localArgument|32}} on the computer that executed command. }}
{{Feature|Informative|Since Arma 3 v2.04 this command can be used on units. It will send the unit into unconscious ragdoll state, similar to how [[setUnconscious]] does it (see example 3). In multiplayer, the unit has to be [[local]] {{Icon|localArgument|32}} on the computer that executed command. }}
| object '''addForce''' [force, position]
 
|s1= object '''addForce''' [force, position]
 
|p1= object: [[Object]] - PhysX object
|p1= object: [[Object]] - PhysX object
|p2= [force, position]: [[Array]]
 
|p3= force: [[Array]] - force vector (in world space) in format [x,y,z]
|p2= force: [[Array]] - Force vector (in world space) in format [x,y,z]
|p4= position: [[Array]] - model [[PositionRelative]] to which force is applied in format [x,y,z]
 
|p5=
|p4= position: [[Array]] - Model [[PositionRelative]] to which force is applied in format [x,y,z]
|p6=
 
| [[Nothing]]
|r1= [[Nothing]]
 
|x1= Apply force [0,1000,0] defined in world space (not factoring object actual positioning) to object position [1,0,0]:
|x1= Apply force [0,1000,0] defined in world space (not factoring object actual positioning) to object position [1,0,0]:
<code>_object [[addForce]] [[0,1000,0],[1,0,0]];</code>
<code>_object [[addForce]] [[0,1000,0],[1,0,0]];</code>
|x2= Apply force [0,1000,0] defined in model space (relative to object) to object position [1,0,0]:
|x2= Apply force [0,1000,0] defined in model space (relative to object) to object position [1,0,0]:
<code>_object [[addForce]] [_object [[vectorModelToWorld]] [0,1000,0],[1,0,0]];</code>
<code>_object [[addForce]] [_object [[vectorModelToWorld]] [0,1000,0],[1,0,0]];</code>
|x3= Since Arma 3 v2.03.147267, can be used on units: <code>[] [[spawn]]  
|x3= Since Arma 3 v2.03.147267, can be used on units: <code>[] [[spawn]]  
{
{
Line 30: Line 39:
|seealso= [[addTorque]], [[vectorModelToWorld]], [[vectorModelToWorldVisual]]
|seealso= [[addTorque]], [[vectorModelToWorld]], [[vectorModelToWorldVisual]]
}}
}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 15:22, 27 April 2021

Hover & click on the images for description

Description

Description:
Applies force to given object at given position. Force is defined as vector [x, y, z] in world space, position is vector [x, y, z] in model space. If you need to define force in model space, use vectorModelToWorld or vectorModelToWorldVisual commands first. The force applied as impulse. For more information see NVIDIA docs
Since Arma 3 v2.04 this command can be used on units. It will send the unit into unconscious ragdoll state, similar to how setUnconscious does it (see example 3). In multiplayer, the unit has to be local LALocal on the computer that executed command.
Groups:
Object Manipulation

Syntax

Syntax:
object addForce [force, position]
Parameters:
object: Object - PhysX object
force: Array - Force vector (in world space) in format [x,y,z]
position: Array - Model PositionRelative to which force is applied in format [x,y,z]
Return Value:
Nothing

Examples

Example 1:
Apply force [0,1000,0] defined in world space (not factoring object actual positioning) to object position [1,0,0]: _object addForce [[0,1000,0],[1,0,0]];
Example 2:
Apply force [0,1000,0] defined in model space (relative to object) to object position [1,0,0]: _object addForce [_object vectorModelToWorld [0,1000,0],[1,0,0]];
Example 3:
Since Arma 3 v2.03.147267, can be used on units: [] spawn { bob addForce [bob vectorModelToWorld [0,-200,0], bob selectionPosition "rightfoot"]; sleep 5; bob setUnconscious false; };

Additional Information

See also:
addTorquevectorModelToWorldvectorModelToWorldVisual

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note