Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: fce69bce1c
Branches Tags
godot-docs
/
classes
/
class_navigation.rst

class_navigation.rst 10 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the Navigation.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_Navigation:
    8. 

  8. 

  9. Navigation
    10. 

  10. ==========
    11. 

  11. 

  12. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Mesh-based navigation and pathfinding node.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. Provides navigation and pathfinding within a collection of :ref:`NavigationMesh<class_NavigationMesh>`\ es. By default, these will be automatically collected from child :ref:`NavigationMeshInstance<class_NavigationMeshInstance>` nodes, but they can also be added on the fly with :ref:`navmesh_add<class_Navigation_method_navmesh_add>`. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on.
    20. 

  20. 

  21. Tutorials
    22. 

  22. ---------
    23. 

  23. 

  24. - `https://godotengine.org/asset-library/asset/124 <https://godotengine.org/asset-library/asset/124>`_
    25. 

  25. 

  26. Properties
    27. 

  27. ----------
    28. 

  28. 

  29. +-------------------------------+-------------------------------------------------------+------------------------+
    30. 

  30. | :ref:`Vector3<class_Vector3>` | :ref:`up_vector<class_Navigation_property_up_vector>` | ``Vector3( 0, 1, 0 )`` |
    31. 

  31. +-------------------------------+-------------------------------------------------------+------------------------+
    32. 

  32. 

  33. Methods
    34. 

  34. -------
    35. 

  35. 

  36. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`Vector3<class_Vector3>`                   | :ref:`get_closest_point<class_Navigation_method_get_closest_point>` **(** :ref:`Vector3<class_Vector3>` to_point **)**                                                                                                    |
    38. 

  38. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Vector3<class_Vector3>`                   | :ref:`get_closest_point_normal<class_Navigation_method_get_closest_point_normal>` **(** :ref:`Vector3<class_Vector3>` to_point **)**                                                                                      |
    40. 

  40. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`Object<class_Object>`                     | :ref:`get_closest_point_owner<class_Navigation_method_get_closest_point_owner>` **(** :ref:`Vector3<class_Vector3>` to_point **)**                                                                                        |
    42. 

  42. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`Vector3<class_Vector3>`                   | :ref:`get_closest_point_to_segment<class_Navigation_method_get_closest_point_to_segment>` **(** :ref:`Vector3<class_Vector3>` start, :ref:`Vector3<class_Vector3>` end, :ref:`bool<class_bool>` use_collision=false **)** |
    44. 

  44. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`get_simple_path<class_Navigation_method_get_simple_path>` **(** :ref:`Vector3<class_Vector3>` start, :ref:`Vector3<class_Vector3>` end, :ref:`bool<class_bool>` optimize=true **)**                                 |
    46. 

  46. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`int<class_int>`                           | :ref:`navmesh_add<class_Navigation_method_navmesh_add>` **(** :ref:`NavigationMesh<class_NavigationMesh>` mesh, :ref:`Transform<class_Transform>` xform, :ref:`Object<class_Object>` owner=null **)**                     |
    48. 

  48. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | void                                            | :ref:`navmesh_remove<class_Navigation_method_navmesh_remove>` **(** :ref:`int<class_int>` id **)**                                                                                                                        |
    50. 

  50. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | void                                            | :ref:`navmesh_set_transform<class_Navigation_method_navmesh_set_transform>` **(** :ref:`int<class_int>` id, :ref:`Transform<class_Transform>` xform **)**                                                                 |
    52. 

  52. +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. 

  54. Property Descriptions
    55. 

  55. ---------------------
    56. 

  56. 

  57. .. _class_Navigation_property_up_vector:
    58. 

  58. 

  59. - :ref:`Vector3<class_Vector3>` **up_vector**
    60. 

  60. 

  61. +-----------+------------------------+
    62. 

  62. | *Default* | ``Vector3( 0, 1, 0 )`` |
    63. 

  63. +-----------+------------------------+
    64. 

  64. | *Setter*  | set_up_vector(value)   |
    65. 

  65. +-----------+------------------------+
    66. 

  66. | *Getter*  | get_up_vector()        |
    67. 

  67. +-----------+------------------------+
    68. 

  68. 

  69. Defines which direction is up. By default, this is ``(0, 1, 0)``, which is the world's "up" direction.
    70. 

  70. 

  71. Method Descriptions
    72. 

  72. -------------------
    73. 

  73. 

  74. .. _class_Navigation_method_get_closest_point:
    75. 

  75. 

  76. - :ref:`Vector3<class_Vector3>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_point **)**
    77. 

  77. 

  78. Returns the navigation point closest to the point given. Points are in local coordinate space.
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_Navigation_method_get_closest_point_normal:
    83. 

  83. 

  84. - :ref:`Vector3<class_Vector3>` **get_closest_point_normal** **(** :ref:`Vector3<class_Vector3>` to_point **)**
    85. 

  85. 

  86. Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on.
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_Navigation_method_get_closest_point_owner:
    91. 

  91. 

  92. - :ref:`Object<class_Object>` **get_closest_point_owner** **(** :ref:`Vector3<class_Vector3>` to_point **)**
    93. 

  93. 

  94. Returns the owner of the :ref:`NavigationMesh<class_NavigationMesh>` which contains the navigation point closest to the point given. This is usually a :ref:`NavigationMeshInstance<class_NavigationMeshInstance>`. For meshes added via :ref:`navmesh_add<class_Navigation_method_navmesh_add>`, returns the owner that was given (or ``null`` if the ``owner`` parameter was omitted).
    95. 

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_Navigation_method_get_closest_point_to_segment:
    99. 

  99. 

  100. - :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 **)**
    101. 

  101. 

  102. Returns the navigation point closest to the given line segment. When enabling ``use_collision``, only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_Navigation_method_get_simple_path:
    107. 

  107. 

  108. - :ref:`PoolVector3Array<class_PoolVector3Array>` **get_simple_path** **(** :ref:`Vector3<class_Vector3>` start, :ref:`Vector3<class_Vector3>` end, :ref:`bool<class_bool>` optimize=true **)**
    109. 

  109. 

  110. Returns the path between two given points. Points are in local coordinate space. If ``optimize`` is ``true`` (the default), the agent properties associated with each :ref:`NavigationMesh<class_NavigationMesh>` (radius, height, etc.) are considered in the path calculation, otherwise they are ignored.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_Navigation_method_navmesh_add:
    115. 

  115. 

  116. - :ref:`int<class_int>` **navmesh_add** **(** :ref:`NavigationMesh<class_NavigationMesh>` mesh, :ref:`Transform<class_Transform>` xform, :ref:`Object<class_Object>` owner=null **)**
    117. 

  117. 

  118. Adds a :ref:`NavigationMesh<class_NavigationMesh>`. Returns an ID for use with :ref:`navmesh_remove<class_Navigation_method_navmesh_remove>` or :ref:`navmesh_set_transform<class_Navigation_method_navmesh_set_transform>`. If given, a :ref:`Transform2D<class_Transform2D>` is applied to the polygon. The optional ``owner`` is used as return value for :ref:`get_closest_point_owner<class_Navigation_method_get_closest_point_owner>`.
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_Navigation_method_navmesh_remove:
    123. 

  123. 

  124. - void **navmesh_remove** **(** :ref:`int<class_int>` id **)**
    125. 

  125. 

  126. Removes the :ref:`NavigationMesh<class_NavigationMesh>` with the given ID.
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_Navigation_method_navmesh_set_transform:
    131. 

  131. 

  132. - void **navmesh_set_transform** **(** :ref:`int<class_int>` id, :ref:`Transform<class_Transform>` xform **)**
    133. 

  133. 

  134. Sets the transform applied to the :ref:`NavigationMesh<class_NavigationMesh>` with the given ID.
    135. 

  135. 

  136. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    137. 

  137. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    138. 

  138. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    139.