[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [52462] trunk/blender/doc/python_api/rst/ bge.types.rst: Adding docs for KX_NavMeshObject based on doc strings found in KX_NavMeshObject .cpp.

[Mitchell Stokes]

Revision: 52462
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=52462
Author:   moguri
Date:     2012-11-22 07:24:00 +0000 (Thu, 22 Nov 2012)
Log Message:
-----------
Adding docs for KX_NavMeshObject based on doc strings found in KX_NavMeshObject.cpp.

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-22 07:08:02 UTC (rev 52461)
+++ trunk/blender/doc/python_api/rst/bge.types.rst	2012-11-22 07:24:00 UTC (rev 52462)
@@ -2217,9 +2217,44 @@
 
 .. class:: KX_NavMeshObject(KX_GameObject)
 
-   TODO.
+   Python interface for using and controlling navigation meshes. 
 
+   .. method:: findPath(start, goal)
 
+      Finds the path from start to goal points.
+
+      :arg start: the start point
+      :arg start: 3D Vector
+      :arg goal: the goal point
+      :arg start: 3D Vector
+      :return: a path as a list of points
+      :rtype: list of points
+
+   .. method:: raycast(start, goal)
+
+      Raycast from start to goal points.
+
+      :arg start: the start point
+      :arg start: 3D Vector
+      :arg goal: the goal point
+      :arg start: 3D Vector
+      :return: the hit factor
+      :rtype: float
+
+  .. method:: draw(mode)
+
+      Draws a debug mesh for the navigation mesh.
+
+      :arg mode: the drawing mode (WALLS=0, POLYS=1, TRIS=2)
+      :arg mode: integer
+      :return: None
+
+  .. method:: rebuild()
+
+      Rebuild the navigation mesh.
+
+      :return: None
+
 .. class:: KX_ObjectActuator(SCA_IActuator)
 
    The object actuator ("Motion Actuator") applies force, torque, displacement, angular displacement,