Differential D1006 Diff 3191 doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst

Changeset View

Standalone View

doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst

Show All 9 Lines	.. class:: KX_ObjectActuator(SCA_IActuator)
The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement,		The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement,
velocity, or angular velocity to an object.		velocity, or angular velocity to an object.
Servo control allows to regulate force to achieve a certain speed target.		Servo control allows to regulate force to achieve a certain speed target.

.. attribute:: force		.. attribute:: force

The force applied by the actuator.		The force applied by the actuator.

:type: list [x, y, z]		:type: Vector((x, y, z))

.. attribute:: useLocalForce		.. attribute:: useLocalForce

A flag specifying if the force is local.		A flag specifying if the force is local.

:type: boolean		:type: boolean

.. attribute:: torque		.. attribute:: torque

The torque applied by the actuator.		The torque applied by the actuator.

:type: list [x, y, z]		:type: Vector((x, y, z))

.. attribute:: useLocalTorque		.. attribute:: useLocalTorque

A flag specifying if the torque is local.		A flag specifying if the torque is local.

:type: boolean		:type: boolean

.. attribute:: dLoc		.. attribute:: dLoc

The displacement vector applied by the actuator.		The displacement vector applied by the actuator.

:type: list [x, y, z]		:type: Vector((x, y, z))

.. attribute:: useLocalDLoc		.. attribute:: useLocalDLoc

A flag specifying if the dLoc is local.		A flag specifying if the dLoc is local.

:type: boolean		:type: boolean

.. attribute:: dRot		.. attribute:: dRot

The angular displacement vector applied by the actuator		The angular displacement vector applied by the actuator

:type: list [x, y, z]		:type: Vector((x, y, z))

.. note::		.. note::

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.		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.

.. attribute:: useLocalDRot		.. attribute:: useLocalDRot

A flag specifying if the dRot is local.		A flag specifying if the dRot is local.

:type: boolean		:type: boolean

.. attribute:: linV		.. attribute:: linV

The linear velocity applied by the actuator.		The linear velocity applied by the actuator.

:type: list [x, y, z]		:type: Vector((x, y, z))

.. attribute:: useLocalLinV		.. attribute:: useLocalLinV

A flag specifying if the linear velocity is local.		A flag specifying if the linear velocity is local.

:type: boolean		:type: boolean

.. note::		.. note::

This is the target speed for servo controllers.		This is the target speed for servo controllers.

.. attribute:: angV		.. attribute:: angV

The angular velocity applied by the actuator.		The angular velocity applied by the actuator.

:type: list [x, y, z]		:type: Vector((x, y, z))

.. attribute:: useLocalAngV		.. attribute:: useLocalAngV

A flag specifying if the angular velocity is local.		A flag specifying if the angular velocity is local.

:type: boolean		:type: boolean

.. attribute:: damping		.. attribute:: damping
Show All 35 Lines