[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52505] trunk/blender/doc/python_api/rst/ bge.types.rst: BGE Docs: Adding some docs for some of the Steering Actuator attributes.

[Mitchell Stokes]

Revision: 52505
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52505
Author:   moguri
Date:     2012-11-23 07:47:53 +0000 (Fri, 23 Nov 2012)
Log Message:
-----------
BGE Docs: Adding some docs for some of the Steering Actuator attributes. I grabbed the docs from the UI descriptions from RNA for the Steering Actuator. However, these aren't the best descriptions, and both the UI descriptions and the docs could use some attention. Also, steeringVec and facingMode didn't have corresponding UI elements, so I've left them undocumented for now. Someone who knows what they do can hopefully document them.

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

Modified: trunk/blender/doc/python_api/rst/bge.types.rst
===================================================================
--- trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-23 06:35:06 UTC (rev 52504)
+++ trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-23 07:47:53 UTC (rev 52505)
@@ -636,11 +636,68 @@
 
 .. class:: KX_SteeringActuator(SCA_IActuator)
 
-   SteeringActuator for navigation.
+   Steering Actuator for navigation.
 
-   TODO.
+   .. attribute:: behavior
 
+      The steering behavior to use.
 
+      :type: one of :ref:`these constants <logic-steering-actuator>`
+
+   .. attribute:: velocity
+
+      Velocity magnitude
+
+      :type: float
+
+   .. attribute:: acceleration
+
+      Max acceleration
+
+      :type: float
+
+   .. attribute:: turnspeed
+
+      Max turn speed
+
+      :type: float
+
+   .. attribute:: distance
+
+      Relax distance
+
+      :type: float
+
+   .. attribute:: target
+
+      Target object
+
+      :type: :class:`KX_GameObject`
+
+   .. attribute:: navmesh
+
+      Navigation mesh
+
+      :type: :class:`KX_GameObject`
+
+   .. attribute:: selfterminated
+
+      Terminate when target is reached
+
+      :type: boolean
+
+   .. attribute:: enableVisualization
+
+      Enable debug visualization
+
+      :type: boolean
+
+   .. attribute:: pathUpdatePeriod
+
+      Path update period
+
+      :type: int
+
 .. 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.