486844f97bf45cd4ae840a8ada65db7d73a84a24
[blender.git] / source / gameengine / PyDoc / bge.events.rst
1
2 Game Engine bge.events module
3 =============================
4
5 This module holds key constants for the SCA_KeyboardSensor.
6
7 .. module:: bge.events
8
9 .. code-block:: python
10
11         # Set a connected keyboard sensor to accept F1
12         import bge
13         
14         co = bge.logic.getCurrentController()
15         # 'Keyboard' is a keyboard sensor
16         sensor = co.sensors["Keyboard"]
17         sensor.key = bge.keys.F1KEY
18
19 .. code-block:: python
20
21         # Do the all keys thing
22         import bge
23         
24         co = bge.logic.getCurrentController()
25         # 'Keyboard' is a keyboard sensor
26         sensor = co.sensors["Keyboard"]
27
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:
32                                 # Activate Forward!
33                         if key == bge.keys.SKEY:
34                                 # Activate Backward!
35                         if key == bge.keys.AKEY:
36                                 # Activate Left!
37                         if key == bge.keys.DKEY:
38                                 # Activate Right!
39
40 .. function:: EventToString(event)
41
42    Return the string name of a key event. Will raise a ValueError error if its invalid.
43
44    :arg event: key event from bge.keys or the keyboard sensor.
45    :type event: int
46    :rtype: string
47    
48 .. function:: EventToCharacter(event, shift)
49
50    Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
51    
52    :type event: int
53    :arg event: key event from :mod:`bge.keys` or the keyboard sensor.
54    :type shift: bool
55    :arg shift: set to true if shift is held.
56    :rtype: string
57
58
59 **Alphabet keys**
60
61 .. data:: AKEY
62 .. data:: BKEY
63 .. data:: CKEY
64 .. data:: DKEY
65 .. data:: EKEY
66 .. data:: FKEY
67 .. data:: GKEY
68 .. data:: HKEY
69 .. data:: IKEY
70 .. data:: JKEY
71 .. data:: KKEY
72 .. data:: LKEY
73 .. data:: MKEY
74 .. data:: NKEY
75 .. data:: OKEY
76 .. data:: PKEY
77 .. data:: QKEY
78 .. data:: RKEY
79 .. data:: SKEY
80 .. data:: TKEY
81 .. data:: UKEY
82 .. data:: VKEY
83 .. data:: WKEY
84 .. data:: XKEY
85 .. data:: YKEY
86 .. data:: ZKEY
87
88 **Number keys**
89
90 .. data:: ZEROKEY
91 .. data:: ONEKEY
92 .. data:: TWOKEY
93 .. data:: THREEKEY
94 .. data:: FOURKEY
95 .. data:: FIVEKEY
96 .. data:: SIXKEY
97 .. data:: SEVENKEY
98 .. data:: EIGHTKEY
99 .. data:: NINEKEY
100
101 **Modifiers**
102
103 .. data:: CAPSLOCKKEY
104 .. data:: LEFTCTRLKEY
105 .. data:: LEFTALTKEY
106 .. data:: RIGHTALTKEY
107 .. data:: RIGHTCTRLKEY
108 .. data:: RIGHTSHIFTKEY
109 .. data:: LEFTSHIFTKEY
110
111 **Arrow Keys**
112
113 .. data:: LEFTARROWKEY
114 .. data:: DOWNARROWKEY
115 .. data:: RIGHTARROWKEY
116 .. data:: UPARROWKEY
117
118 **Numberpad Keys**
119
120 .. data:: PAD0
121 .. data:: PAD1
122 .. data:: PAD2
123 .. data:: PAD3
124 .. data:: PAD4
125 .. data:: PAD5
126 .. data:: PAD6
127 .. data:: PAD7
128 .. data:: PAD8
129 .. data:: PAD9
130 .. data:: PADPERIOD
131 .. data:: PADSLASHKEY
132 .. data:: PADASTERKEY
133 .. data:: PADMINUS
134 .. data:: PADENTER
135 .. data:: PADPLUSKEY
136
137 **Function Keys**
138
139 .. data:: F1KEY
140 .. data:: F2KEY
141 .. data:: F3KEY
142 .. data:: F4KEY
143 .. data:: F5KEY
144 .. data:: F6KEY
145 .. data:: F7KEY
146 .. data:: F8KEY
147 .. data:: F9KEY
148 .. data:: F10KEY
149 .. data:: F11KEY
150 .. data:: F12KEY
151 .. data:: F13KEY
152 .. data:: F14KEY
153 .. data:: F15KEY
154 .. data:: F16KEY
155 .. data:: F17KEY
156 .. data:: F18KEY
157 .. data:: F19KEY
158
159 **Other Keys**
160
161 .. data:: ACCENTGRAVEKEY
162 .. data:: BACKSLASHKEY
163 .. data:: BACKSPACEKEY
164 .. data:: COMMAKEY
165 .. data:: DELKEY
166 .. data:: ENDKEY
167 .. data:: EQUALKEY
168 .. data:: ESCKEY
169 .. data:: HOMEKEY
170 .. data:: INSERTKEY
171 .. data:: LEFTBRACKETKEY
172 .. data:: LINEFEEDKEY
173 .. data:: MINUSKEY
174 .. data:: PAGEDOWNKEY
175 .. data:: PAGEUPKEY
176 .. data:: PAUSEKEY
177 .. data:: PERIODKEY
178 .. data:: QUOTEKEY
179 .. data:: RIGHTBRACKETKEY
180 .. data:: RETKEY
181 .. data:: SEMICOLONKEY
182 .. data:: SLASHKEY
183 .. data:: SPACEKEY
184 .. data:: TABKEY
185
186 **Mouse Events**
187
188 .. data:: LEFTMOUSE
189 .. data:: MIDDLEMOUSE
190 .. data:: RIGHTMOUSE
191 .. data:: WHEELUPMOUSE
192 .. data:: WHEELDOWNMOUSE
193 .. data:: MOUSEX
194 .. data:: MOUSEY