KX_ObjectActuator.KX_ObjectActuator

Module KX_ObjectActuator :: Class KX_ObjectActuator

Class KX_ObjectActuator

SCA_ILogicBrick --+    
                  |    
      SCA_IActuator --+
                      |
                     KX_ObjectActuator

The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement, velocity, or angular velocity to an object.

Method Summary
list [ωx, ωy, ωz, local]	`getAngularVelocity()` Returns the angular velocity applied by the actuator.
list [dx, dy, dz, local]	`getDLoc()` Returns the displacement vector applied by the actuator.
list [dx, dy, dz, local]	`getDRot()` Returns the angular displacement vector applied by the actuator.
list [fx, fy, fz, local]	`getForce()` Returns the force applied by the actuator.
list [vx, vy, vz, local]	`getLinearVelocity()` Returns the linear velocity applied by the actuator.
list [Τx, Τy, Τz, local]	`getTorque()` Returns the torque applied by the actuator.
	`setAngularVelocity(wx, wy, wz, local)` Sets the angular velocity applied by the actuator.
	`setDLoc(dx, dy, dz, local)` Sets the displacement vector applied by the actuator.
	`setDRot(dx, dy, dz, local)` Sets the angular displacement vector applied by the actuator.
	`setForce(fx, fy, fz, local)` Sets the force applied by the actuator.
	`setLinearVelocity(vx, vy, vz, local)` Sets the linear velocity applied by the actuator.
	`setTorque(tx, ty, tz, local)` Sets the torque applied by the actuator.
Inherited from SCA_ILogicBrick
integer	`getExecutePriority()` Gets the execution priority of this logic brick.
`KX_GameObject`	`getOwner()` Gets the game object associated with this logic brick.
	`setExecutePriority(priority)` Sets the priority of this logic brick.

Method Details

getAngularVelocity()

Returns the angular velocity applied by the actuator.

Returns:: A four item list, containing the vector velocity, and whether the velocity is applied in local coordinates (True) or world coordinates (False)
(type=list [ωx, ωy, ωz, local])

getDLoc()

Returns the displacement vector applied by the actuator.

Returns:: A four item list, containing the vector displacement, and whether the displacement is applied in local coordinates (True) or world coordinates (False)
(type=list [dx, dy, dz, local])

getDRot()

Returns the angular displacement vector applied by the actuator.

Returns:: A four item list, containing the angular displacement vector, and whether the displacement is applied in local coordinates (True) or world coordinates (False)
(type=list [dx, dy, dz, local])

getForce()

Returns the force applied by the actuator.

Returns:: A four item list, containing the vector force, and a flag specifying whether the force is local.
(type=list [fx, fy, fz, local])

getLinearVelocity()

Returns the linear velocity applied by the actuator.

Returns:: A four item list, containing the vector velocity, and whether the velocity is applied in local coordinates (True) or world coordinates (False)
(type=list [vx, vy, vz, local])

getTorque()

Returns the torque applied by the actuator.

Returns:: A four item list, containing the vector torque, and a flag specifying whether the torque is applied in local coordinates (True) or world coordinates (False)
(type=list [Τx, Τy, Τz, local])

setAngularVelocity(wx, wy, wz, local)

Sets the angular velocity applied by the actuator.

Parameters:

wx - the x component of the velocity vector.
(type=float)

wy - the z component of the velocity vector.
(type=float)

wz - the z component of the velocity vector.
(type=float)

local - - False: the velocity vector is applied in world coordinates.

True: the velocity vector is applied in local coordinates.

(type=boolean)

setDLoc(dx, dy, dz, local)

Sets the displacement vector applied by the actuator.

Since the displacement is applied every frame, you must adjust the displacement based on the frame rate, or you game experience will depend on the player's computer speed.

Parameters:

dx - the x component of the displacement vector.
(type=float)

dy - the z component of the displacement vector.
(type=float)

dz - the z component of the displacement vector.
(type=float)

local - - False: the displacement vector is applied in world coordinates.

True: the displacement vector is applied in local coordinates.

(type=boolean)

setDRot(dx, dy, dz, local)

Sets the angular displacement vector applied by the actuator.

Since the displacement is applied every frame, you must adjust the displacement based on the frame rate, or you game experience will depend on the player's computer speed.

Parameters:

dx - the x component of the angular displacement vector.
(type=float)

dy - the z component of the angular displacement vector.
(type=float)

dz - the z component of the angular displacement vector.
(type=float)

local - - False: the angular displacement vector is applied in world coordinates.

True: the angular displacement vector is applied in local coordinates.

(type=boolean)

setForce(fx, fy, fz, local)

Sets the force applied by the actuator.

Parameters:

fx - the x component of the force.
(type=float)

fy - the z component of the force.
(type=float)

fz - the z component of the force.
(type=float)

local - - False: the force is applied in world coordinates.

True: the force is applied in local coordinates.

(type=boolean)

setLinearVelocity(vx, vy, vz, local)

Sets the linear velocity applied by the actuator.

Parameters:

vx - the x component of the velocity vector.
(type=float)

vy - the z component of the velocity vector.
(type=float)

vz - the z component of the velocity vector.
(type=float)

local - - False: the velocity vector is applied in world coordinates.

True: the velocity vector is applied in local coordinates.

(type=boolean)

setTorque(tx, ty, tz, local)

Sets the torque applied by the actuator.

Parameters:

tx - the x component of the torque.
(type=float)

ty - the z component of the torque.
(type=float)

tz - the z component of the torque.
(type=float)

local - - False: the torque is applied in world coordinates.

True: the torque is applied in local coordinates.

(type=boolean)

Generated by Epydoc 2.1 on Fri Aug 27 21:08:03 2004

http://epydoc.sf.net