Difference between revisions of "R3d.Body:applyLocalForceAtLocalPosition"

From GiderosMobile
(Created page with "'''Available since:''' Gideros 2019.10<br/> '''Class:''' R3d.Body<br/> === Description === Applies a force to the body. <syntaxhighlight lang="lua"> r3d.Body:applyLocalFo...")
 
 
Line 3: Line 3:
  
 
=== Description ===
 
=== Description ===
Applies a force to the body.
+
Applies a force to any given point in local-space.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
r3d.Body:applyLocalForceAtLocalPosition(forceX,forceY,forceZ[,pointX,pointY,pointZ])
 
r3d.Body:applyLocalForceAtLocalPosition(forceX,forceY,forceZ[,pointX,pointY,pointZ])
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
If the point is not the center of mass of the body, applying a force will generate some torque and therefore, the angular motion of the body will be affected as well.
  
 
=== Parameters ===
 
=== Parameters ===
'''forceX''': (number) applies a force on the X axis<br/>
+
'''forceX''': (number) applies a force in Newton on the X axis<br/>
'''forceY''': (number) applies a force on the Y axis<br/>
+
'''forceY''': (number) applies a force in Newton on the Y axis<br/>
'''forceZ''': (number) applies a force on the Z axis<br/>
+
'''forceZ''': (number) applies a force in Newton on the Z axis<br/>
 
'''pointX''': (number) offsets the point of the force on the X axis ('''optional''' default is 0)<br/>
 
'''pointX''': (number) offsets the point of the force on the X axis ('''optional''' default is 0)<br/>
 
'''pointY''': (number) offsets the point of the force on the Y axis ('''optional''' default is 0)<br/>
 
'''pointY''': (number) offsets the point of the force on the Y axis ('''optional''' default is 0)<br/>

Latest revision as of 14:25, 16 December 2025

Available since: Gideros 2019.10
Class: R3d.Body

Description

Applies a force to any given point in local-space.

r3d.Body:applyLocalForceAtLocalPosition(forceX,forceY,forceZ[,pointX,pointY,pointZ])

If the point is not the center of mass of the body, applying a force will generate some torque and therefore, the angular motion of the body will be affected as well.

Parameters

forceX: (number) applies a force in Newton on the X axis
forceY: (number) applies a force in Newton on the Y axis
forceZ: (number) applies a force in Newton on the Z axis
pointX: (number) offsets the point of the force on the X axis (optional default is 0)
pointY: (number) offsets the point of the force on the Y axis (optional default is 0)
pointZ: (number) offsets the point of the force on the Z axis (optional default is 0)

Example

if isup then ship.body:applyLocalForceAtLocalPosition(0, 0, 64) end