2 Game Engine bge.events module
3 =============================
5 This module holds key constants for the SCA_KeyboardSensor.
11 # Set a connected keyboard sensor to accept F1
14 co = bge.logic.getCurrentController()
15 # 'Keyboard' is a keyboard sensor
16 sensor = co.sensors["Keyboard"]
17 sensor.key = bge.keys.F1KEY
19 .. code-block:: python
21 # Do the all keys thing
24 co = bge.logic.getCurrentController()
25 # 'Keyboard' is a keyboard sensor
26 sensor = co.sensors["Keyboard"]
28 for key,status in sensor.events:
29 # key[0] == bge.keys.keycode, key[1] = status
30 if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
31 if key == bge.keys.WKEY:
33 if key == bge.keys.SKEY:
35 if key == bge.keys.AKEY:
37 if key == bge.keys.DKEY:
40 .. function:: EventToString(event)
42 Return the string name of a key event. Will raise a ValueError error if its invalid.
44 :arg event: key event from bge.keys or the keyboard sensor.
48 .. function:: EventToCharacter(event, shift)
50 Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
53 :arg event: key event from :mod:`bge.keys` or the keyboard sensor.
55 :arg shift: set to true if shift is held.
103 .. data:: CAPSLOCKKEY
104 .. data:: LEFTCTRLKEY
106 .. data:: RIGHTALTKEY
107 .. data:: RIGHTCTRLKEY
108 .. data:: RIGHTSHIFTKEY
109 .. data:: LEFTSHIFTKEY
113 .. data:: LEFTARROWKEY
114 .. data:: DOWNARROWKEY
115 .. data:: RIGHTARROWKEY
131 .. data:: PADSLASHKEY
132 .. data:: PADASTERKEY
161 .. data:: ACCENTGRAVEKEY
162 .. data:: BACKSLASHKEY
163 .. data:: BACKSPACEKEY
171 .. data:: LEFTBRACKETKEY
172 .. data:: LINEFEEDKEY
174 .. data:: PAGEDOWNKEY
179 .. data:: RIGHTBRACKETKEY
181 .. data:: SEMICOLONKEY
189 .. data:: MIDDLEMOUSE
191 .. data:: WHEELUPMOUSE
192 .. data:: WHEELDOWNMOUSE