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