BGE Docs: Adding some docs for some of the Steering Actuator attributes. I grabbed...
authorMitchell Stokes <mogurijin@gmail.com>
Fri, 23 Nov 2012 07:47:53 +0000 (07:47 +0000)
committerMitchell Stokes <mogurijin@gmail.com>
Fri, 23 Nov 2012 07:47:53 +0000 (07:47 +0000)
doc/python_api/rst/bge.types.rst

index 728793b560321389d2f817693949476700897612..f7a63b48f61e9f43167545de23fe4c3e7db63012 100644 (file)
@@ -636,10 +636,67 @@ Types
 
 .. class:: KX_SteeringActuator(SCA_IActuator)
 
 
 .. 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)
 
 
 .. class:: CListValue(CPropValue)