diff options
author | Mitchell Stokes <mogurijin@gmail.com> | 2012-11-23 11:47:53 +0400 |
---|---|---|
committer | Mitchell Stokes <mogurijin@gmail.com> | 2012-11-23 11:47:53 +0400 |
commit | f22fb939d3cc87c62ee0b3668911e5402cc7cc6b (patch) | |
tree | 0fcb19830cebf9ee41d85a14480728a7997031f7 /doc | |
parent | 8ab5aa6e8d57272487a8f8f1b64d6266ce747ca6 (diff) |
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.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/python_api/rst/bge.types.rst | 61 |
1 files changed, 59 insertions, 2 deletions
diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst index 728793b5603..f7a63b48f61 100644 --- a/doc/python_api/rst/bge.types.rst +++ b/doc/python_api/rst/bge.types.rst @@ -636,10 +636,67 @@ Types .. 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) |