BGE API - small changes
[blender.git] / source / gameengine / PyDoc / GameKeys.py
index 14cd7e4f25c42edd9af189618087ecebf073791e..e798f6c901b7a595a6e4b482973c3bffc01610fa 100644 (file)
@@ -5,126 +5,6 @@ Documentation for the GameKeys module.
 
 This module holds key constants for the SCA_KeyboardSensor.
 
-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
-
-Number keys
------------
-       - ZEROKEY
-       - ONEKEY
-       - TWOKEY
-       - THREEKEY
-       - FOURKEY
-       - FIVEKEY
-       - SIXKEY
-       - SEVENKEY
-       - EIGHTKEY
-       - NINEKEY
-
-Shift Modifiers
----------------
-       - CAPSLOCKKEY
-
-       - LEFTCTRLKEY
-       - LEFTALTKEY
-       - RIGHTALTKEY
-       - RIGHTCTRLKEY
-       - RIGHTSHIFTKEY
-       - LEFTSHIFTKEY
-
-Arrow Keys
-----------
-       - LEFTARROWKEY
-       - DOWNARROWKEY
-       - RIGHTARROWKEY
-       - UPARROWKEY
-
-Numberpad Keys
---------------
-       - PAD0
-       - PAD1
-       - PAD2
-       - PAD3
-       - PAD4
-       - PAD5
-       - PAD6
-       - PAD7
-       - PAD8
-       - PAD9
-       - PADPERIOD
-       - PADSLASHKEY
-       - PADASTERKEY
-       - PADMINUS
-       - PADENTER
-       - PADPLUSKEY
-
-Function Keys
--------------
-       - F1KEY
-       - F2KEY
-       - F3KEY
-       - F4KEY
-       - F5KEY
-       - F6KEY
-       - F7KEY
-       - F8KEY
-       - F9KEY
-       - F10KEY
-       - F11KEY
-       - F12KEY
-
-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
 
 Example::
        # Set a connected keyboard sensor to accept F1
@@ -156,7 +36,120 @@ Example::
                                # Activate Left!
                        if key[0] == GameKeys.DKEY:
                                # Activate Right!
-               
+
+@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
+@var AKEY:
+@var BKEY:
+@var CKEY:
+@var DKEY:
+@var EKEY:
+@var FKEY:
+@var GKEY:
+@var HKEY:
+@var IKEY:
+@var JKEY:
+@var KKEY:
+@var LKEY:
+@var MKEY:
+@var NKEY:
+@var OKEY:
+@var PKEY:
+@var QKEY:
+@var RKEY:
+@var SKEY:
+@var TKEY:
+@var UKEY:
+@var VKEY:
+@var WKEY:
+@var XKEY:
+@var YKEY:
+@var ZKEY:
+
+@group Number keys: ZEROKEY, ONEKEY, TWOKEY, THREEKEY, FOURKEY, FIVEKEY, SIXKEY, SEVENKEY, EIGHTKEY, NINEKEY
+@var ZEROKEY:
+@var ONEKEY:
+@var TWOKEY:
+@var THREEKEY:
+@var FOURKEY:
+@var FIVEKEY:
+@var SIXKEY:
+@var SEVENKEY:
+@var EIGHTKEY:
+@var NINEKEY:
+
+@group Modifiers: CAPSLOCKKEY, LEFTCTRLKEY, LEFTALTKEY, RIGHTALTKEY, RIGHTCTRLKEY, RIGHTSHIFTKEY, LEFTSHIFTKEY
+@var CAPSLOCKKEY:
+@var LEFTCTRLKEY:
+@var LEFTALTKEY:
+@var RIGHTALTKEY:
+@var RIGHTCTRLKEY:
+@var RIGHTSHIFTKEY:
+@var LEFTSHIFTKEY:
+
+@group Arrow Keys: LEFTARROWKEY, DOWNARROWKEY, RIGHTARROWKEY, UPARROWKEY
+@var LEFTARROWKEY:
+@var DOWNARROWKEY:
+@var RIGHTARROWKEY:
+@var UPARROWKEY:
+
+@group Numberpad Keys: PAD0, PAD1, PAD2, PAD3, PAD4, PAD5, PAD6, PAD7, PAD8, PAD9, PADPERIOD, PADSLASHKEY, PADASTERKEY, PADMINUS, PADENTER, PADPLUSKEY
+@var PAD0:
+@var PAD1:
+@var PAD2:
+@var PAD3:
+@var PAD4:
+@var PAD5:
+@var PAD6:
+@var PAD7:
+@var PAD8:
+@var PAD9:
+@var PADPERIOD:
+@var PADSLASHKEY:
+@var PADASTERKEY:
+@var PADMINUS:
+@var PADENTER:
+@var PADPLUSKEY:
+
+@group Function Keys: F1KEY, F2KEY, F3KEY, F4KEY, F5KEY, F6KEY, F7KEY, F8KEY, F9KEY, F10KEY, F11KEY, F12KEY
+@var F1KEY:
+@var F2KEY:
+@var F3KEY:
+@var F4KEY:
+@var F5KEY:
+@var F6KEY:
+@var F7KEY:
+@var F8KEY:
+@var F9KEY:
+@var F10KEY:
+@var F11KEY:
+@var F12KEY:
+
+@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
+@var ACCENTGRAVEKEY:
+@var BACKSLASHKEY:
+@var BACKSPACEKEY:
+@var COMMAKEY:
+@var DELKEY:
+@var ENDKEY:
+@var EQUALKEY:
+@var ESCKEY:
+@var HOMEKEY:
+@var INSERTKEY:
+@var LEFTBRACKETKEY:
+@var LINEFEEDKEY:
+@var MINUSKEY:
+@var PAGEDOWNKEY:
+@var PAGEUPKEY:
+@var PAUSEKEY:
+@var PERIODKEY:
+@var QUOTEKEY:
+@var RIGHTBRACKETKEY:
+@var RETKEY:
+@var SEMICOLONKEY:
+@var SLASHKEY:
+@var SPACEKEY:
+@var TABKEY:
+
 """
 
 def EventToString(event):