Game Python Reference Manual.
[blender.git] / source / gameengine / PyDoc / SCA_KeyboardSensor.py
1 # Documentation for SCA_KeyboardSensor
2 from SCA_ISensor import *
3
4 class SCA_KeyboardSensor(SCA_ISensor):
5         """
6         A keyboard sensor detects player key presses.
7         
8         See module GameKeys for keycode values.
9         """
10         
11         def getKey():
12                 """
13                 Returns the key code this sensor is looking for.
14                 """
15         
16         def setKey(keycode):
17                 """
18                 Set the key this sensor should listen for.
19                 
20                 @type keycode: keycode from GameKeys module
21                 """
22         
23         def getHold1():
24                 """
25                 Returns the key code for the first modifier this sensor is looking for.
26                 """
27         
28         def setHold1():
29                 """
30                 Sets the key code for the first modifier this sensor should look for.
31                 """
32         
33         def getHold2():
34                 """
35                 Returns the key code for the second modifier this sensor is looking for.
36                 """
37         
38         def setHold2():
39                 """
40                 Sets the key code for the second modifier this sensor should look for.
41                 """
42         
43         def getPressedKeys():
44                 """
45                 Get a list of keys that have either been pressed, or just released this frame.
46                 
47                 @rtype: list of key status. [[keycode, status]]
48                 """
49         
50         def getCurrentlyPressedKeys():
51                 """
52                 Get a list of currently pressed keys that have either been pressed, or just released
53                 
54                 @rtype: list of key status. [[keycode, status]]
55                 """
56         
57