Use epydoc for generating game python reference (like the bpython guys)
This commit is contained in:
@@ -1,120 +1,128 @@
|
||||
# $Id$
|
||||
"""
|
||||
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
|
||||
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
|
||||
Number keys
|
||||
-----------
|
||||
- ZEROKEY
|
||||
- ONEKEY
|
||||
- TWOKEY
|
||||
- THREEKEY
|
||||
- FOURKEY
|
||||
- FIVEKEY
|
||||
- SIXKEY
|
||||
- SEVENKEY
|
||||
- EIGHTKEY
|
||||
- NINEKEY
|
||||
|
||||
Shift Modifiers:
|
||||
CAPSLOCKKEY
|
||||
Shift Modifiers
|
||||
---------------
|
||||
- CAPSLOCKKEY
|
||||
|
||||
LEFTCTRLKEY
|
||||
LEFTALTKEY
|
||||
RIGHTALTKEY
|
||||
RIGHTCTRLKEY
|
||||
RIGHTSHIFTKEY
|
||||
LEFTSHIFTKEY
|
||||
- LEFTCTRLKEY
|
||||
- LEFTALTKEY
|
||||
- RIGHTALTKEY
|
||||
- RIGHTCTRLKEY
|
||||
- RIGHTSHIFTKEY
|
||||
- LEFTSHIFTKEY
|
||||
|
||||
Arrow Keys:
|
||||
LEFTARROWKEY
|
||||
DOWNARROWKEY
|
||||
RIGHTARROWKEY
|
||||
UPARROWKEY
|
||||
Arrow Keys
|
||||
----------
|
||||
- LEFTARROWKEY
|
||||
- DOWNARROWKEY
|
||||
- RIGHTARROWKEY
|
||||
- UPARROWKEY
|
||||
|
||||
Numberpad Keys:
|
||||
PAD0
|
||||
PAD1
|
||||
PAD2
|
||||
PAD3
|
||||
PAD4
|
||||
PAD5
|
||||
PAD6
|
||||
PAD7
|
||||
PAD8
|
||||
PAD9
|
||||
PADPERIOD
|
||||
PADSLASHKEY
|
||||
PADASTERKEY
|
||||
PADMINUS
|
||||
PADENTER
|
||||
PADPLUSKEY
|
||||
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
|
||||
Function Keys
|
||||
-------------
|
||||
- F1KEY
|
||||
- F2KEY
|
||||
- F3KEY
|
||||
- F4KEY
|
||||
- F5KEY
|
||||
- F6KEY
|
||||
- F7KEY
|
||||
- F8KEY
|
||||
- F9KEY
|
||||
- F10KEY
|
||||
- F11KEY
|
||||
- F12KEY
|
||||
|
||||
Other Keys:
|
||||
ESCKEY
|
||||
TABKEY
|
||||
RETKEY
|
||||
SPACEKEY
|
||||
LINEFEEDKEY
|
||||
BACKSPACEKEY
|
||||
DELKEY
|
||||
SEMICOLONKEY
|
||||
PERIODKEY
|
||||
COMMAKEY
|
||||
QUOTEKEY
|
||||
ACCENTGRAVEKEY
|
||||
MINUSKEY
|
||||
SLASHKEY
|
||||
BACKSLASHKEY
|
||||
EQUALKEY
|
||||
LEFTBRACKETKEY
|
||||
RIGHTBRACKETKEY
|
||||
PAUSEKEY
|
||||
INSERTKEY
|
||||
HOMEKEY
|
||||
PAGEUPKEY
|
||||
PAGEDOWNKEY
|
||||
ENDKEY
|
||||
Other Keys
|
||||
----------
|
||||
- ESCKEY
|
||||
- TABKEY
|
||||
- RETKEY
|
||||
- SPACEKEY
|
||||
- LINEFEEDKEY
|
||||
- BACKSPACEKEY
|
||||
- DELKEY
|
||||
- SEMICOLONKEY
|
||||
- PERIODKEY
|
||||
- COMMAKEY
|
||||
- QUOTEKEY
|
||||
- ACCENTGRAVEKEY
|
||||
- MINUSKEY
|
||||
- SLASHKEY
|
||||
- BACKSLASHKEY
|
||||
- EQUALKEY
|
||||
- LEFTBRACKETKEY
|
||||
- RIGHTBRACKETKEY
|
||||
- PAUSEKEY
|
||||
- INSERTKEY
|
||||
- HOMEKEY
|
||||
- PAGEUPKEY
|
||||
- PAGEDOWNKEY
|
||||
- ENDKEY
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user