Adding docs for KX_NavMeshObject based on doc strings found in KX_NavMeshObject.cpp.
authorMitchell Stokes <mogurijin@gmail.com>
Thu, 22 Nov 2012 07:24:00 +0000 (07:24 +0000)
committerMitchell Stokes <mogurijin@gmail.com>
Thu, 22 Nov 2012 07:24:00 +0000 (07:24 +0000)
doc/python_api/rst/bge.types.rst

index 34029fd..826432a 100644 (file)
@@ -2217,8 +2217,43 @@ Types
 
 .. 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)