ApplyEntityForce

ApplyEntityForce()

Syntax

ApplyEntityForce(#Entity, x, y, z [, PositionX, PositionY, PositionZ [, Mode [, PositionMode]]])

Description

Apply the specified force to the entity. The new force value replace any previous force previously applied to the entity.

Parameters

#Entity The entity to use.

x, y, z The force values.

PositionX, PositionY, PositionZ (optional) The position relative to the entity center where the force should be applied.
Mode (optional)
The applied force mode. It can be one of the following values:
  #PB_Local : local force.
  #PB_Parent: force relative to the parent position.
  #PB_World : force relative to the world.
PositionMode (optional)
The applied position mode. It can be one of the following values:
  #PB_Local : local position.
  #PB_Parent: position relative to the parent position.
  #PB_World : position relative to the world.

Return value

None.

See Also

ApplyEntityImpulse(), ApplyEntityTorque(), ApplyEntityTorqueImpulse()

Supported OS

All

<- AddSubEntity() - Entity Index - ApplyEntityImpulse() ->

#Entity	The entity to use.
x, y, z	The force values.
PositionX, PositionY, PositionZ (optional)	The position relative to the entity center where the force should be applied.
Mode (optional)	The applied force mode. It can be one of the following values: #PB_Local : local force. #PB_Parent: force relative to the parent position. #PB_World : force relative to the world.
PositionMode (optional)	The applied position mode. It can be one of the following values: #PB_Local : local position. #PB_Parent: position relative to the parent position. #PB_World : position relative to the world.