[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [28798] trunk/blender/source/gameengine/ PyDoc: convert GameKeys epydoc into sphinx markup
Campbell Barton
ideasman42 at gmail.com
Mon May 17 01:25:05 CEST 2010
Revision: 28798
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=28798
Author: campbellbarton
Date: 2010-05-17 01:25:05 +0200 (Mon, 17 May 2010)
Log Message:
-----------
convert GameKeys epydoc into sphinx markup
Modified Paths:
--------------
trunk/blender/source/gameengine/PyDoc/bge.render.rst
Added Paths:
-----------
trunk/blender/source/gameengine/PyDoc/bge.keys.rst
Removed Paths:
-------------
trunk/blender/source/gameengine/PyDoc/GameKeys.py
Deleted: trunk/blender/source/gameengine/PyDoc/GameKeys.py
===================================================================
--- trunk/blender/source/gameengine/PyDoc/GameKeys.py 2010-05-16 23:13:30 UTC (rev 28797)
+++ trunk/blender/source/gameengine/PyDoc/GameKeys.py 2010-05-16 23:25:05 UTC (rev 28798)
@@ -1,190 +0,0 @@
-# $Id$
-"""
-Documentation for the GameKeys module.
-======================================
-
-This module holds key constants for the SCA_KeyboardSensor.
-
-
-Example::
- # Set a connected keyboard sensor to accept F1
- import GameLogic
- import GameKeys
-
- co = GameLogic.getCurrentController()
- # 'Keyboard' is a keyboard sensor
- sensor = co.sensors["Keyboard"]
- sensor.key = GameKeys.F1KEY
-
-Example::
- # Do the all keys thing
- import GameLogic
- import GameKeys
-
- co = GameLogic.getCurrentController()
- # 'Keyboard' is a keyboard sensor
- sensor = co.sensors["Keyboard"]
-
- for key,status in sensor.events:
- # key[0] == GameKeys.keycode, key[1] = status
- if status == GameLogic.KX_INPUT_JUST_ACTIVATED:
- if key == GameKeys.WKEY:
- # Activate Forward!
- if key == GameKeys.SKEY:
- # Activate Backward!
- if key == GameKeys.AKEY:
- # Activate Left!
- if key == GameKeys.DKEY:
- # Activate Right!
-
- at 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
- at var AKEY:
- at var BKEY:
- at var CKEY:
- at var DKEY:
- at var EKEY:
- at var FKEY:
- at var GKEY:
- at var HKEY:
- at var IKEY:
- at var JKEY:
- at var KKEY:
- at var LKEY:
- at var MKEY:
- at var NKEY:
- at var OKEY:
- at var PKEY:
- at var QKEY:
- at var RKEY:
- at var SKEY:
- at var TKEY:
- at var UKEY:
- at var VKEY:
- at var WKEY:
- at var XKEY:
- at var YKEY:
- at var ZKEY:
-
- at group Number keys: ZEROKEY, ONEKEY, TWOKEY, THREEKEY, FOURKEY, FIVEKEY, SIXKEY, SEVENKEY, EIGHTKEY, NINEKEY
- at var ZEROKEY:
- at var ONEKEY:
- at var TWOKEY:
- at var THREEKEY:
- at var FOURKEY:
- at var FIVEKEY:
- at var SIXKEY:
- at var SEVENKEY:
- at var EIGHTKEY:
- at var NINEKEY:
-
- at group Modifiers: CAPSLOCKKEY, LEFTCTRLKEY, LEFTALTKEY, RIGHTALTKEY, RIGHTCTRLKEY, RIGHTSHIFTKEY, LEFTSHIFTKEY
- at var CAPSLOCKKEY:
- at var LEFTCTRLKEY:
- at var LEFTALTKEY:
- at var RIGHTALTKEY:
- at var RIGHTCTRLKEY:
- at var RIGHTSHIFTKEY:
- at var LEFTSHIFTKEY:
-
- at group Arrow Keys: LEFTARROWKEY, DOWNARROWKEY, RIGHTARROWKEY, UPARROWKEY
- at var LEFTARROWKEY:
- at var DOWNARROWKEY:
- at var RIGHTARROWKEY:
- at var UPARROWKEY:
-
- at group Numberpad Keys: PAD0, PAD1, PAD2, PAD3, PAD4, PAD5, PAD6, PAD7, PAD8, PAD9, PADPERIOD, PADSLASHKEY, PADASTERKEY, PADMINUS, PADENTER, PADPLUSKEY
- at var PAD0:
- at var PAD1:
- at var PAD2:
- at var PAD3:
- at var PAD4:
- at var PAD5:
- at var PAD6:
- at var PAD7:
- at var PAD8:
- at var PAD9:
- at var PADPERIOD:
- at var PADSLASHKEY:
- at var PADASTERKEY:
- at var PADMINUS:
- at var PADENTER:
- at var PADPLUSKEY:
-
- at group Function Keys: F1KEY, F2KEY, F3KEY, F4KEY, F5KEY, F6KEY, F7KEY, F8KEY, F9KEY, F10KEY, F11KEY, F12KEY, F13KEY, F14KEY, F15KEY, F16KEY, F17KEY, F18KEY, F19KEY
- at var F1KEY:
- at var F2KEY:
- at var F3KEY:
- at var F4KEY:
- at var F5KEY:
- at var F6KEY:
- at var F7KEY:
- at var F8KEY:
- at var F9KEY:
- at var F10KEY:
- at var F11KEY:
- at var F12KEY:
- at var F13KEY:
- at var F14KEY:
- at var F15KEY:
- at var F16KEY:
- at var F17KEY:
- at var F18KEY:
- at var F19KEY:
-
- at 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
- at var ACCENTGRAVEKEY:
- at var BACKSLASHKEY:
- at var BACKSPACEKEY:
- at var COMMAKEY:
- at var DELKEY:
- at var ENDKEY:
- at var EQUALKEY:
- at var ESCKEY:
- at var HOMEKEY:
- at var INSERTKEY:
- at var LEFTBRACKETKEY:
- at var LINEFEEDKEY:
- at var MINUSKEY:
- at var PAGEDOWNKEY:
- at var PAGEUPKEY:
- at var PAUSEKEY:
- at var PERIODKEY:
- at var QUOTEKEY:
- at var RIGHTBRACKETKEY:
- at var RETKEY:
- at var SEMICOLONKEY:
- at var SLASHKEY:
- at var SPACEKEY:
- at var TABKEY:
-
- at group Mouse Events: LEFTMOUSE, MIDDLEMOUSE, RIGHTMOUSE, WHEELUPMOUSE, WHEELDOWNMOUSE, MOUSEX, MOUSEY
- at var LEFTMOUSE:
- at var MIDDLEMOUSE:
- at var RIGHTMOUSE:
- at var WHEELUPMOUSE:
- at var WHEELDOWNMOUSE:
- at var MOUSEX:
- at var MOUSEY:
-
-"""
-
-def EventToString(event):
- """
- Return the string name of a key event. Will raise a ValueError error if its invalid.
-
- @type event: int
- @param event: key event from GameKeys or the keyboard sensor.
- @rtype: string
- """
-
-def EventToCharacter(event, shift):
- """
- Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
-
- @type event: int
- @param event: key event from GameKeys or the keyboard sensor.
- @type shift: bool
- @param shift: set to true if shift is held.
- @rtype: string
- """
-
Copied: trunk/blender/source/gameengine/PyDoc/bge.keys.rst (from rev 28789, trunk/blender/source/gameengine/PyDoc/GameKeys.py)
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.keys.rst (rev 0)
+++ trunk/blender/source/gameengine/PyDoc/bge.keys.rst 2010-05-16 23:25:05 UTC (rev 28798)
@@ -0,0 +1,194 @@
+
+Documentation for the bge.keys module.
+======================================
+
+This module holds key constants for the SCA_KeyboardSensor.
+
+.. module:: bge.keys
+
+.. code-block:: python
+
+ # Set a connected keyboard sensor to accept F1
+ import bge
+
+ co = bge.logic.getCurrentController()
+ # 'Keyboard' is a keyboard sensor
+ sensor = co.sensors["Keyboard"]
+ sensor.key = bge.keys.F1KEY
+
+.. code-block:: python
+
+ # Do the all keys thing
+ import bge
+
+ co = bge.logic.getCurrentController()
+ # 'Keyboard' is a keyboard sensor
+ sensor = co.sensors["Keyboard"]
+
+ for key,status in sensor.events:
+ # key[0] == bge.keys.keycode, key[1] = status
+ if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
+ if key == bge.keys.WKEY:
+ # Activate Forward!
+ if key == bge.keys.SKEY:
+ # Activate Backward!
+ if key == bge.keys.AKEY:
+ # Activate Left!
+ if key == bge.keys.DKEY:
+ # Activate Right!
+
+.. function:: EventToString(event)
+
+ Return the string name of a key event. Will raise a ValueError error if its invalid.
+
+ :arg event: key event from bge.keys or the keyboard sensor.
+ :type event: int
+ :rtype: string
+
+.. function:: EventToCharacter(event, shift)
+
+ Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
+
+ :type event: int
+ :arg event: key event from :mod:`bge.keys` or the keyboard sensor.
+ :type shift: bool
+ :arg shift: set to true if shift is held.
+ :rtype: string
+
+
+**Alphabet keys**
+
+.. data:: AKEY:
+.. data:: BKEY:
+.. data:: CKEY:
+.. data:: DKEY:
+.. data:: EKEY:
+.. data:: FKEY:
+.. data:: GKEY:
+.. data:: HKEY:
+.. data:: IKEY:
+.. data:: JKEY:
+.. data:: KKEY:
+.. data:: LKEY:
+.. data:: MKEY:
+.. data:: NKEY:
+.. data:: OKEY:
+.. data:: PKEY:
+.. data:: QKEY:
+.. data:: RKEY:
+.. data:: SKEY:
+.. data:: TKEY:
+.. data:: UKEY:
+.. data:: VKEY:
+.. data:: WKEY:
+.. data:: XKEY:
+.. data:: YKEY:
+.. data:: ZKEY:
+
+**Number keys**
+
+.. data:: ZEROKEY:
+.. data:: ONEKEY:
+.. data:: TWOKEY:
+.. data:: THREEKEY:
+.. data:: FOURKEY:
+.. data:: FIVEKEY:
+.. data:: SIXKEY:
+.. data:: SEVENKEY:
+.. data:: EIGHTKEY:
+.. data:: NINEKEY:
+
+**Modifiers**
+
+.. data:: CAPSLOCKKEY:
+.. data:: LEFTCTRLKEY:
+.. data:: LEFTALTKEY:
+.. data:: RIGHTALTKEY:
+.. data:: RIGHTCTRLKEY:
+.. data:: RIGHTSHIFTKEY:
+.. data:: LEFTSHIFTKEY:
+
+**Arrow Keys**
+
+.. data:: LEFTARROWKEY:
+.. data:: DOWNARROWKEY:
+.. data:: RIGHTARROWKEY:
+.. data:: UPARROWKEY:
+
+**Numberpad Keys**
+
+.. data:: PAD0:
+.. data:: PAD1:
+.. data:: PAD2:
+.. data:: PAD3:
+.. data:: PAD4:
+.. data:: PAD5:
+.. data:: PAD6:
+.. data:: PAD7:
+.. data:: PAD8:
+.. data:: PAD9:
+.. data:: PADPERIOD:
+.. data:: PADSLASHKEY:
+.. data:: PADASTERKEY:
+.. data:: PADMINUS:
+.. data:: PADENTER:
+.. data:: PADPLUSKEY:
+
+**Function Keys**
+
+.. data:: F1KEY:
+.. data:: F2KEY:
+.. data:: F3KEY:
+.. data:: F4KEY:
+.. data:: F5KEY:
+.. data:: F6KEY:
+.. data:: F7KEY:
+.. data:: F8KEY:
+.. data:: F9KEY:
+.. data:: F10KEY:
+.. data:: F11KEY:
+.. data:: F12KEY:
+.. data:: F13KEY:
+.. data:: F14KEY:
+.. data:: F15KEY:
+.. data:: F16KEY:
+.. data:: F17KEY:
+.. data:: F18KEY:
+.. data:: F19KEY:
+
+**Other Keys**
+
+.. data:: ACCENTGRAVEKEY:
+.. data:: BACKSLASHKEY:
+.. data:: BACKSPACEKEY:
+.. data:: COMMAKEY:
+.. data:: DELKEY:
+.. data:: ENDKEY:
+.. data:: EQUALKEY:
+.. data:: ESCKEY:
+.. data:: HOMEKEY:
+.. data:: INSERTKEY:
+.. data:: LEFTBRACKETKEY:
+.. data:: LINEFEEDKEY:
+.. data:: MINUSKEY:
+.. data:: PAGEDOWNKEY:
+.. data:: PAGEUPKEY:
+.. data:: PAUSEKEY:
+.. data:: PERIODKEY:
+.. data:: QUOTEKEY:
+.. data:: RIGHTBRACKETKEY:
+.. data:: RETKEY:
+.. data:: SEMICOLONKEY:
+.. data:: SLASHKEY:
+.. data:: SPACEKEY:
+.. data:: TABKEY:
+
+**Mouse Events**
+
+.. data:: LEFTMOUSE:
+.. data:: MIDDLEMOUSE:
+.. data:: RIGHTMOUSE:
+.. data:: WHEELUPMOUSE:
+.. data:: WHEELDOWNMOUSE:
+.. data:: MOUSEX:
+.. data:: MOUSEY:
Modified: trunk/blender/source/gameengine/PyDoc/bge.render.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.render.rst 2010-05-16 23:13:30 UTC (rev 28797)
+++ trunk/blender/source/gameengine/PyDoc/bge.render.rst 2010-05-16 23:25:05 UTC (rev 28798)
@@ -2,6 +2,8 @@
Documentation for the bge.render Module.
========================================
+.. module:: bge.render
+
.. code-block:: python
# Example Uses an L{SCA_MouseSensor}, and two L{KX_ObjectActuator}s to implement MouseLook::
More information about the Bf-blender-cvs
mailing list