source/gameengine/PyDoc/bge.events.rst

   1
   2 Game Engine bge.events module
   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.keys.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.keys.keycode, key[1] = status
  34                 if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
  35                         if key == bge.keys.WKEY:
  36                                 # Activate Forward!
  37                         if key == bge.keys.SKEY:
  38                                 # Activate Backward!
  39                         if key == bge.keys.AKEY:
  40                                 # Activate Left!
  41                         if key == bge.keys.DKEY:
  42                                 # Activate Right!
  43
  44 *********
  45 Functions
  46 *********
  47
  48 .. function:: EventToString(event)
  49
  50    Return the string name of a key event. Will raise a ValueError error if its invalid.
  51
  52    :arg event: key event from bge.keys or the keyboard sensor.
  53    :type event: int
  54    :rtype: string
  55
  56 .. function:: EventToCharacter(event, shift)
  57
  58    Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
  59
  60    :type event: int
  61    :arg event: key event from :mod:`bge.keys` or the keyboard sensor.
  62    :type shift: bool
  63    :arg shift: set to true if shift is held.
  64    :rtype: string
  65
  66 ****************
  67 Keys (Constants)
  68 ****************
  69
  70 .. _mouse-keys:
  71
  72 ==========
  73 Mouse Keys
  74 ==========
  75
  76 .. data:: LEFTMOUSE
  77 .. data:: MIDDLEMOUSE
  78 .. data:: RIGHTMOUSE
  79 .. data:: WHEELUPMOUSE
  80 .. data:: WHEELDOWNMOUSE
  81 .. data:: MOUSEX
  82 .. data:: MOUSEY
  83
  84 =============
  85 Keyboard Keys
  86 =============
  87
  88 -------------
  89 Alphabet keys
  90 -------------
  91
  92 .. data:: AKEY
  93 .. data:: BKEY
  94 .. data:: CKEY
  95 .. data:: DKEY
  96 .. data:: EKEY
  97 .. data:: FKEY
  98 .. data:: GKEY
  99 .. data:: HKEY
 100 .. data:: IKEY
 101 .. data:: JKEY
 102 .. data:: KKEY
 103 .. data:: LKEY
 104 .. data:: MKEY
 105 .. data:: NKEY
 106 .. data:: OKEY
 107 .. data:: PKEY
 108 .. data:: QKEY
 109 .. data:: RKEY
 110 .. data:: SKEY
 111 .. data:: TKEY
 112 .. data:: UKEY
 113 .. data:: VKEY
 114 .. data:: WKEY
 115 .. data:: XKEY
 116 .. data:: YKEY
 117 .. data:: ZKEY
 118
 119 -----------
 120 Number keys
 121 -----------
 122
 123 .. data:: ZEROKEY
 124 .. data:: ONEKEY
 125 .. data:: TWOKEY
 126 .. data:: THREEKEY
 127 .. data:: FOURKEY
 128 .. data:: FIVEKEY
 129 .. data:: SIXKEY
 130 .. data:: SEVENKEY
 131 .. data:: EIGHTKEY
 132 .. data:: NINEKEY
 133
 134 --------------
 135 Modifiers Keys
 136 --------------
 137
 138 .. data:: CAPSLOCKKEY
 139 .. data:: LEFTCTRLKEY
 140 .. data:: LEFTALTKEY
 141 .. data:: RIGHTALTKEY
 142 .. data:: RIGHTCTRLKEY
 143 .. data:: RIGHTSHIFTKEY
 144 .. data:: LEFTSHIFTKEY
 145
 146 ----------
 147 Arrow Keys
 148 ----------
 149
 150 .. data:: LEFTARROWKEY
 151 .. data:: DOWNARROWKEY
 152 .. data:: RIGHTARROWKEY
 153 .. data:: UPARROWKEY
 154
 155 --------------
 156 Numberpad Keys
 157 --------------
 158
 159 .. data:: PAD0
 160 .. data:: PAD1
 161 .. data:: PAD2
 162 .. data:: PAD3
 163 .. data:: PAD4
 164 .. data:: PAD5
 165 .. data:: PAD6
 166 .. data:: PAD7
 167 .. data:: PAD8
 168 .. data:: PAD9
 169 .. data:: PADPERIOD
 170 .. data:: PADSLASHKEY
 171 .. data:: PADASTERKEY
 172 .. data:: PADMINUS
 173 .. data:: PADENTER
 174 .. data:: PADPLUSKEY
 175
 176 -------------
 177 Function Keys
 178 -------------
 179
 180 .. data:: F1KEY
 181 .. data:: F2KEY
 182 .. data:: F3KEY
 183 .. data:: F4KEY
 184 .. data:: F5KEY
 185 .. data:: F6KEY
 186 .. data:: F7KEY
 187 .. data:: F8KEY
 188 .. data:: F9KEY
 189 .. data:: F10KEY
 190 .. data:: F11KEY
 191 .. data:: F12KEY
 192 .. data:: F13KEY
 193 .. data:: F14KEY
 194 .. data:: F15KEY
 195 .. data:: F16KEY
 196 .. data:: F17KEY
 197 .. data:: F18KEY
 198 .. data:: F19KEY
 199
 200 ----------
 201 Other Keys
 202 ----------
 203
 204 .. data:: ACCENTGRAVEKEY
 205 .. data:: BACKSLASHKEY
 206 .. data:: BACKSPACEKEY
 207 .. data:: COMMAKEY
 208 .. data:: DELKEY
 209 .. data:: ENDKEY
 210 .. data:: EQUALKEY
 211 .. data:: ESCKEY
 212 .. data:: HOMEKEY
 213 .. data:: INSERTKEY
 214 .. data:: LEFTBRACKETKEY
 215 .. data:: LINEFEEDKEY
 216 .. data:: MINUSKEY
 217 .. data:: PAGEDOWNKEY
 218 .. data:: PAGEUPKEY
 219 .. data:: PAUSEKEY
 220 .. data:: PERIODKEY
 221 .. data:: QUOTEKEY
 222 .. data:: RIGHTBRACKETKEY
 223 .. data:: RETKEY
 224 .. data:: SEMICOLONKEY
 225 .. data:: SLASHKEY
 226 .. data:: SPACEKEY
 227 .. data:: TABKEY