Creating a BGE staging branch.
[blender.git] / doc / python_api / rst / bge.events.rst
1
2 Game Keys (bge.events)
3 ======================
4
5 *****
6 Intro
7 *****
8
9 This module holds key constants for the SCA_KeyboardSensor.
10
11 .. module:: bge.events
12
13 .. code-block:: python
14
15         # Set a connected keyboard sensor to accept F1
16         import bge
17         
18         co = bge.logic.getCurrentController()
19         # 'Keyboard' is a keyboard sensor
20         sensor = co.sensors["Keyboard"]
21         sensor.key = bge.events.F1KEY
22
23 .. code-block:: python
24
25         # Do the all keys thing
26         import bge
27         
28         co = bge.logic.getCurrentController()
29         # 'Keyboard' is a keyboard sensor
30         sensor = co.sensors["Keyboard"]
31
32         for key,status in sensor.events:
33                 # key[0] == bge.events.keycode, key[1] = status
34                 if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
35                         if key == bge.events.WKEY:
36                                 # Activate Forward!
37                         if key == bge.events.SKEY:
38                                 # Activate Backward!
39                         if key == bge.events.AKEY:
40                                 # Activate Left!
41                         if key == bge.events.DKEY:
42                                 # Activate Right!
43
44 .. code-block:: python
45
46         # The all keys thing without a keyboard sensor (but you will
47         # need an always sensor with pulse mode on)
48         import bge
49         
50         # Just shortening names here
51         keyboard = bge.logic.keyboard
52         JUST_ACTIVATED = bge.logic.KX_INPUT_JUST_ACTIVATED
53         
54         if keyboard.events[bge.events.WKEY] == JUST_ACTIVATED:
55                 print("Activate Forward!")
56         if keyboard.events[bge.events.SKEY] == JUST_ACTIVATED:
57                 print("Activate Backward!")     
58         if keyboard.events[bge.events.AKEY] == JUST_ACTIVATED:
59                 print("Activate Left!") 
60         if keyboard.events[bge.events.DKEY] == JUST_ACTIVATED:
61                 print("Activate Right!")
62                 
63
64 *********
65 Functions
66 *********
67
68 .. function:: EventToString(event)
69
70    Return the string name of a key event. Will raise a ValueError error if its invalid.
71
72    :arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
73    :type event: int
74    :rtype: string
75    
76 .. function:: EventToCharacter(event, shift)
77
78    Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
79    
80    :type event: int
81    :arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
82    :type shift: bool
83    :arg shift: set to true if shift is held.
84    :rtype: string
85
86 ****************
87 Keys (Constants)
88 ****************
89
90 .. _mouse-keys:
91
92 ==========
93 Mouse Keys
94 ==========
95
96 .. data:: LEFTMOUSE
97 .. data:: MIDDLEMOUSE
98 .. data:: RIGHTMOUSE
99 .. data:: WHEELUPMOUSE
100 .. data:: WHEELDOWNMOUSE
101 .. data:: MOUSEX
102 .. data:: MOUSEY
103
104 .. _keyboard-keys:
105
106 =============
107 Keyboard Keys
108 =============
109
110 -------------
111 Alphabet keys
112 -------------
113
114 .. data:: AKEY
115 .. data:: BKEY
116 .. data:: CKEY
117 .. data:: DKEY
118 .. data:: EKEY
119 .. data:: FKEY
120 .. data:: GKEY
121 .. data:: HKEY
122 .. data:: IKEY
123 .. data:: JKEY
124 .. data:: KKEY
125 .. data:: LKEY
126 .. data:: MKEY
127 .. data:: NKEY
128 .. data:: OKEY
129 .. data:: PKEY
130 .. data:: QKEY
131 .. data:: RKEY
132 .. data:: SKEY
133 .. data:: TKEY
134 .. data:: UKEY
135 .. data:: VKEY
136 .. data:: WKEY
137 .. data:: XKEY
138 .. data:: YKEY
139 .. data:: ZKEY
140
141 -----------
142 Number keys
143 -----------
144
145 .. data:: ZEROKEY
146 .. data:: ONEKEY
147 .. data:: TWOKEY
148 .. data:: THREEKEY
149 .. data:: FOURKEY
150 .. data:: FIVEKEY
151 .. data:: SIXKEY
152 .. data:: SEVENKEY
153 .. data:: EIGHTKEY
154 .. data:: NINEKEY
155
156 --------------
157 Modifiers Keys
158 --------------
159
160 .. data:: CAPSLOCKKEY
161 .. data:: LEFTCTRLKEY
162 .. data:: LEFTALTKEY
163 .. data:: RIGHTALTKEY
164 .. data:: RIGHTCTRLKEY
165 .. data:: RIGHTSHIFTKEY
166 .. data:: LEFTSHIFTKEY
167
168 ----------
169 Arrow Keys
170 ----------
171
172 .. data:: LEFTARROWKEY
173 .. data:: DOWNARROWKEY
174 .. data:: RIGHTARROWKEY
175 .. data:: UPARROWKEY
176
177 --------------
178 Numberpad Keys
179 --------------
180
181 .. data:: PAD0
182 .. data:: PAD1
183 .. data:: PAD2
184 .. data:: PAD3
185 .. data:: PAD4
186 .. data:: PAD5
187 .. data:: PAD6
188 .. data:: PAD7
189 .. data:: PAD8
190 .. data:: PAD9
191 .. data:: PADPERIOD
192 .. data:: PADSLASHKEY
193 .. data:: PADASTERKEY
194 .. data:: PADMINUS
195 .. data:: PADENTER
196 .. data:: PADPLUSKEY
197
198 -------------
199 Function Keys
200 -------------
201
202 .. data:: F1KEY
203 .. data:: F2KEY
204 .. data:: F3KEY
205 .. data:: F4KEY
206 .. data:: F5KEY
207 .. data:: F6KEY
208 .. data:: F7KEY
209 .. data:: F8KEY
210 .. data:: F9KEY
211 .. data:: F10KEY
212 .. data:: F11KEY
213 .. data:: F12KEY
214 .. data:: F13KEY
215 .. data:: F14KEY
216 .. data:: F15KEY
217 .. data:: F16KEY
218 .. data:: F17KEY
219 .. data:: F18KEY
220 .. data:: F19KEY
221
222 ----------
223 Other Keys
224 ----------
225
226 .. data:: ACCENTGRAVEKEY
227 .. data:: BACKSLASHKEY
228 .. data:: BACKSPACEKEY
229 .. data:: COMMAKEY
230 .. data:: DELKEY
231 .. data:: ENDKEY
232 .. data:: EQUALKEY
233 .. data:: ESCKEY
234 .. data:: HOMEKEY
235 .. data:: INSERTKEY
236 .. data:: LEFTBRACKETKEY
237 .. data:: LINEFEEDKEY
238 .. data:: MINUSKEY
239 .. data:: PAGEDOWNKEY
240 .. data:: PAGEUPKEY
241 .. data:: PAUSEKEY
242 .. data:: PERIODKEY
243 .. data:: QUOTEKEY
244 .. data:: RIGHTBRACKETKEY
245 .. data:: RETKEY (Deprecated: use bge.events.ENTERKEY)
246 .. data:: ENTERKEY
247 .. data:: SEMICOLONKEY
248 .. data:: SLASHKEY
249 .. data:: SPACEKEY
250 .. data:: TABKEY