diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst')
-rw-r--r-- | doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst b/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst new file mode 100644 index 00000000000..b1c6e5d1487 --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.SCA_PythonMouse.rst @@ -0,0 +1,35 @@ +SCA_PythonMouse(PyObjectPlus) +============================= + +.. module:: bge.types + +base class --- :class:`PyObjectPlus` + +.. class:: SCA_PythonMouse(PyObjectPlus) + + The current mouse. + + .. attribute:: events + + a dictionary containing the status of each mouse event. (read-only). + + :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...} + + .. attribute:: active_events + + a dictionary containing the status of only the active mouse events. (read-only). + + :type: dictionary {:ref:`keycode<mouse-keys>`::ref:`status<input-status>`, ...} + + .. attribute:: position + + The normalized x and y position of the mouse cursor. + + :type: list [x, y] + + .. attribute:: visible + + The visibility of the mouse cursor. + + :type: boolean + |