[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [54138] trunk/blender/doc/python_api/rst: BGE Py API docs: correct references to bge.keys

Campbell Barton ideasman42 at gmail.com
Mon Jan 28 07:39:24 CET 2013


Revision: 54138
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=54138
Author:   campbellbarton
Date:     2013-01-28 06:39:23 +0000 (Mon, 28 Jan 2013)
Log Message:
-----------
BGE Py API docs: correct references to bge.keys

Modified Paths:
--------------
    trunk/blender/doc/python_api/rst/bge.events.rst
    trunk/blender/doc/python_api/rst/bge.types.rst

Modified: trunk/blender/doc/python_api/rst/bge.events.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.events.rst	2013-01-28 06:34:13 UTC (rev 54137)
+++ trunk/blender/doc/python_api/rst/bge.events.rst	2013-01-28 06:39:23 UTC (rev 54138)
@@ -69,7 +69,7 @@
 
    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.
+   :arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
    :type event: int
    :rtype: string
    
@@ -78,7 +78,7 @@
    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.
+   :arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
    :type shift: bool
    :arg shift: set to true if shift is held.
    :rtype: string

Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst	2013-01-28 06:34:13 UTC (rev 54137)
+++ trunk/blender/doc/python_api/rst/bge.types.rst	2013-01-28 06:39:23 UTC (rev 54138)
@@ -4215,25 +4215,25 @@
 
    A keyboard sensor detects player key presses.
 
-   See module :mod:`bge.keys` for keycode values.
+   See module :mod:`bge.events` for keycode values.
 
    .. attribute:: key
 
       The key code this sensor is looking for.
 
-      :type: keycode from :mod:`bge.keys` module
+      :type: keycode from :mod:`bge.events` module
 
    .. attribute:: hold1
 
       The key code for the first modifier this sensor is looking for.
 
-      :type: keycode from :mod:`bge.keys` module
+      :type: keycode from :mod:`bge.events` module
 
    .. attribute:: hold2
 
       The key code for the second modifier this sensor is looking for.
 
-      :type: keycode from :mod:`bge.keys` module
+      :type: keycode from :mod:`bge.events` module
 
    .. attribute:: toggleProperty
 




More information about the Bf-blender-cvs mailing list