Merged changes in the trunk up to revision 54421.
[blender.git] / doc / python_api / rst / bge_types / bge.types.KX_NavMeshObject.rst
1 KX_NavMeshObject(KX_GameObject)
2 ===============================
3
4 .. module:: bge.types
5
6 base class --- :class:`KX_GameObject`
7
8 .. class:: KX_NavMeshObject(KX_GameObject)
9
10    Python interface for using and controlling navigation meshes. 
11
12    .. method:: findPath(start, goal)
13
14       Finds the path from start to goal points.
15
16       :arg start: the start point
17       :arg start: 3D Vector
18       :arg goal: the goal point
19       :arg start: 3D Vector
20       :return: a path as a list of points
21       :rtype: list of points
22
23    .. method:: raycast(start, goal)
24
25       Raycast from start to goal points.
26
27       :arg start: the start point
28       :arg start: 3D Vector
29       :arg goal: the goal point
30       :arg start: 3D Vector
31       :return: the hit factor
32       :rtype: float
33
34    .. method:: draw(mode)
35
36       Draws a debug mesh for the navigation mesh.
37
38       :arg mode: the drawing mode (one of :ref:`these constants <navmesh-draw-mode>`)
39       :arg mode: integer
40       :return: None
41
42    .. method:: rebuild()
43
44       Rebuild the navigation mesh.
45
46       :return: None
47