blob: 8abb1fda762754df5173b6d58f950424dd406e11 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# $Id$
# Documentation for SCA_KeyboardSensor
from SCA_ISensor import *
class SCA_KeyboardSensor(SCA_ISensor):
"""
A keyboard sensor detects player key presses.
See module L{GameKeys} for keycode values.
@ivar key: The key code this sensor is looking for.
@type key: keycode from L{GameKeys} module
@ivar hold1: The key code for the first modifier this sensor is looking for.
@type hold1: keycode from L{GameKeys} module
@ivar hold2: The key code for the second modifier this sensor is looking for.
@type hold2: keycode from L{GameKeys} module
@ivar toggleProperty: The name of the property that indicates whether or not to log keystrokes as a string.
@type toggleProperty: string
@ivar targetProperty: The name of the property that receives keystrokes in case in case a string is logged.
@type targetProperty: string
@ivar useAllKeys: Flag to determine whether or not to accept all keys.
@type useAllKeys: boolean
@ivar events: a list of pressed keys that have either been pressed, or just released, or are active this frame. (read only).
- 'keycode' matches the values in L{GameKeys}.
- 'status' uses...
- L{GameLogic.KX_INPUT_NONE}
- L{GameLogic.KX_INPUT_JUST_ACTIVATED}
- L{GameLogic.KX_INPUT_ACTIVE}
- L{GameLogic.KX_INPUT_JUST_RELEASED}
@type events: list [[keycode, status], ...]
"""
def getKeyStatus(keycode):
"""
Get the status of a key.
@rtype: key state L{GameLogic} members (KX_INPUT_NONE, KX_INPUT_JUST_ACTIVATED, KX_INPUT_ACTIVE, KX_INPUT_JUST_RELEASED)
@return: The state of the given key
@type keycode: integer
@param keycode: The code that represents the key you want to get the state of
"""
#--The following methods are DEPRECATED--
def getKey():
"""
Returns the key code this sensor is looking for.
B{DEPRECATED: Use the "key" property instead}.
@rtype: keycode from L{GameKeys} module
"""
def setKey(keycode):
"""
Set the key this sensor should listen for.
B{DEPRECATED: Use the "key" property instead}.
@type keycode: keycode from L{GameKeys} module
"""
def getHold1():
"""
Returns the key code for the first modifier this sensor is looking for.
B{DEPRECATED: Use the "hold1" property instead}.
@rtype: keycode from L{GameKeys} module
"""
def setHold1(keycode):
"""
Sets the key code for the first modifier this sensor should look for.
B{DEPRECATED: Use the "hold1" property instead}.
@type keycode: keycode from L{GameKeys} module
"""
def getHold2():
"""
Returns the key code for the second modifier this sensor is looking for.
B{DEPRECATED: Use the "hold2" property instead}.
@rtype: keycode from L{GameKeys} module
"""
def setHold2(keycode):
"""
Sets the key code for the second modifier this sensor should look for.
B{DEPRECATED: Use the "hold2" property instead.}
@type keycode: keycode from L{GameKeys} module
"""
def getPressedKeys():
"""
Get a list of keys that have either been pressed, or just released this frame.
B{DEPRECATED: Use "events" instead.}
@rtype: list of key status. [[keycode, status]]
"""
def getCurrentlyPressedKeys():
"""
Get a list of currently pressed keys that have either been pressed, or just released
B{DEPRECATED: Use "events" instead.}
@rtype: list of key status. [[keycode, status]]
"""
|
