class_navigation.rst 7.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_Navigation:
  4. Navigation
  5. ==========
  6. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`Vector3<class_vector3>` | :ref:`get_closest_point<class_Navigation_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_point **)** |
  14. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Vector3<class_vector3>` | :ref:`get_closest_point_normal<class_Navigation_get_closest_point_normal>` **(** :ref:`Vector3<class_vector3>` to_point **)** |
  16. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Object<class_object>` | :ref:`get_closest_point_owner<class_Navigation_get_closest_point_owner>` **(** :ref:`Vector3<class_vector3>` to_point **)** |
  18. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Vector3<class_vector3>` | :ref:`get_closest_point_to_segment<class_Navigation_get_closest_point_to_segment>` **(** :ref:`Vector3<class_vector3>` start, :ref:`Vector3<class_vector3>` end, :ref:`bool<class_bool>` use_collision=false **)** |
  20. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`Vector3Array<class_vector3array>` | :ref:`get_simple_path<class_Navigation_get_simple_path>` **(** :ref:`Vector3<class_vector3>` start, :ref:`Vector3<class_vector3>` end, :ref:`bool<class_bool>` optimize=true **)** |
  22. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Vector3<class_vector3>` | :ref:`get_up_vector<class_Navigation_get_up_vector>` **(** **)** const |
  24. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`navmesh_create<class_Navigation_navmesh_create>` **(** :ref:`NavigationMesh<class_navigationmesh>` mesh, :ref:`Transform<class_transform>` xform, :ref:`Object<class_object>` owner=NULL **)** |
  26. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`navmesh_remove<class_Navigation_navmesh_remove>` **(** :ref:`int<class_int>` id **)** |
  28. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`navmesh_set_transform<class_Navigation_navmesh_set_transform>` **(** :ref:`int<class_int>` id, :ref:`Transform<class_transform>` xform **)** |
  30. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`set_up_vector<class_Navigation_set_up_vector>` **(** :ref:`Vector3<class_vector3>` up **)** |
  32. +------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. Member Function Description
  34. ---------------------------
  35. .. _class_Navigation_get_closest_point:
  36. - :ref:`Vector3<class_vector3>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_point **)**
  37. .. _class_Navigation_get_closest_point_normal:
  38. - :ref:`Vector3<class_vector3>` **get_closest_point_normal** **(** :ref:`Vector3<class_vector3>` to_point **)**
  39. .. _class_Navigation_get_closest_point_owner:
  40. - :ref:`Object<class_object>` **get_closest_point_owner** **(** :ref:`Vector3<class_vector3>` to_point **)**
  41. .. _class_Navigation_get_closest_point_to_segment:
  42. - :ref:`Vector3<class_vector3>` **get_closest_point_to_segment** **(** :ref:`Vector3<class_vector3>` start, :ref:`Vector3<class_vector3>` end, :ref:`bool<class_bool>` use_collision=false **)**
  43. .. _class_Navigation_get_simple_path:
  44. - :ref:`Vector3Array<class_vector3array>` **get_simple_path** **(** :ref:`Vector3<class_vector3>` start, :ref:`Vector3<class_vector3>` end, :ref:`bool<class_bool>` optimize=true **)**
  45. .. _class_Navigation_get_up_vector:
  46. - :ref:`Vector3<class_vector3>` **get_up_vector** **(** **)** const
  47. .. _class_Navigation_navmesh_create:
  48. - :ref:`int<class_int>` **navmesh_create** **(** :ref:`NavigationMesh<class_navigationmesh>` mesh, :ref:`Transform<class_transform>` xform, :ref:`Object<class_object>` owner=NULL **)**
  49. .. _class_Navigation_navmesh_remove:
  50. - void **navmesh_remove** **(** :ref:`int<class_int>` id **)**
  51. .. _class_Navigation_navmesh_set_transform:
  52. - void **navmesh_set_transform** **(** :ref:`int<class_int>` id, :ref:`Transform<class_transform>` xform **)**
  53. .. _class_Navigation_set_up_vector:
  54. - void **set_up_vector** **(** :ref:`Vector3<class_vector3>` up **)**