diff options
Diffstat (limited to 'doc/python_api/rst/bge_types/bge.types.SCA_PythonKeyboard.rst')
-rw-r--r-- | doc/python_api/rst/bge_types/bge.types.SCA_PythonKeyboard.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/python_api/rst/bge_types/bge.types.SCA_PythonKeyboard.rst b/doc/python_api/rst/bge_types/bge.types.SCA_PythonKeyboard.rst new file mode 100644 index 00000000000..6cfef2f80f1 --- /dev/null +++ b/doc/python_api/rst/bge_types/bge.types.SCA_PythonKeyboard.rst @@ -0,0 +1,37 @@ +SCA_PythonKeyboard(PyObjectPlus) +================================ + +.. module:: bge.types + +base class --- :class:`PyObjectPlus` + +.. class:: SCA_PythonKeyboard(PyObjectPlus) + + The current keyboard. + + .. attribute:: events + + A dictionary containing the status of each keyboard event or key. (read-only). + + :type: dictionary {:ref:`keycode<keyboard-keys>`::ref:`status<input-status>`, ...} + + .. attribute:: active_events + + A dictionary containing the status of only the active keyboard events or keys. (read-only). + + :type: dictionary {:ref:`keycode<keyboard-keys>`::ref:`status<input-status>`, ...} + + + .. function:: getClipboard() + + Gets the clipboard text. + + :rtype: string + + .. function:: setClipboard(text) + + Sets the clipboard text. + + :arg text: New clipboard text + :type text: string + |