~diresu/blender/blender-command-port

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/GameKeys.py

  • Committer: Dietrich Bollmann
  • Date: 2009-04-26 06:25:14 UTC
  • mfrom: (184.1.520)
  • Revision ID: diresu@web.de-20090426062514-ly27wepl1t5d7p8s
Update to state of blender repository from 2009-04-26 revision 19927.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# $Id: GameKeys.py 19623 2009-04-09 16:00:45Z campbellbarton $
 
1
# $Id: GameKeys.py 19920 2009-04-24 20:27:04Z campbellbarton $
2
2
"""
3
3
Documentation for the GameKeys module.
4
4
======================================
5
5
 
6
6
This module holds key constants for the SCA_KeyboardSensor.
7
7
 
8
 
Alphabet keys
9
 
-------------
10
 
        - AKEY
11
 
        - BKEY
12
 
        - CKEY
13
 
        - DKEY
14
 
        - EKEY
15
 
        - FKEY
16
 
        - GKEY
17
 
        - HKEY
18
 
        - IKEY
19
 
        - JKEY
20
 
        - KKEY
21
 
        - LKEY
22
 
        - MKEY
23
 
        - NKEY
24
 
        - OKEY
25
 
        - PKEY
26
 
        - QKEY
27
 
        - RKEY
28
 
        - SKEY
29
 
        - TKEY
30
 
        - UKEY
31
 
        - VKEY
32
 
        - WKEY
33
 
        - XKEY
34
 
        - YKEY
35
 
        - ZKEY
36
 
 
37
 
Number keys
38
 
-----------
39
 
        - ZEROKEY
40
 
        - ONEKEY
41
 
        - TWOKEY
42
 
        - THREEKEY
43
 
        - FOURKEY
44
 
        - FIVEKEY
45
 
        - SIXKEY
46
 
        - SEVENKEY
47
 
        - EIGHTKEY
48
 
        - NINEKEY
49
 
 
50
 
Shift Modifiers
51
 
---------------
52
 
        - CAPSLOCKKEY
53
 
 
54
 
        - LEFTCTRLKEY
55
 
        - LEFTALTKEY
56
 
        - RIGHTALTKEY
57
 
        - RIGHTCTRLKEY
58
 
        - RIGHTSHIFTKEY
59
 
        - LEFTSHIFTKEY
60
 
 
61
 
Arrow Keys
62
 
----------
63
 
        - LEFTARROWKEY
64
 
        - DOWNARROWKEY
65
 
        - RIGHTARROWKEY
66
 
        - UPARROWKEY
67
 
 
68
 
Numberpad Keys
69
 
--------------
70
 
        - PAD0
71
 
        - PAD1
72
 
        - PAD2
73
 
        - PAD3
74
 
        - PAD4
75
 
        - PAD5
76
 
        - PAD6
77
 
        - PAD7
78
 
        - PAD8
79
 
        - PAD9
80
 
        - PADPERIOD
81
 
        - PADSLASHKEY
82
 
        - PADASTERKEY
83
 
        - PADMINUS
84
 
        - PADENTER
85
 
        - PADPLUSKEY
86
 
 
87
 
Function Keys
88
 
-------------
89
 
        - F1KEY
90
 
        - F2KEY
91
 
        - F3KEY
92
 
        - F4KEY
93
 
        - F5KEY
94
 
        - F6KEY
95
 
        - F7KEY
96
 
        - F8KEY
97
 
        - F9KEY
98
 
        - F10KEY
99
 
        - F11KEY
100
 
        - F12KEY
101
 
 
102
 
Other Keys
103
 
----------
104
 
        - ACCENTGRAVEKEY
105
 
        - BACKSLASHKEY
106
 
        - BACKSPACEKEY
107
 
        - COMMAKEY
108
 
        - DELKEY
109
 
        - ENDKEY
110
 
        - EQUALKEY
111
 
        - ESCKEY
112
 
        - HOMEKEY
113
 
        - INSERTKEY
114
 
        - LEFTBRACKETKEY
115
 
        - LINEFEEDKEY
116
 
        - MINUSKEY
117
 
        - PAGEDOWNKEY
118
 
        - PAGEUPKEY
119
 
        - PAUSEKEY
120
 
        - PERIODKEY
121
 
        - QUOTEKEY
122
 
        - RIGHTBRACKETKEY
123
 
        - RETKEY
124
 
        - SEMICOLONKEY
125
 
        - SLASHKEY
126
 
        - SPACEKEY
127
 
        - TABKEY
128
8
 
129
9
Example::
130
10
        # Set a connected keyboard sensor to accept F1
156
36
                                # Activate Left!
157
37
                        if key[0] == GameKeys.DKEY:
158
38
                                # Activate Right!
159
 
                
 
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
 
160
153
"""
161
154
 
162
155
def EventToString(event):
174
167
        
175
168
        @type event: int
176
169
        @param event: key event from GameKeys or the keyboard sensor.
177
 
        @type event: bool
178
 
        @param event: set to true if shift is held.
 
170
        @type shift: bool
 
171
        @param shift: set to true if shift is held.
179
172
        @rtype: string
180
173
        """
181
174