2 Game Engine bge.events module
3 =============================
9 This module holds key constants for the SCA_KeyboardSensor.
11 .. module:: bge.events
13 .. code-block:: python
15 # Set a connected keyboard sensor to accept F1
18 co = bge.logic.getCurrentController()
19 # 'Keyboard' is a keyboard sensor
20 sensor = co.sensors["Keyboard"]
21 sensor.key = bge.keys.F1KEY
23 .. code-block:: python
25 # Do the all keys thing
28 co = bge.logic.getCurrentController()
29 # 'Keyboard' is a keyboard sensor
30 sensor = co.sensors["Keyboard"]
32 for key,status in sensor.events:
33 # key[0] == bge.keys.keycode, key[1] = status
34 if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
35 if key == bge.keys.WKEY:
37 if key == bge.keys.SKEY:
39 if key == bge.keys.AKEY:
41 if key == bge.keys.DKEY:
48 .. function:: EventToString(event)
50 Return the string name of a key event. Will raise a ValueError error if its invalid.
52 :arg event: key event from bge.keys or the keyboard sensor.
56 .. function:: EventToCharacter(event, shift)
58 Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
61 :arg event: key event from :mod:`bge.keys` or the keyboard sensor.
63 :arg shift: set to true if shift is held.
79 .. data:: WHEELUPMOUSE
80 .. data:: WHEELDOWNMOUSE
138 .. data:: CAPSLOCKKEY
139 .. data:: LEFTCTRLKEY
141 .. data:: RIGHTALTKEY
142 .. data:: RIGHTCTRLKEY
143 .. data:: RIGHTSHIFTKEY
144 .. data:: LEFTSHIFTKEY
150 .. data:: LEFTARROWKEY
151 .. data:: DOWNARROWKEY
152 .. data:: RIGHTARROWKEY
170 .. data:: PADSLASHKEY
171 .. data:: PADASTERKEY
204 .. data:: ACCENTGRAVEKEY
205 .. data:: BACKSLASHKEY
206 .. data:: BACKSPACEKEY
214 .. data:: LEFTBRACKETKEY
215 .. data:: LINEFEEDKEY
217 .. data:: PAGEDOWNKEY
222 .. data:: RIGHTBRACKETKEY
224 .. data:: SEMICOLONKEY