Pydoc: Fix multiple bpy.type modules
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_MouseActuator.rst
1 KX_MouseActuator(SCA_IActuator)
2 ====================================
3
4 base class --- :class:`SCA_IActuator`
5
6 .. class:: KX_MouseActuator(SCA_IActuator)
7
8    The mouse actuator gives control over the visibility of the mouse cursor and rotates the parent object according to mouse movement.
9
10    .. method:: reset()
11
12       Undoes the rotation caused by the mouse actuator.
13
14    .. attribute:: visible
15
16       The visibility of the mouse cursor.
17
18       :type: boolean
19
20    .. attribute:: use_axis_x
21
22       Mouse movement along the x axis effects object rotation.
23
24       :type: boolean
25
26    .. attribute:: use_axis_y
27
28       Mouse movement along the y axis effects object rotation.
29
30       :type: boolean
31
32    .. attribute:: threshold
33
34       Amount of movement from the mouse required before rotation is triggered.
35
36       :type: list (vector of 2 floats)
37
38       The values in the list should be between 0.0 and 0.5.
39
40    .. attribute:: reset_x
41
42       Mouse is locked to the center of the screen on the x axis.
43
44       :type: boolean
45
46    .. attribute:: reset_y
47
48       Mouse is locked to the center of the screen on the y axis.
49
50       :type: boolean
51
52    .. attribute:: object_axis
53
54       The object's 3D axis to rotate with the mouse movement. ([x, y])
55
56       :type: list (vector of 2 integers from 0 to 2)
57
58       * KX_ACT_MOUSE_OBJECT_AXIS_X
59       * KX_ACT_MOUSE_OBJECT_AXIS_Y
60       * KX_ACT_MOUSE_OBJECT_AXIS_Z
61
62    .. attribute:: local_x
63
64       Rotation caused by mouse movement along the x axis is local.
65
66       :type: boolean
67
68    .. attribute:: local_y
69
70       Rotation caused by mouse movement along the y axis is local.
71
72       :type: boolean
73
74    .. attribute:: sensitivity
75
76       The amount of rotation caused by mouse movement along the x and y axis.
77
78       :type: list (vector of 2 floats)
79
80       Negative values invert the rotation.
81
82    .. attribute:: limit_x
83
84       The minimum and maximum angle of rotation caused by mouse movement along the x axis in degrees.
85       limit_x[0] is minimum, limit_x[1] is maximum.
86
87       :type: list (vector of 2 floats)
88
89    .. attribute:: limit_y
90
91       The minimum and maximum angle of rotation caused by mouse movement along the y axis in degrees.
92       limit_y[0] is minimum, limit_y[1] is maximum.
93
94       :type: list (vector of 2 floats)
95
96    .. attribute:: angle
97
98       The current rotational offset caused by the mouse actuator in degrees.
99
100       :type: list (vector of 2 floats)