KX_MouseActuator(SCA_IActuator)¶

class KX_MouseActuator(SCA_IActuator)¶

The mouse actuator gives control over the visibility of the mouse cursor and rotates the parent object according to mouse movement.

visible¶

The visibility of the mouse cursor.

use_axis_x¶

Mouse movement along the x axis effects object rotation.

use_axis_y¶

Mouse movement along the y axis effects object rotation.

threshold¶

Amount of movement from the mouse required before rotation is triggered.

The values in the list should be between 0.0 and 0.5.

reset_x¶

Mouse is locked to the center of the screen on the x axis.

reset_y¶

Mouse is locked to the center of the screen on the y axis.

object_axis¶

The object’s 3D axis to rotate with the mouse movement. ([x, y])

local_x¶

Rotation caused by mouse movement along the x axis is local.

local_y¶

Rotation caused by mouse movement along the y axis is local.

sensitivity¶

The amount of rotation caused by mouse movement along the x and y axis.

Negative values invert the rotation.

limit_x¶

The minimum and maximum angle of rotation caused by mouse movement along the x axis in degrees. limit_x[0] is minimum, limit_x[1] is maximum.

limit_y¶

The minimum and maximum angle of rotation caused by mouse movement along the y axis in degrees. limit_y[0] is minimum, limit_y[1] is maximum.

angle¶

The current rotational offset caused by the mouse actuator in degrees.