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: b51b2623c4
Branches Tags
godot-docs
/
classes
/
class_navigation.rst

class_navigation.rst 8.5 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140 
  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. These will be automatically collected from child :ref:`NavigationRegion<class_NavigationRegion>` nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on.
    20. 

  20. 

  21. Properties
    22. 

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

  23. 

  24. +-------------------------------+---------------------------------------------------------------------------------+------------------------+
    25. 

  25. | :ref:`float<class_float>`     | :ref:`cell_size<class_Navigation_property_cell_size>`                           | ``0.3``                |
    26. 

  26. +-------------------------------+---------------------------------------------------------------------------------+------------------------+
    27. 

  27. | :ref:`float<class_float>`     | :ref:`edge_connection_margin<class_Navigation_property_edge_connection_margin>` | ``5.0``                |
    28. 

  28. +-------------------------------+---------------------------------------------------------------------------------+------------------------+
    29. 

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

  30. +-------------------------------+---------------------------------------------------------------------------------+------------------------+
    31. 

  31. 

  32. Methods
    33. 

  33. -------
    34. 

  34. 

  35. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

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

  37. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

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

  39. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`RID<class_RID>`                               | :ref:`get_closest_point_owner<class_Navigation_method_get_closest_point_owner>` **(** :ref:`Vector3<class_Vector3>` to_point **)** const                                                                                        |
    41. 

  41. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :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 **)** const |
    43. 

  43. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`RID<class_RID>`                               | :ref:`get_rid<class_Navigation_method_get_rid>` **(** **)** const                                                                                                                                                               |
    45. 

  45. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :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 **)** const                                 |
    47. 

  47. +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. 

  49. Property Descriptions
    50. 

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

  51. 

  52. .. _class_Navigation_property_cell_size:
    53. 

  53. 

  54. - :ref:`float<class_float>` **cell_size**
    55. 

  55. 

  56. +-----------+----------------------+
    57. 

  57. | *Default* | ``0.3``              |
    58. 

  58. +-----------+----------------------+
    59. 

  59. | *Setter*  | set_cell_size(value) |
    60. 

  60. +-----------+----------------------+
    61. 

  61. | *Getter*  | get_cell_size()      |
    62. 

  62. +-----------+----------------------+
    63. 

  63. 

  64. ----
    65. 

  65. 

  66. .. _class_Navigation_property_edge_connection_margin:
    67. 

  67. 

  68. - :ref:`float<class_float>` **edge_connection_margin**
    69. 

  69. 

  70. +-----------+-----------------------------------+
    71. 

  71. | *Default* | ``5.0``                           |
    72. 

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

  73. | *Setter*  | set_edge_connection_margin(value) |
    74. 

  74. +-----------+-----------------------------------+
    75. 

  75. | *Getter*  | get_edge_connection_margin()      |
    76. 

  76. +-----------+-----------------------------------+
    77. 

  77. 

  78. ----
    79. 

  79. 

  80. .. _class_Navigation_property_up_vector:
    81. 

  81. 

  82. - :ref:`Vector3<class_Vector3>` **up_vector**
    83. 

  83. 

  84. +-----------+------------------------+
    85. 

  85. | *Default* | ``Vector3( 0, 1, 0 )`` |
    86. 

  86. +-----------+------------------------+
    87. 

  87. | *Setter*  | set_up_vector(value)   |
    88. 

  88. +-----------+------------------------+
    89. 

  89. | *Getter*  | get_up_vector()        |
    90. 

  90. +-----------+------------------------+
    91. 

  91. 

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

  93. 

  94. Method Descriptions
    95. 

  95. -------------------
    96. 

  96. 

  97. .. _class_Navigation_method_get_closest_point:
    98. 

  98. 

  99. - :ref:`Vector3<class_Vector3>` **get_closest_point** **(** :ref:`Vector3<class_Vector3>` to_point **)** const
    100. 

  100. 

  101. Returns the point closest to the provided ``to_point`` on the navigation mesh surface.
    102. 

  102. 

  103. ----
    104. 

  104. 

  105. .. _class_Navigation_method_get_closest_point_normal:
    106. 

  106. 

  107. - :ref:`Vector3<class_Vector3>` **get_closest_point_normal** **(** :ref:`Vector3<class_Vector3>` to_point **)** const
    108. 

  108. 

  109. Returns the normal for the point returned by :ref:`get_closest_point<class_Navigation_method_get_closest_point>`.
    110. 

  110. 

  111. ----
    112. 

  112. 

  113. .. _class_Navigation_method_get_closest_point_owner:
    114. 

  114. 

  115. - :ref:`RID<class_RID>` **get_closest_point_owner** **(** :ref:`Vector3<class_Vector3>` to_point **)** const
    116. 

  116. 

  117. Returns the owner region RID for the point returned by :ref:`get_closest_point<class_Navigation_method_get_closest_point>`.
    118. 

  118. 

  119. ----
    120. 

  120. 

  121. .. _class_Navigation_method_get_closest_point_to_segment:
    122. 

  122. 

  123. - :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 **)** const
    124. 

  124. 

  125. Returns the closest point between the navigation surface and the segment.
    126. 

  126. 

  127. ----
    128. 

  128. 

  129. .. _class_Navigation_method_get_rid:
    130. 

  130. 

  131. - :ref:`RID<class_RID>` **get_rid** **(** **)** const
    132. 

  132. 

  133. ----
    134. 

  134. 

  135. .. _class_Navigation_method_get_simple_path:
    136. 

  136. 

  137. - :ref:`PackedVector3Array<class_PackedVector3Array>` **get_simple_path** **(** :ref:`Vector3<class_Vector3>` start, :ref:`Vector3<class_Vector3>` end, :ref:`bool<class_bool>` optimize=true **)** const
    138. 

  138. 

  139. 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.
    140. 

  140.