summaryrefslogtreecommitdiff
path: root/doc/python/keyboarddata.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/python/keyboarddata.txt')
-rw-r--r--doc/python/keyboarddata.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/python/keyboarddata.txt b/doc/python/keyboarddata.txt
new file mode 100644
index 00000000..4be55884
--- /dev/null
+++ b/doc/python/keyboarddata.txt
@@ -0,0 +1,35 @@
+KeyboardData
+
+----
+
+This document describes the 'KeyboardData' class, passed to functions bound to
+keyboard events.
+
+----
+
+Attributes
+
+----
+
+keychain
+
+The keychain (in the format that input.Keyboard.bind() expects them) that
+was pressed.
+
+----
+
+state
+
+An integer bitmask of the modifiers pressed down when the key was pressed.
+
+----
+
+keycode
+
+An integer containing the keycode for the key that was pressed.
+
+----
+
+press
+
+True or False for if the event was a key press or a key release