diff options
| author | Mitchell Stokes <mogurijin@gmail.com> | 2012-11-22 11:24:00 +0400 |
|---|---|---|
| committer | Mitchell Stokes <mogurijin@gmail.com> | 2012-11-22 11:24:00 +0400 |
| commit | 8a62ec63c8aa20af19689452a751389306e5824d (patch) | |
| tree | e46805d5e41db0799a0ac5a6e2dcd7e1efa3df30 /doc/python_api/rst/bge.types.rst | |
| parent | 30a292b61f13e59d53ea2f17b25a54ee95293c85 (diff) | |
Adding docs for KX_NavMeshObject based on doc strings found in KX_NavMeshObject.cpp.
Diffstat (limited to 'doc/python_api/rst/bge.types.rst')
| -rw-r--r-- | doc/python_api/rst/bge.types.rst | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/doc/python_api/rst/bge.types.rst b/doc/python_api/rst/bge.types.rst index 34029fd869f..826432a6b7a 100644 --- a/doc/python_api/rst/bge.types.rst +++ b/doc/python_api/rst/bge.types.rst @@ -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) |