Merged changes in the trunk up to revision 54421.
[blender.git] / doc / python_api / rst / bge_types / bge.types.SCA_PythonMouse.rst
1 SCA_PythonMouse(PyObjectPlus)
2 =============================
3
4 .. module:: bge.types
5
6 base class --- :class:`PyObjectPlus`
7
8 .. class:: SCA_PythonMouse(PyObjectPlus)
9
10    The current mouse.
11
12    .. attribute:: events
13
14       a dictionary containing the status of each mouse event. (read-only).
15
16       :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...}
17
18    .. attribute:: active_events
19
20       a dictionary containing the status of only the active mouse events. (read-only).
21
22       :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...}
23       
24    .. attribute:: position
25
26       The normalized x and y position of the mouse cursor.
27
28       :type: list [x, y]
29
30    .. attribute:: visible
31
32       The visibility of the mouse cursor.
33       
34       :type: boolean
35