[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52459] trunk/blender/doc/python_api/rst: more bge reference api docstrings, leaving KX_FontObject and KX_NavMeshObject as TODO.

[Campbell Barton]

Revision: 52459
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52459
Author:   campbellbarton
Date:     2012-11-22 06:04:12 +0000 (Thu, 22 Nov 2012)
Log Message:
-----------
more bge reference api docstrings, leaving KX_FontObject and KX_NavMeshObject as TODO.

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

Modified: trunk/blender/doc/python_api/rst/bge.logic.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.logic.rst	2012-11-22 05:33:05 UTC (rev 52458)
+++ trunk/blender/doc/python_api/rst/bge.logic.rst	2012-11-22 06:04:12 UTC (rev 52459)
@@ -324,6 +324,21 @@
 
    .. warning: Not implimented yet
 
+.. function:: getExitKey()
+
+   Gets the key used to exit the game engine
+
+   :return: The key (defaults to :mod:`bge.events.ESCKEY`)
+   :rtype: int
+
+.. function:: setExitKey(key)
+
+   Sets the key used to exit the game engine
+
+   :arg key: A key constant from :mod:`bge.events`
+   :rtype key: int
+
+
 *****************
 Utility functions
 *****************

Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-22 05:33:05 UTC (rev 52458)
+++ trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-22 06:04:12 UTC (rev 52459)
@@ -633,6 +633,14 @@
 
       :type: string
 
+
+.. class:: KX_SteeringActuator(SCA_IActuator)
+
+   SteeringActuator for navigation.
+
+   TODO.
+
+
 .. class:: CListValue(CPropValue)
 
    This is a list like object used in the game engine internally that behaves similar to a python list in most ways.
@@ -698,6 +706,24 @@
 
    KX_BlenderMaterial
 
+   .. attribute:: shader
+
+      The materials shader.
+
+      :type: :class:`BL_Shader`
+
+   .. attribute:: blending
+
+      Ints used for pixel blending, (src, dst), matching the setBlending method.
+
+      :type: (integer, integer)
+
+   .. attribute:: material_index
+
+      The material's index.
+
+      :type: integer
+
    .. method:: getShader()
 
       Returns the material's shader.
@@ -1223,6 +1249,13 @@
 
       :type: :class:`CListValue` of :class:`KX_GameObject`'s
 
+   .. attribute:: life
+
+      The number of seconds until the object ends, assumes 50fps.
+      (when added with an add object actuator), (read-only).
+
+      :type: float
+
    .. method:: endObject()
 
       Delete this object, can be used in place of the EndObject Actuator.
@@ -2176,6 +2209,17 @@
 
       :type: list of strings
 
+
+.. class:: KX_FontObject(KX_GameObject)
+
+   TODO.
+
+
+.. class:: KX_NavMeshObject(KX_GameObject)
+
+   TODO.
+
+
 .. class:: KX_ObjectActuator(SCA_IActuator)
 
    The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement,