class_navigationserver3d.rst 204 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationServer3D.xml.
  6. .. _class_NavigationServer3D:
  7. NavigationServer3D
  8. ==================
  9. **Experimental:** This class may be changed or removed in future versions.
  10. **Inherits:** :ref:`Object<class_Object>`
  11. A server interface for low-level 3D navigation access.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. NavigationServer3D is the server that handles navigation maps, regions and agents. It does not handle A\* navigation from :ref:`AStar3D<class_AStar3D>`.
  16. Maps are divided into regions, which are composed of navigation meshes. Together, they define the navigable areas in the 3D world.
  17. \ **Note:** Most **NavigationServer3D** changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation-related nodes in the scene tree or made through scripts.
  18. For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than ``edge_connection_margin`` to the respective other edge's vertex.
  19. You may assign navigation layers to regions with :ref:`region_set_navigation_layers()<class_NavigationServer3D_method_region_set_navigation_layers>`, which then can be checked upon when requesting a path with :ref:`map_get_path()<class_NavigationServer3D_method_map_get_path>`. This can be used to allow or deny certain areas for some objects.
  20. To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
  21. \ **Note:** The collision avoidance system ignores regions. Using the modified velocity directly may move an agent outside of the traversable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.
  22. This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying.
  23. .. rst-class:: classref-introduction-group
  24. Tutorials
  25. ---------
  26. - :doc:`Using NavigationServer <../tutorials/navigation/navigation_using_navigationservers>`
  27. - `3D Navigation Demo <https://godotengine.org/asset-library/asset/2743>`__
  28. .. rst-class:: classref-reftable-group
  29. Methods
  30. -------
  31. .. table::
  32. :widths: auto
  33. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`RID<class_RID>` | :ref:`agent_create<class_NavigationServer3D_method_agent_create>`\ (\ ) |
  35. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`agent_get_avoidance_enabled<class_NavigationServer3D_method_agent_get_avoidance_enabled>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  37. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`agent_get_avoidance_layers<class_NavigationServer3D_method_agent_get_avoidance_layers>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  39. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`int<class_int>` | :ref:`agent_get_avoidance_mask<class_NavigationServer3D_method_agent_get_avoidance_mask>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  41. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`float<class_float>` | :ref:`agent_get_avoidance_priority<class_NavigationServer3D_method_agent_get_avoidance_priority>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  43. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`agent_get_height<class_NavigationServer3D_method_agent_get_height>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  45. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`RID<class_RID>` | :ref:`agent_get_map<class_NavigationServer3D_method_agent_get_map>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  47. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`int<class_int>` | :ref:`agent_get_max_neighbors<class_NavigationServer3D_method_agent_get_max_neighbors>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  49. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`float<class_float>` | :ref:`agent_get_max_speed<class_NavigationServer3D_method_agent_get_max_speed>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  51. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`float<class_float>` | :ref:`agent_get_neighbor_distance<class_NavigationServer3D_method_agent_get_neighbor_distance>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  53. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`agent_get_paused<class_NavigationServer3D_method_agent_get_paused>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  55. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`Vector3<class_Vector3>` | :ref:`agent_get_position<class_NavigationServer3D_method_agent_get_position>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  57. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`float<class_float>` | :ref:`agent_get_radius<class_NavigationServer3D_method_agent_get_radius>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  59. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`float<class_float>` | :ref:`agent_get_time_horizon_agents<class_NavigationServer3D_method_agent_get_time_horizon_agents>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  61. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`agent_get_time_horizon_obstacles<class_NavigationServer3D_method_agent_get_time_horizon_obstacles>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  63. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`agent_get_use_3d_avoidance<class_NavigationServer3D_method_agent_get_use_3d_avoidance>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  65. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Vector3<class_Vector3>` | :ref:`agent_get_velocity<class_NavigationServer3D_method_agent_get_velocity>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  67. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`bool<class_bool>` | :ref:`agent_has_avoidance_callback<class_NavigationServer3D_method_agent_has_avoidance_callback>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  69. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`agent_is_map_changed<class_NavigationServer3D_method_agent_is_map_changed>`\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| |
  71. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | |void| | :ref:`agent_set_avoidance_callback<class_NavigationServer3D_method_agent_set_avoidance_callback>`\ (\ agent\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  73. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | |void| | :ref:`agent_set_avoidance_enabled<class_NavigationServer3D_method_agent_set_avoidance_enabled>`\ (\ agent\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  75. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | |void| | :ref:`agent_set_avoidance_layers<class_NavigationServer3D_method_agent_set_avoidance_layers>`\ (\ agent\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  77. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | |void| | :ref:`agent_set_avoidance_mask<class_NavigationServer3D_method_agent_set_avoidance_mask>`\ (\ agent\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  79. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | |void| | :ref:`agent_set_avoidance_priority<class_NavigationServer3D_method_agent_set_avoidance_priority>`\ (\ agent\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) |
  81. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | |void| | :ref:`agent_set_height<class_NavigationServer3D_method_agent_set_height>`\ (\ agent\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) |
  83. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | |void| | :ref:`agent_set_map<class_NavigationServer3D_method_agent_set_map>`\ (\ agent\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) |
  85. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | |void| | :ref:`agent_set_max_neighbors<class_NavigationServer3D_method_agent_set_max_neighbors>`\ (\ agent\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
  87. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | |void| | :ref:`agent_set_max_speed<class_NavigationServer3D_method_agent_set_max_speed>`\ (\ agent\: :ref:`RID<class_RID>`, max_speed\: :ref:`float<class_float>`\ ) |
  89. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | |void| | :ref:`agent_set_neighbor_distance<class_NavigationServer3D_method_agent_set_neighbor_distance>`\ (\ agent\: :ref:`RID<class_RID>`, distance\: :ref:`float<class_float>`\ ) |
  91. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | |void| | :ref:`agent_set_paused<class_NavigationServer3D_method_agent_set_paused>`\ (\ agent\: :ref:`RID<class_RID>`, paused\: :ref:`bool<class_bool>`\ ) |
  93. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | |void| | :ref:`agent_set_position<class_NavigationServer3D_method_agent_set_position>`\ (\ agent\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) |
  95. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | |void| | :ref:`agent_set_radius<class_NavigationServer3D_method_agent_set_radius>`\ (\ agent\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) |
  97. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | |void| | :ref:`agent_set_time_horizon_agents<class_NavigationServer3D_method_agent_set_time_horizon_agents>`\ (\ agent\: :ref:`RID<class_RID>`, time_horizon\: :ref:`float<class_float>`\ ) |
  99. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | |void| | :ref:`agent_set_time_horizon_obstacles<class_NavigationServer3D_method_agent_set_time_horizon_obstacles>`\ (\ agent\: :ref:`RID<class_RID>`, time_horizon\: :ref:`float<class_float>`\ ) |
  101. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`agent_set_use_3d_avoidance<class_NavigationServer3D_method_agent_set_use_3d_avoidance>`\ (\ agent\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  103. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | |void| | :ref:`agent_set_velocity<class_NavigationServer3D_method_agent_set_velocity>`\ (\ agent\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  105. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | |void| | :ref:`agent_set_velocity_forced<class_NavigationServer3D_method_agent_set_velocity_forced>`\ (\ agent\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  107. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | |void| | :ref:`bake_from_source_geometry_data<class_NavigationServer3D_method_bake_from_source_geometry_data>`\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) |
  109. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`bake_from_source_geometry_data_async<class_NavigationServer3D_method_bake_from_source_geometry_data_async>`\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) |
  111. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |void| | :ref:`free_rid<class_NavigationServer3D_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  113. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`bool<class_bool>` | :ref:`get_debug_enabled<class_NavigationServer3D_method_get_debug_enabled>`\ (\ ) |const| |
  115. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`get_maps<class_NavigationServer3D_method_get_maps>`\ (\ ) |const| |
  117. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`int<class_int>` | :ref:`get_process_info<class_NavigationServer3D_method_get_process_info>`\ (\ process_info\: :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>`\ ) |const| |
  119. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`bool<class_bool>` | :ref:`is_baking_navigation_mesh<class_NavigationServer3D_method_is_baking_navigation_mesh>`\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`\ ) |const| |
  121. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`RID<class_RID>` | :ref:`link_create<class_NavigationServer3D_method_link_create>`\ (\ ) |
  123. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`bool<class_bool>` | :ref:`link_get_enabled<class_NavigationServer3D_method_link_get_enabled>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  125. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`Vector3<class_Vector3>` | :ref:`link_get_end_position<class_NavigationServer3D_method_link_get_end_position>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  127. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`float<class_float>` | :ref:`link_get_enter_cost<class_NavigationServer3D_method_link_get_enter_cost>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  129. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`int<class_int>` | :ref:`link_get_iteration_id<class_NavigationServer3D_method_link_get_iteration_id>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  131. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`RID<class_RID>` | :ref:`link_get_map<class_NavigationServer3D_method_link_get_map>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  133. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`int<class_int>` | :ref:`link_get_navigation_layers<class_NavigationServer3D_method_link_get_navigation_layers>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  135. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`int<class_int>` | :ref:`link_get_owner_id<class_NavigationServer3D_method_link_get_owner_id>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  137. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`Vector3<class_Vector3>` | :ref:`link_get_start_position<class_NavigationServer3D_method_link_get_start_position>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  139. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`float<class_float>` | :ref:`link_get_travel_cost<class_NavigationServer3D_method_link_get_travel_cost>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  141. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`bool<class_bool>` | :ref:`link_is_bidirectional<class_NavigationServer3D_method_link_is_bidirectional>`\ (\ link\: :ref:`RID<class_RID>`\ ) |const| |
  143. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | |void| | :ref:`link_set_bidirectional<class_NavigationServer3D_method_link_set_bidirectional>`\ (\ link\: :ref:`RID<class_RID>`, bidirectional\: :ref:`bool<class_bool>`\ ) |
  145. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | |void| | :ref:`link_set_enabled<class_NavigationServer3D_method_link_set_enabled>`\ (\ link\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  147. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | |void| | :ref:`link_set_end_position<class_NavigationServer3D_method_link_set_end_position>`\ (\ link\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) |
  149. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | |void| | :ref:`link_set_enter_cost<class_NavigationServer3D_method_link_set_enter_cost>`\ (\ link\: :ref:`RID<class_RID>`, enter_cost\: :ref:`float<class_float>`\ ) |
  151. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | |void| | :ref:`link_set_map<class_NavigationServer3D_method_link_set_map>`\ (\ link\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) |
  153. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | |void| | :ref:`link_set_navigation_layers<class_NavigationServer3D_method_link_set_navigation_layers>`\ (\ link\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`\ ) |
  155. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | |void| | :ref:`link_set_owner_id<class_NavigationServer3D_method_link_set_owner_id>`\ (\ link\: :ref:`RID<class_RID>`, owner_id\: :ref:`int<class_int>`\ ) |
  157. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | |void| | :ref:`link_set_start_position<class_NavigationServer3D_method_link_set_start_position>`\ (\ link\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) |
  159. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | |void| | :ref:`link_set_travel_cost<class_NavigationServer3D_method_link_set_travel_cost>`\ (\ link\: :ref:`RID<class_RID>`, travel_cost\: :ref:`float<class_float>`\ ) |
  161. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | :ref:`RID<class_RID>` | :ref:`map_create<class_NavigationServer3D_method_map_create>`\ (\ ) |
  163. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | |void| | :ref:`map_force_update<class_NavigationServer3D_method_map_force_update>`\ (\ map\: :ref:`RID<class_RID>`\ ) |
  165. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`map_get_agents<class_NavigationServer3D_method_map_get_agents>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  167. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | :ref:`float<class_float>` | :ref:`map_get_cell_height<class_NavigationServer3D_method_map_get_cell_height>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  169. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | :ref:`float<class_float>` | :ref:`map_get_cell_size<class_NavigationServer3D_method_map_get_cell_size>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  171. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | :ref:`Vector3<class_Vector3>` | :ref:`map_get_closest_point<class_NavigationServer3D_method_map_get_closest_point>`\ (\ map\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  173. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | :ref:`Vector3<class_Vector3>` | :ref:`map_get_closest_point_normal<class_NavigationServer3D_method_map_get_closest_point_normal>`\ (\ map\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  175. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | :ref:`RID<class_RID>` | :ref:`map_get_closest_point_owner<class_NavigationServer3D_method_map_get_closest_point_owner>`\ (\ map\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  177. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | :ref:`Vector3<class_Vector3>` | :ref:`map_get_closest_point_to_segment<class_NavigationServer3D_method_map_get_closest_point_to_segment>`\ (\ map\: :ref:`RID<class_RID>`, start\: :ref:`Vector3<class_Vector3>`, end\: :ref:`Vector3<class_Vector3>`, use_collision\: :ref:`bool<class_bool>` = false\ ) |const| |
  179. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | :ref:`float<class_float>` | :ref:`map_get_edge_connection_margin<class_NavigationServer3D_method_map_get_edge_connection_margin>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  181. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | :ref:`int<class_int>` | :ref:`map_get_iteration_id<class_NavigationServer3D_method_map_get_iteration_id>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  183. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | :ref:`float<class_float>` | :ref:`map_get_link_connection_radius<class_NavigationServer3D_method_map_get_link_connection_radius>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  185. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`map_get_links<class_NavigationServer3D_method_map_get_links>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  187. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | :ref:`float<class_float>` | :ref:`map_get_merge_rasterizer_cell_scale<class_NavigationServer3D_method_map_get_merge_rasterizer_cell_scale>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  189. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`map_get_obstacles<class_NavigationServer3D_method_map_get_obstacles>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  191. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`map_get_path<class_NavigationServer3D_method_map_get_path>`\ (\ map\: :ref:`RID<class_RID>`, origin\: :ref:`Vector3<class_Vector3>`, destination\: :ref:`Vector3<class_Vector3>`, optimize\: :ref:`bool<class_bool>`, navigation_layers\: :ref:`int<class_int>` = 1\ ) |
  193. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | :ref:`Vector3<class_Vector3>` | :ref:`map_get_random_point<class_NavigationServer3D_method_map_get_random_point>`\ (\ map\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`, uniformly\: :ref:`bool<class_bool>`\ ) |const| |
  195. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`map_get_regions<class_NavigationServer3D_method_map_get_regions>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  197. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | :ref:`Vector3<class_Vector3>` | :ref:`map_get_up<class_NavigationServer3D_method_map_get_up>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  199. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | :ref:`bool<class_bool>` | :ref:`map_get_use_async_iterations<class_NavigationServer3D_method_map_get_use_async_iterations>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  201. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | :ref:`bool<class_bool>` | :ref:`map_get_use_edge_connections<class_NavigationServer3D_method_map_get_use_edge_connections>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  203. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | :ref:`bool<class_bool>` | :ref:`map_is_active<class_NavigationServer3D_method_map_is_active>`\ (\ map\: :ref:`RID<class_RID>`\ ) |const| |
  205. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | |void| | :ref:`map_set_active<class_NavigationServer3D_method_map_set_active>`\ (\ map\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  207. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | |void| | :ref:`map_set_cell_height<class_NavigationServer3D_method_map_set_cell_height>`\ (\ map\: :ref:`RID<class_RID>`, cell_height\: :ref:`float<class_float>`\ ) |
  209. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | |void| | :ref:`map_set_cell_size<class_NavigationServer3D_method_map_set_cell_size>`\ (\ map\: :ref:`RID<class_RID>`, cell_size\: :ref:`float<class_float>`\ ) |
  211. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | |void| | :ref:`map_set_edge_connection_margin<class_NavigationServer3D_method_map_set_edge_connection_margin>`\ (\ map\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  213. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | |void| | :ref:`map_set_link_connection_radius<class_NavigationServer3D_method_map_set_link_connection_radius>`\ (\ map\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) |
  215. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | |void| | :ref:`map_set_merge_rasterizer_cell_scale<class_NavigationServer3D_method_map_set_merge_rasterizer_cell_scale>`\ (\ map\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  217. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | |void| | :ref:`map_set_up<class_NavigationServer3D_method_map_set_up>`\ (\ map\: :ref:`RID<class_RID>`, up\: :ref:`Vector3<class_Vector3>`\ ) |
  219. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | |void| | :ref:`map_set_use_async_iterations<class_NavigationServer3D_method_map_set_use_async_iterations>`\ (\ map\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  221. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | |void| | :ref:`map_set_use_edge_connections<class_NavigationServer3D_method_map_set_use_edge_connections>`\ (\ map\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  223. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | :ref:`RID<class_RID>` | :ref:`obstacle_create<class_NavigationServer3D_method_obstacle_create>`\ (\ ) |
  225. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | :ref:`bool<class_bool>` | :ref:`obstacle_get_avoidance_enabled<class_NavigationServer3D_method_obstacle_get_avoidance_enabled>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  227. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | :ref:`int<class_int>` | :ref:`obstacle_get_avoidance_layers<class_NavigationServer3D_method_obstacle_get_avoidance_layers>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  229. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | :ref:`float<class_float>` | :ref:`obstacle_get_height<class_NavigationServer3D_method_obstacle_get_height>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  231. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | :ref:`RID<class_RID>` | :ref:`obstacle_get_map<class_NavigationServer3D_method_obstacle_get_map>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  233. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | :ref:`bool<class_bool>` | :ref:`obstacle_get_paused<class_NavigationServer3D_method_obstacle_get_paused>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  235. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | :ref:`Vector3<class_Vector3>` | :ref:`obstacle_get_position<class_NavigationServer3D_method_obstacle_get_position>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  237. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | :ref:`float<class_float>` | :ref:`obstacle_get_radius<class_NavigationServer3D_method_obstacle_get_radius>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  239. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`bool<class_bool>` | :ref:`obstacle_get_use_3d_avoidance<class_NavigationServer3D_method_obstacle_get_use_3d_avoidance>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  241. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | :ref:`Vector3<class_Vector3>` | :ref:`obstacle_get_velocity<class_NavigationServer3D_method_obstacle_get_velocity>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  243. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`obstacle_get_vertices<class_NavigationServer3D_method_obstacle_get_vertices>`\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| |
  245. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | |void| | :ref:`obstacle_set_avoidance_enabled<class_NavigationServer3D_method_obstacle_set_avoidance_enabled>`\ (\ obstacle\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  247. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | |void| | :ref:`obstacle_set_avoidance_layers<class_NavigationServer3D_method_obstacle_set_avoidance_layers>`\ (\ obstacle\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  249. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | |void| | :ref:`obstacle_set_height<class_NavigationServer3D_method_obstacle_set_height>`\ (\ obstacle\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) |
  251. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | |void| | :ref:`obstacle_set_map<class_NavigationServer3D_method_obstacle_set_map>`\ (\ obstacle\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) |
  253. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | |void| | :ref:`obstacle_set_paused<class_NavigationServer3D_method_obstacle_set_paused>`\ (\ obstacle\: :ref:`RID<class_RID>`, paused\: :ref:`bool<class_bool>`\ ) |
  255. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | |void| | :ref:`obstacle_set_position<class_NavigationServer3D_method_obstacle_set_position>`\ (\ obstacle\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) |
  257. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | |void| | :ref:`obstacle_set_radius<class_NavigationServer3D_method_obstacle_set_radius>`\ (\ obstacle\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) |
  259. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | |void| | :ref:`obstacle_set_use_3d_avoidance<class_NavigationServer3D_method_obstacle_set_use_3d_avoidance>`\ (\ obstacle\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  261. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | |void| | :ref:`obstacle_set_velocity<class_NavigationServer3D_method_obstacle_set_velocity>`\ (\ obstacle\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  263. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | |void| | :ref:`obstacle_set_vertices<class_NavigationServer3D_method_obstacle_set_vertices>`\ (\ obstacle\: :ref:`RID<class_RID>`, vertices\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) |
  265. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | |void| | :ref:`parse_source_geometry_data<class_NavigationServer3D_method_parse_source_geometry_data>`\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>`, root_node\: :ref:`Node<class_Node>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) |
  267. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | |void| | :ref:`query_path<class_NavigationServer3D_method_query_path>`\ (\ parameters\: :ref:`NavigationPathQueryParameters3D<class_NavigationPathQueryParameters3D>`, result\: :ref:`NavigationPathQueryResult3D<class_NavigationPathQueryResult3D>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) |
  269. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | |void| | :ref:`region_bake_navigation_mesh<class_NavigationServer3D_method_region_bake_navigation_mesh>`\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, root_node\: :ref:`Node<class_Node>`\ ) |
  271. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`RID<class_RID>` | :ref:`region_create<class_NavigationServer3D_method_region_create>`\ (\ ) |
  273. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`AABB<class_AABB>` | :ref:`region_get_bounds<class_NavigationServer3D_method_region_get_bounds>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  275. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`Vector3<class_Vector3>` | :ref:`region_get_closest_point<class_NavigationServer3D_method_region_get_closest_point>`\ (\ region\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  277. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`Vector3<class_Vector3>` | :ref:`region_get_closest_point_normal<class_NavigationServer3D_method_region_get_closest_point_normal>`\ (\ region\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  279. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`Vector3<class_Vector3>` | :ref:`region_get_closest_point_to_segment<class_NavigationServer3D_method_region_get_closest_point_to_segment>`\ (\ region\: :ref:`RID<class_RID>`, start\: :ref:`Vector3<class_Vector3>`, end\: :ref:`Vector3<class_Vector3>`, use_collision\: :ref:`bool<class_bool>` = false\ ) |const| |
  281. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :ref:`Vector3<class_Vector3>` | :ref:`region_get_connection_pathway_end<class_NavigationServer3D_method_region_get_connection_pathway_end>`\ (\ region\: :ref:`RID<class_RID>`, connection\: :ref:`int<class_int>`\ ) |const| |
  283. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :ref:`Vector3<class_Vector3>` | :ref:`region_get_connection_pathway_start<class_NavigationServer3D_method_region_get_connection_pathway_start>`\ (\ region\: :ref:`RID<class_RID>`, connection\: :ref:`int<class_int>`\ ) |const| |
  285. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :ref:`int<class_int>` | :ref:`region_get_connections_count<class_NavigationServer3D_method_region_get_connections_count>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  287. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | :ref:`bool<class_bool>` | :ref:`region_get_enabled<class_NavigationServer3D_method_region_get_enabled>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  289. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | :ref:`float<class_float>` | :ref:`region_get_enter_cost<class_NavigationServer3D_method_region_get_enter_cost>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  291. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | :ref:`int<class_int>` | :ref:`region_get_iteration_id<class_NavigationServer3D_method_region_get_iteration_id>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  293. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | :ref:`RID<class_RID>` | :ref:`region_get_map<class_NavigationServer3D_method_region_get_map>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  295. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :ref:`int<class_int>` | :ref:`region_get_navigation_layers<class_NavigationServer3D_method_region_get_navigation_layers>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  297. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | :ref:`int<class_int>` | :ref:`region_get_owner_id<class_NavigationServer3D_method_region_get_owner_id>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  299. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | :ref:`Vector3<class_Vector3>` | :ref:`region_get_random_point<class_NavigationServer3D_method_region_get_random_point>`\ (\ region\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`, uniformly\: :ref:`bool<class_bool>`\ ) |const| |
  301. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | :ref:`Transform3D<class_Transform3D>` | :ref:`region_get_transform<class_NavigationServer3D_method_region_get_transform>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  303. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | :ref:`float<class_float>` | :ref:`region_get_travel_cost<class_NavigationServer3D_method_region_get_travel_cost>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  305. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | :ref:`bool<class_bool>` | :ref:`region_get_use_edge_connections<class_NavigationServer3D_method_region_get_use_edge_connections>`\ (\ region\: :ref:`RID<class_RID>`\ ) |const| |
  307. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :ref:`bool<class_bool>` | :ref:`region_owns_point<class_NavigationServer3D_method_region_owns_point>`\ (\ region\: :ref:`RID<class_RID>`, point\: :ref:`Vector3<class_Vector3>`\ ) |const| |
  309. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | |void| | :ref:`region_set_enabled<class_NavigationServer3D_method_region_set_enabled>`\ (\ region\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  311. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | |void| | :ref:`region_set_enter_cost<class_NavigationServer3D_method_region_set_enter_cost>`\ (\ region\: :ref:`RID<class_RID>`, enter_cost\: :ref:`float<class_float>`\ ) |
  313. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | |void| | :ref:`region_set_map<class_NavigationServer3D_method_region_set_map>`\ (\ region\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) |
  315. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | |void| | :ref:`region_set_navigation_layers<class_NavigationServer3D_method_region_set_navigation_layers>`\ (\ region\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`\ ) |
  317. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | |void| | :ref:`region_set_navigation_mesh<class_NavigationServer3D_method_region_set_navigation_mesh>`\ (\ region\: :ref:`RID<class_RID>`, navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`\ ) |
  319. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | |void| | :ref:`region_set_owner_id<class_NavigationServer3D_method_region_set_owner_id>`\ (\ region\: :ref:`RID<class_RID>`, owner_id\: :ref:`int<class_int>`\ ) |
  321. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | |void| | :ref:`region_set_transform<class_NavigationServer3D_method_region_set_transform>`\ (\ region\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  323. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | |void| | :ref:`region_set_travel_cost<class_NavigationServer3D_method_region_set_travel_cost>`\ (\ region\: :ref:`RID<class_RID>`, travel_cost\: :ref:`float<class_float>`\ ) |
  325. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | |void| | :ref:`region_set_use_edge_connections<class_NavigationServer3D_method_region_set_use_edge_connections>`\ (\ region\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  327. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | |void| | :ref:`set_active<class_NavigationServer3D_method_set_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  329. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | |void| | :ref:`set_debug_enabled<class_NavigationServer3D_method_set_debug_enabled>`\ (\ enabled\: :ref:`bool<class_bool>`\ ) |
  331. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`simplify_path<class_NavigationServer3D_method_simplify_path>`\ (\ path\: :ref:`PackedVector3Array<class_PackedVector3Array>`, epsilon\: :ref:`float<class_float>`\ ) |
  333. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | :ref:`RID<class_RID>` | :ref:`source_geometry_parser_create<class_NavigationServer3D_method_source_geometry_parser_create>`\ (\ ) |
  335. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | |void| | :ref:`source_geometry_parser_set_callback<class_NavigationServer3D_method_source_geometry_parser_set_callback>`\ (\ parser\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  337. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. .. rst-class:: classref-section-separator
  339. ----
  340. .. rst-class:: classref-descriptions-group
  341. Signals
  342. -------
  343. .. _class_NavigationServer3D_signal_avoidance_debug_changed:
  344. .. rst-class:: classref-signal
  345. **avoidance_debug_changed**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_signal_avoidance_debug_changed>`
  346. Emitted when avoidance debug settings are changed. Only available in debug builds.
  347. .. rst-class:: classref-item-separator
  348. ----
  349. .. _class_NavigationServer3D_signal_map_changed:
  350. .. rst-class:: classref-signal
  351. **map_changed**\ (\ map\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_signal_map_changed>`
  352. Emitted when a navigation map is updated, when a region moves or is modified.
  353. .. rst-class:: classref-item-separator
  354. ----
  355. .. _class_NavigationServer3D_signal_navigation_debug_changed:
  356. .. rst-class:: classref-signal
  357. **navigation_debug_changed**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_signal_navigation_debug_changed>`
  358. Emitted when navigation debug settings are changed. Only available in debug builds.
  359. .. rst-class:: classref-section-separator
  360. ----
  361. .. rst-class:: classref-descriptions-group
  362. Enumerations
  363. ------------
  364. .. _enum_NavigationServer3D_ProcessInfo:
  365. .. rst-class:: classref-enumeration
  366. enum **ProcessInfo**: :ref:`๐Ÿ”—<enum_NavigationServer3D_ProcessInfo>`
  367. .. _class_NavigationServer3D_constant_INFO_ACTIVE_MAPS:
  368. .. rst-class:: classref-enumeration-constant
  369. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_ACTIVE_MAPS** = ``0``
  370. Constant to get the number of active navigation maps.
  371. .. _class_NavigationServer3D_constant_INFO_REGION_COUNT:
  372. .. rst-class:: classref-enumeration-constant
  373. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_REGION_COUNT** = ``1``
  374. Constant to get the number of active navigation regions.
  375. .. _class_NavigationServer3D_constant_INFO_AGENT_COUNT:
  376. .. rst-class:: classref-enumeration-constant
  377. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_AGENT_COUNT** = ``2``
  378. Constant to get the number of active navigation agents processing avoidance.
  379. .. _class_NavigationServer3D_constant_INFO_LINK_COUNT:
  380. .. rst-class:: classref-enumeration-constant
  381. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_LINK_COUNT** = ``3``
  382. Constant to get the number of active navigation links.
  383. .. _class_NavigationServer3D_constant_INFO_POLYGON_COUNT:
  384. .. rst-class:: classref-enumeration-constant
  385. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_POLYGON_COUNT** = ``4``
  386. Constant to get the number of navigation mesh polygons.
  387. .. _class_NavigationServer3D_constant_INFO_EDGE_COUNT:
  388. .. rst-class:: classref-enumeration-constant
  389. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_EDGE_COUNT** = ``5``
  390. Constant to get the number of navigation mesh polygon edges.
  391. .. _class_NavigationServer3D_constant_INFO_EDGE_MERGE_COUNT:
  392. .. rst-class:: classref-enumeration-constant
  393. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_EDGE_MERGE_COUNT** = ``6``
  394. Constant to get the number of navigation mesh polygon edges that were merged due to edge key overlap.
  395. .. _class_NavigationServer3D_constant_INFO_EDGE_CONNECTION_COUNT:
  396. .. rst-class:: classref-enumeration-constant
  397. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_EDGE_CONNECTION_COUNT** = ``7``
  398. Constant to get the number of navigation mesh polygon edges that are considered connected by edge proximity.
  399. .. _class_NavigationServer3D_constant_INFO_EDGE_FREE_COUNT:
  400. .. rst-class:: classref-enumeration-constant
  401. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_EDGE_FREE_COUNT** = ``8``
  402. Constant to get the number of navigation mesh polygon edges that could not be merged but may be still connected by edge proximity or with links.
  403. .. _class_NavigationServer3D_constant_INFO_OBSTACLE_COUNT:
  404. .. rst-class:: classref-enumeration-constant
  405. :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` **INFO_OBSTACLE_COUNT** = ``9``
  406. Constant to get the number of active navigation obstacles.
  407. .. rst-class:: classref-section-separator
  408. ----
  409. .. rst-class:: classref-descriptions-group
  410. Method Descriptions
  411. -------------------
  412. .. _class_NavigationServer3D_method_agent_create:
  413. .. rst-class:: classref-method
  414. :ref:`RID<class_RID>` **agent_create**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_create>`
  415. Creates the agent.
  416. .. rst-class:: classref-item-separator
  417. ----
  418. .. _class_NavigationServer3D_method_agent_get_avoidance_enabled:
  419. .. rst-class:: classref-method
  420. :ref:`bool<class_bool>` **agent_get_avoidance_enabled**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_avoidance_enabled>`
  421. Returns ``true`` if the provided ``agent`` has avoidance enabled.
  422. .. rst-class:: classref-item-separator
  423. ----
  424. .. _class_NavigationServer3D_method_agent_get_avoidance_layers:
  425. .. rst-class:: classref-method
  426. :ref:`int<class_int>` **agent_get_avoidance_layers**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_avoidance_layers>`
  427. Returns the ``avoidance_layers`` bitmask of the specified ``agent``.
  428. .. rst-class:: classref-item-separator
  429. ----
  430. .. _class_NavigationServer3D_method_agent_get_avoidance_mask:
  431. .. rst-class:: classref-method
  432. :ref:`int<class_int>` **agent_get_avoidance_mask**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_avoidance_mask>`
  433. Returns the ``avoidance_mask`` bitmask of the specified ``agent``.
  434. .. rst-class:: classref-item-separator
  435. ----
  436. .. _class_NavigationServer3D_method_agent_get_avoidance_priority:
  437. .. rst-class:: classref-method
  438. :ref:`float<class_float>` **agent_get_avoidance_priority**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_avoidance_priority>`
  439. Returns the ``avoidance_priority`` of the specified ``agent``.
  440. .. rst-class:: classref-item-separator
  441. ----
  442. .. _class_NavigationServer3D_method_agent_get_height:
  443. .. rst-class:: classref-method
  444. :ref:`float<class_float>` **agent_get_height**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_height>`
  445. Returns the ``height`` of the specified ``agent``.
  446. .. rst-class:: classref-item-separator
  447. ----
  448. .. _class_NavigationServer3D_method_agent_get_map:
  449. .. rst-class:: classref-method
  450. :ref:`RID<class_RID>` **agent_get_map**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_map>`
  451. Returns the navigation map :ref:`RID<class_RID>` the requested ``agent`` is currently assigned to.
  452. .. rst-class:: classref-item-separator
  453. ----
  454. .. _class_NavigationServer3D_method_agent_get_max_neighbors:
  455. .. rst-class:: classref-method
  456. :ref:`int<class_int>` **agent_get_max_neighbors**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_max_neighbors>`
  457. Returns the maximum number of other agents the specified ``agent`` takes into account in the navigation.
  458. .. rst-class:: classref-item-separator
  459. ----
  460. .. _class_NavigationServer3D_method_agent_get_max_speed:
  461. .. rst-class:: classref-method
  462. :ref:`float<class_float>` **agent_get_max_speed**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_max_speed>`
  463. Returns the maximum speed of the specified ``agent``.
  464. .. rst-class:: classref-item-separator
  465. ----
  466. .. _class_NavigationServer3D_method_agent_get_neighbor_distance:
  467. .. rst-class:: classref-method
  468. :ref:`float<class_float>` **agent_get_neighbor_distance**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_neighbor_distance>`
  469. Returns the maximum distance to other agents the specified ``agent`` takes into account in the navigation.
  470. .. rst-class:: classref-item-separator
  471. ----
  472. .. _class_NavigationServer3D_method_agent_get_paused:
  473. .. rst-class:: classref-method
  474. :ref:`bool<class_bool>` **agent_get_paused**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_paused>`
  475. Returns ``true`` if the specified ``agent`` is paused.
  476. .. rst-class:: classref-item-separator
  477. ----
  478. .. _class_NavigationServer3D_method_agent_get_position:
  479. .. rst-class:: classref-method
  480. :ref:`Vector3<class_Vector3>` **agent_get_position**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_position>`
  481. Returns the position of the specified ``agent`` in world space.
  482. .. rst-class:: classref-item-separator
  483. ----
  484. .. _class_NavigationServer3D_method_agent_get_radius:
  485. .. rst-class:: classref-method
  486. :ref:`float<class_float>` **agent_get_radius**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_radius>`
  487. Returns the radius of the specified ``agent``.
  488. .. rst-class:: classref-item-separator
  489. ----
  490. .. _class_NavigationServer3D_method_agent_get_time_horizon_agents:
  491. .. rst-class:: classref-method
  492. :ref:`float<class_float>` **agent_get_time_horizon_agents**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_time_horizon_agents>`
  493. Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to other agents.
  494. .. rst-class:: classref-item-separator
  495. ----
  496. .. _class_NavigationServer3D_method_agent_get_time_horizon_obstacles:
  497. .. rst-class:: classref-method
  498. :ref:`float<class_float>` **agent_get_time_horizon_obstacles**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_time_horizon_obstacles>`
  499. Returns the minimal amount of time for which the specified ``agent``'s velocities that are computed by the simulation are safe with respect to static avoidance obstacles.
  500. .. rst-class:: classref-item-separator
  501. ----
  502. .. _class_NavigationServer3D_method_agent_get_use_3d_avoidance:
  503. .. rst-class:: classref-method
  504. :ref:`bool<class_bool>` **agent_get_use_3d_avoidance**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_use_3d_avoidance>`
  505. Returns ``true`` if the provided ``agent`` uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).
  506. .. rst-class:: classref-item-separator
  507. ----
  508. .. _class_NavigationServer3D_method_agent_get_velocity:
  509. .. rst-class:: classref-method
  510. :ref:`Vector3<class_Vector3>` **agent_get_velocity**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_get_velocity>`
  511. Returns the velocity of the specified ``agent``.
  512. .. rst-class:: classref-item-separator
  513. ----
  514. .. _class_NavigationServer3D_method_agent_has_avoidance_callback:
  515. .. rst-class:: classref-method
  516. :ref:`bool<class_bool>` **agent_has_avoidance_callback**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_has_avoidance_callback>`
  517. Return ``true`` if the specified ``agent`` has an avoidance callback.
  518. .. rst-class:: classref-item-separator
  519. ----
  520. .. _class_NavigationServer3D_method_agent_is_map_changed:
  521. .. rst-class:: classref-method
  522. :ref:`bool<class_bool>` **agent_is_map_changed**\ (\ agent\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_is_map_changed>`
  523. Returns ``true`` if the map got changed the previous frame.
  524. .. rst-class:: classref-item-separator
  525. ----
  526. .. _class_NavigationServer3D_method_agent_set_avoidance_callback:
  527. .. rst-class:: classref-method
  528. |void| **agent_set_avoidance_callback**\ (\ agent\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_avoidance_callback>`
  529. Sets the callback :ref:`Callable<class_Callable>` that gets called after each avoidance processing step for the ``agent``. The calculated ``safe_velocity`` will be dispatched with a signal to the object just before the physics calculations.
  530. \ **Note:** Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use :ref:`agent_set_avoidance_callback()<class_NavigationServer3D_method_agent_set_avoidance_callback>` again with an empty :ref:`Callable<class_Callable>`.
  531. .. rst-class:: classref-item-separator
  532. ----
  533. .. _class_NavigationServer3D_method_agent_set_avoidance_enabled:
  534. .. rst-class:: classref-method
  535. |void| **agent_set_avoidance_enabled**\ (\ agent\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_avoidance_enabled>`
  536. If ``enabled`` is ``true``, the provided ``agent`` calculates avoidance.
  537. .. rst-class:: classref-item-separator
  538. ----
  539. .. _class_NavigationServer3D_method_agent_set_avoidance_layers:
  540. .. rst-class:: classref-method
  541. |void| **agent_set_avoidance_layers**\ (\ agent\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_avoidance_layers>`
  542. Set the agent's ``avoidance_layers`` bitmask.
  543. .. rst-class:: classref-item-separator
  544. ----
  545. .. _class_NavigationServer3D_method_agent_set_avoidance_mask:
  546. .. rst-class:: classref-method
  547. |void| **agent_set_avoidance_mask**\ (\ agent\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_avoidance_mask>`
  548. Set the agent's ``avoidance_mask`` bitmask.
  549. .. rst-class:: classref-item-separator
  550. ----
  551. .. _class_NavigationServer3D_method_agent_set_avoidance_priority:
  552. .. rst-class:: classref-method
  553. |void| **agent_set_avoidance_priority**\ (\ agent\: :ref:`RID<class_RID>`, priority\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_avoidance_priority>`
  554. Set the agent's ``avoidance_priority`` with a ``priority`` between 0.0 (lowest priority) to 1.0 (highest priority).
  555. The specified ``agent`` does not adjust the velocity for other agents that would match the ``avoidance_mask`` but have a lower ``avoidance_priority``. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.
  556. .. rst-class:: classref-item-separator
  557. ----
  558. .. _class_NavigationServer3D_method_agent_set_height:
  559. .. rst-class:: classref-method
  560. |void| **agent_set_height**\ (\ agent\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_height>`
  561. Updates the provided ``agent`` ``height``.
  562. .. rst-class:: classref-item-separator
  563. ----
  564. .. _class_NavigationServer3D_method_agent_set_map:
  565. .. rst-class:: classref-method
  566. |void| **agent_set_map**\ (\ agent\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_map>`
  567. Puts the agent in the map.
  568. .. rst-class:: classref-item-separator
  569. ----
  570. .. _class_NavigationServer3D_method_agent_set_max_neighbors:
  571. .. rst-class:: classref-method
  572. |void| **agent_set_max_neighbors**\ (\ agent\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_max_neighbors>`
  573. Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.
  574. .. rst-class:: classref-item-separator
  575. ----
  576. .. _class_NavigationServer3D_method_agent_set_max_speed:
  577. .. rst-class:: classref-method
  578. |void| **agent_set_max_speed**\ (\ agent\: :ref:`RID<class_RID>`, max_speed\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_max_speed>`
  579. Sets the maximum speed of the agent. Must be positive.
  580. .. rst-class:: classref-item-separator
  581. ----
  582. .. _class_NavigationServer3D_method_agent_set_neighbor_distance:
  583. .. rst-class:: classref-method
  584. |void| **agent_set_neighbor_distance**\ (\ agent\: :ref:`RID<class_RID>`, distance\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_neighbor_distance>`
  585. Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.
  586. .. rst-class:: classref-item-separator
  587. ----
  588. .. _class_NavigationServer3D_method_agent_set_paused:
  589. .. rst-class:: classref-method
  590. |void| **agent_set_paused**\ (\ agent\: :ref:`RID<class_RID>`, paused\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_paused>`
  591. If ``paused`` is ``true`` the specified ``agent`` will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks.
  592. .. rst-class:: classref-item-separator
  593. ----
  594. .. _class_NavigationServer3D_method_agent_set_position:
  595. .. rst-class:: classref-method
  596. |void| **agent_set_position**\ (\ agent\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_position>`
  597. Sets the position of the agent in world space.
  598. .. rst-class:: classref-item-separator
  599. ----
  600. .. _class_NavigationServer3D_method_agent_set_radius:
  601. .. rst-class:: classref-method
  602. |void| **agent_set_radius**\ (\ agent\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_radius>`
  603. Sets the radius of the agent.
  604. .. rst-class:: classref-item-separator
  605. ----
  606. .. _class_NavigationServer3D_method_agent_set_time_horizon_agents:
  607. .. rst-class:: classref-method
  608. |void| **agent_set_time_horizon_agents**\ (\ agent\: :ref:`RID<class_RID>`, time_horizon\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_time_horizon_agents>`
  609. The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
  610. .. rst-class:: classref-item-separator
  611. ----
  612. .. _class_NavigationServer3D_method_agent_set_time_horizon_obstacles:
  613. .. rst-class:: classref-method
  614. |void| **agent_set_time_horizon_obstacles**\ (\ agent\: :ref:`RID<class_RID>`, time_horizon\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_time_horizon_obstacles>`
  615. The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
  616. .. rst-class:: classref-item-separator
  617. ----
  618. .. _class_NavigationServer3D_method_agent_set_use_3d_avoidance:
  619. .. rst-class:: classref-method
  620. |void| **agent_set_use_3d_avoidance**\ (\ agent\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_use_3d_avoidance>`
  621. Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled.
  622. If ``true`` the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, underwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's.
  623. If ``false`` the agent calculates avoidance velocities in 2D along the xz-axis ignoring the y-axis. The 2D using agent only avoids other 2D avoidance using agent's. The 2D using agent reacts to radius avoidance obstacles. The 2D using agent reacts to vertices based avoidance obstacles. The 2D using agent only avoids other 2D using agent's. 2D using agents will ignore other 2D using agents or obstacles that are below their current position or above their current position including the agents height in 2D avoidance.
  624. .. rst-class:: classref-item-separator
  625. ----
  626. .. _class_NavigationServer3D_method_agent_set_velocity:
  627. .. rst-class:: classref-method
  628. |void| **agent_set_velocity**\ (\ agent\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_velocity>`
  629. Sets ``velocity`` as the new wanted velocity for the specified ``agent``. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position use :ref:`agent_set_velocity_forced()<class_NavigationServer3D_method_agent_set_velocity_forced>` as well to reset the internal simulation velocity.
  630. .. rst-class:: classref-item-separator
  631. ----
  632. .. _class_NavigationServer3D_method_agent_set_velocity_forced:
  633. .. rst-class:: classref-method
  634. |void| **agent_set_velocity_forced**\ (\ agent\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_agent_set_velocity_forced>`
  635. Replaces the internal velocity in the collision avoidance simulation with ``velocity`` for the specified ``agent``. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck.
  636. .. rst-class:: classref-item-separator
  637. ----
  638. .. _class_NavigationServer3D_method_bake_from_source_geometry_data:
  639. .. rst-class:: classref-method
  640. |void| **bake_from_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_bake_from_source_geometry_data>`
  641. Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data``. After the process is finished the optional ``callback`` will be called.
  642. .. rst-class:: classref-item-separator
  643. ----
  644. .. _class_NavigationServer3D_method_bake_from_source_geometry_data_async:
  645. .. rst-class:: classref-method
  646. |void| **bake_from_source_geometry_data_async**\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_bake_from_source_geometry_data_async>`
  647. Bakes the provided ``navigation_mesh`` with the data from the provided ``source_geometry_data`` as an async task running on a background thread. After the process is finished the optional ``callback`` will be called.
  648. .. rst-class:: classref-item-separator
  649. ----
  650. .. _class_NavigationServer3D_method_free_rid:
  651. .. rst-class:: classref-method
  652. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_free_rid>`
  653. Destroys the given RID.
  654. .. rst-class:: classref-item-separator
  655. ----
  656. .. _class_NavigationServer3D_method_get_debug_enabled:
  657. .. rst-class:: classref-method
  658. :ref:`bool<class_bool>` **get_debug_enabled**\ (\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_get_debug_enabled>`
  659. Returns ``true`` when the NavigationServer has debug enabled.
  660. .. rst-class:: classref-item-separator
  661. ----
  662. .. _class_NavigationServer3D_method_get_maps:
  663. .. rst-class:: classref-method
  664. :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **get_maps**\ (\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_get_maps>`
  665. Returns all created navigation map :ref:`RID<class_RID>`\ s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them.
  666. .. rst-class:: classref-item-separator
  667. ----
  668. .. _class_NavigationServer3D_method_get_process_info:
  669. .. rst-class:: classref-method
  670. :ref:`int<class_int>` **get_process_info**\ (\ process_info\: :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_get_process_info>`
  671. Returns information about the current state of the NavigationServer. See :ref:`ProcessInfo<enum_NavigationServer3D_ProcessInfo>` for a list of available states.
  672. .. rst-class:: classref-item-separator
  673. ----
  674. .. _class_NavigationServer3D_method_is_baking_navigation_mesh:
  675. .. rst-class:: classref-method
  676. :ref:`bool<class_bool>` **is_baking_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_is_baking_navigation_mesh>`
  677. Returns ``true`` when the provided navigation mesh is being baked on a background thread.
  678. .. rst-class:: classref-item-separator
  679. ----
  680. .. _class_NavigationServer3D_method_link_create:
  681. .. rst-class:: classref-method
  682. :ref:`RID<class_RID>` **link_create**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_create>`
  683. Create a new link between two positions on a map.
  684. .. rst-class:: classref-item-separator
  685. ----
  686. .. _class_NavigationServer3D_method_link_get_enabled:
  687. .. rst-class:: classref-method
  688. :ref:`bool<class_bool>` **link_get_enabled**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_enabled>`
  689. Returns ``true`` if the specified ``link`` is enabled.
  690. .. rst-class:: classref-item-separator
  691. ----
  692. .. _class_NavigationServer3D_method_link_get_end_position:
  693. .. rst-class:: classref-method
  694. :ref:`Vector3<class_Vector3>` **link_get_end_position**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_end_position>`
  695. Returns the ending position of this ``link``.
  696. .. rst-class:: classref-item-separator
  697. ----
  698. .. _class_NavigationServer3D_method_link_get_enter_cost:
  699. .. rst-class:: classref-method
  700. :ref:`float<class_float>` **link_get_enter_cost**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_enter_cost>`
  701. Returns the enter cost of this ``link``.
  702. .. rst-class:: classref-item-separator
  703. ----
  704. .. _class_NavigationServer3D_method_link_get_iteration_id:
  705. .. rst-class:: classref-method
  706. :ref:`int<class_int>` **link_get_iteration_id**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_iteration_id>`
  707. Returns the current iteration ID of the navigation link. Every time the navigation link changes and synchronizes, the iteration ID increases. An iteration ID of ``0`` means the navigation link has never synchronized.
  708. \ **Note:** The iteration ID will wrap around to ``1`` after reaching its range limit.
  709. .. rst-class:: classref-item-separator
  710. ----
  711. .. _class_NavigationServer3D_method_link_get_map:
  712. .. rst-class:: classref-method
  713. :ref:`RID<class_RID>` **link_get_map**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_map>`
  714. Returns the navigation map :ref:`RID<class_RID>` the requested ``link`` is currently assigned to.
  715. .. rst-class:: classref-item-separator
  716. ----
  717. .. _class_NavigationServer3D_method_link_get_navigation_layers:
  718. .. rst-class:: classref-method
  719. :ref:`int<class_int>` **link_get_navigation_layers**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_navigation_layers>`
  720. Returns the navigation layers for this ``link``.
  721. .. rst-class:: classref-item-separator
  722. ----
  723. .. _class_NavigationServer3D_method_link_get_owner_id:
  724. .. rst-class:: classref-method
  725. :ref:`int<class_int>` **link_get_owner_id**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_owner_id>`
  726. Returns the ``ObjectID`` of the object which manages this link.
  727. .. rst-class:: classref-item-separator
  728. ----
  729. .. _class_NavigationServer3D_method_link_get_start_position:
  730. .. rst-class:: classref-method
  731. :ref:`Vector3<class_Vector3>` **link_get_start_position**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_start_position>`
  732. Returns the starting position of this ``link``.
  733. .. rst-class:: classref-item-separator
  734. ----
  735. .. _class_NavigationServer3D_method_link_get_travel_cost:
  736. .. rst-class:: classref-method
  737. :ref:`float<class_float>` **link_get_travel_cost**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_get_travel_cost>`
  738. Returns the travel cost of this ``link``.
  739. .. rst-class:: classref-item-separator
  740. ----
  741. .. _class_NavigationServer3D_method_link_is_bidirectional:
  742. .. rst-class:: classref-method
  743. :ref:`bool<class_bool>` **link_is_bidirectional**\ (\ link\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_is_bidirectional>`
  744. Returns whether this ``link`` can be travelled in both directions.
  745. .. rst-class:: classref-item-separator
  746. ----
  747. .. _class_NavigationServer3D_method_link_set_bidirectional:
  748. .. rst-class:: classref-method
  749. |void| **link_set_bidirectional**\ (\ link\: :ref:`RID<class_RID>`, bidirectional\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_bidirectional>`
  750. Sets whether this ``link`` can be travelled in both directions.
  751. .. rst-class:: classref-item-separator
  752. ----
  753. .. _class_NavigationServer3D_method_link_set_enabled:
  754. .. rst-class:: classref-method
  755. |void| **link_set_enabled**\ (\ link\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_enabled>`
  756. If ``enabled`` is ``true``, the specified ``link`` will contribute to its current navigation map.
  757. .. rst-class:: classref-item-separator
  758. ----
  759. .. _class_NavigationServer3D_method_link_set_end_position:
  760. .. rst-class:: classref-method
  761. |void| **link_set_end_position**\ (\ link\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_end_position>`
  762. Sets the exit position for the ``link``.
  763. .. rst-class:: classref-item-separator
  764. ----
  765. .. _class_NavigationServer3D_method_link_set_enter_cost:
  766. .. rst-class:: classref-method
  767. |void| **link_set_enter_cost**\ (\ link\: :ref:`RID<class_RID>`, enter_cost\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_enter_cost>`
  768. Sets the ``enter_cost`` for this ``link``.
  769. .. rst-class:: classref-item-separator
  770. ----
  771. .. _class_NavigationServer3D_method_link_set_map:
  772. .. rst-class:: classref-method
  773. |void| **link_set_map**\ (\ link\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_map>`
  774. Sets the navigation map :ref:`RID<class_RID>` for the link.
  775. .. rst-class:: classref-item-separator
  776. ----
  777. .. _class_NavigationServer3D_method_link_set_navigation_layers:
  778. .. rst-class:: classref-method
  779. |void| **link_set_navigation_layers**\ (\ link\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_navigation_layers>`
  780. Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path()<class_NavigationServer3D_method_map_get_path>`).
  781. .. rst-class:: classref-item-separator
  782. ----
  783. .. _class_NavigationServer3D_method_link_set_owner_id:
  784. .. rst-class:: classref-method
  785. |void| **link_set_owner_id**\ (\ link\: :ref:`RID<class_RID>`, owner_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_owner_id>`
  786. Set the ``ObjectID`` of the object which manages this link.
  787. .. rst-class:: classref-item-separator
  788. ----
  789. .. _class_NavigationServer3D_method_link_set_start_position:
  790. .. rst-class:: classref-method
  791. |void| **link_set_start_position**\ (\ link\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_start_position>`
  792. Sets the entry position for this ``link``.
  793. .. rst-class:: classref-item-separator
  794. ----
  795. .. _class_NavigationServer3D_method_link_set_travel_cost:
  796. .. rst-class:: classref-method
  797. |void| **link_set_travel_cost**\ (\ link\: :ref:`RID<class_RID>`, travel_cost\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_link_set_travel_cost>`
  798. Sets the ``travel_cost`` for this ``link``.
  799. .. rst-class:: classref-item-separator
  800. ----
  801. .. _class_NavigationServer3D_method_map_create:
  802. .. rst-class:: classref-method
  803. :ref:`RID<class_RID>` **map_create**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_create>`
  804. Create a new map.
  805. .. rst-class:: classref-item-separator
  806. ----
  807. .. _class_NavigationServer3D_method_map_force_update:
  808. .. rst-class:: classref-method
  809. |void| **map_force_update**\ (\ map\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_force_update>`
  810. **Deprecated:** This method is no longer supported, as it is incompatible with asynchronous updates. It can only be used in a single-threaded context, at your own risk.
  811. This function immediately forces synchronization of the specified navigation ``map`` :ref:`RID<class_RID>`. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed).
  812. Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update.
  813. Avoidance processing and dispatch of the ``safe_velocity`` signals is unaffected by this function and continues to happen for all maps and agents at the end of the physics frame.
  814. \ **Note:** With great power comes great responsibility. This function should only be used by users that really know what they are doing and have a good reason for it. Forcing an immediate update of a navigation map requires locking the NavigationServer and flushing the entire NavigationServer command queue. Not only can this severely impact the performance of a game but it can also introduce bugs if used inappropriately without much foresight.
  815. .. rst-class:: classref-item-separator
  816. ----
  817. .. _class_NavigationServer3D_method_map_get_agents:
  818. .. rst-class:: classref-method
  819. :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **map_get_agents**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_agents>`
  820. Returns all navigation agents :ref:`RID<class_RID>`\ s that are currently assigned to the requested navigation ``map``.
  821. .. rst-class:: classref-item-separator
  822. ----
  823. .. _class_NavigationServer3D_method_map_get_cell_height:
  824. .. rst-class:: classref-method
  825. :ref:`float<class_float>` **map_get_cell_height**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_cell_height>`
  826. Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis.
  827. .. rst-class:: classref-item-separator
  828. ----
  829. .. _class_NavigationServer3D_method_map_get_cell_size:
  830. .. rst-class:: classref-method
  831. :ref:`float<class_float>` **map_get_cell_size**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_cell_size>`
  832. Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane.
  833. .. rst-class:: classref-item-separator
  834. ----
  835. .. _class_NavigationServer3D_method_map_get_closest_point:
  836. .. rst-class:: classref-method
  837. :ref:`Vector3<class_Vector3>` **map_get_closest_point**\ (\ map\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_closest_point>`
  838. Returns the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``map``.
  839. .. rst-class:: classref-item-separator
  840. ----
  841. .. _class_NavigationServer3D_method_map_get_closest_point_normal:
  842. .. rst-class:: classref-method
  843. :ref:`Vector3<class_Vector3>` **map_get_closest_point_normal**\ (\ map\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_closest_point_normal>`
  844. Returns the navigation mesh surface normal closest to the provided ``to_point`` on the navigation ``map``.
  845. .. rst-class:: classref-item-separator
  846. ----
  847. .. _class_NavigationServer3D_method_map_get_closest_point_owner:
  848. .. rst-class:: classref-method
  849. :ref:`RID<class_RID>` **map_get_closest_point_owner**\ (\ map\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_closest_point_owner>`
  850. Returns the owner region RID for the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``map``.
  851. .. rst-class:: classref-item-separator
  852. ----
  853. .. _class_NavigationServer3D_method_map_get_closest_point_to_segment:
  854. .. rst-class:: classref-method
  855. :ref:`Vector3<class_Vector3>` **map_get_closest_point_to_segment**\ (\ map\: :ref:`RID<class_RID>`, start\: :ref:`Vector3<class_Vector3>`, end\: :ref:`Vector3<class_Vector3>`, use_collision\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_closest_point_to_segment>`
  856. Returns the navigation mesh surface point closest to the provided ``start`` and ``end`` segment on the navigation ``map``.
  857. If ``use_collision`` is ``true``, a closest point test is only done when the segment intersects with the navigation mesh surface.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _class_NavigationServer3D_method_map_get_edge_connection_margin:
  861. .. rst-class:: classref-method
  862. :ref:`float<class_float>` **map_get_edge_connection_margin**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_edge_connection_margin>`
  863. Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions.
  864. .. rst-class:: classref-item-separator
  865. ----
  866. .. _class_NavigationServer3D_method_map_get_iteration_id:
  867. .. rst-class:: classref-method
  868. :ref:`int<class_int>` **map_get_iteration_id**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_iteration_id>`
  869. Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized.
  870. \ **Note:** The iteration id will wrap back to 1 after reaching its range limit.
  871. .. rst-class:: classref-item-separator
  872. ----
  873. .. _class_NavigationServer3D_method_map_get_link_connection_radius:
  874. .. rst-class:: classref-method
  875. :ref:`float<class_float>` **map_get_link_connection_radius**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_link_connection_radius>`
  876. Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to.
  877. .. rst-class:: classref-item-separator
  878. ----
  879. .. _class_NavigationServer3D_method_map_get_links:
  880. .. rst-class:: classref-method
  881. :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **map_get_links**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_links>`
  882. Returns all navigation link :ref:`RID<class_RID>`\ s that are currently assigned to the requested navigation ``map``.
  883. .. rst-class:: classref-item-separator
  884. ----
  885. .. _class_NavigationServer3D_method_map_get_merge_rasterizer_cell_scale:
  886. .. rst-class:: classref-method
  887. :ref:`float<class_float>` **map_get_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_merge_rasterizer_cell_scale>`
  888. Returns map's internal merge rasterizer cell scale.
  889. .. rst-class:: classref-item-separator
  890. ----
  891. .. _class_NavigationServer3D_method_map_get_obstacles:
  892. .. rst-class:: classref-method
  893. :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **map_get_obstacles**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_obstacles>`
  894. Returns all navigation obstacle :ref:`RID<class_RID>`\ s that are currently assigned to the requested navigation ``map``.
  895. .. rst-class:: classref-item-separator
  896. ----
  897. .. _class_NavigationServer3D_method_map_get_path:
  898. .. rst-class:: classref-method
  899. :ref:`PackedVector3Array<class_PackedVector3Array>` **map_get_path**\ (\ map\: :ref:`RID<class_RID>`, origin\: :ref:`Vector3<class_Vector3>`, destination\: :ref:`Vector3<class_Vector3>`, optimize\: :ref:`bool<class_bool>`, navigation_layers\: :ref:`int<class_int>` = 1\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_path>`
  900. Returns the navigation path to reach the destination from the origin. ``navigation_layers`` is a bitmask of all region navigation layers that are allowed to be in the path.
  901. .. rst-class:: classref-item-separator
  902. ----
  903. .. _class_NavigationServer3D_method_map_get_random_point:
  904. .. rst-class:: classref-method
  905. :ref:`Vector3<class_Vector3>` **map_get_random_point**\ (\ map\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`, uniformly\: :ref:`bool<class_bool>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_random_point>`
  906. Returns a random position picked from all map region polygons with matching ``navigation_layers``.
  907. If ``uniformly`` is ``true``, all map regions, polygons, and faces are weighted by their surface area (slower).
  908. If ``uniformly`` is ``false``, just a random region and a random polygon are picked (faster).
  909. .. rst-class:: classref-item-separator
  910. ----
  911. .. _class_NavigationServer3D_method_map_get_regions:
  912. .. rst-class:: classref-method
  913. :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **map_get_regions**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_regions>`
  914. Returns all navigation regions :ref:`RID<class_RID>`\ s that are currently assigned to the requested navigation ``map``.
  915. .. rst-class:: classref-item-separator
  916. ----
  917. .. _class_NavigationServer3D_method_map_get_up:
  918. .. rst-class:: classref-method
  919. :ref:`Vector3<class_Vector3>` **map_get_up**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_up>`
  920. Returns the map's up direction.
  921. .. rst-class:: classref-item-separator
  922. ----
  923. .. _class_NavigationServer3D_method_map_get_use_async_iterations:
  924. .. rst-class:: classref-method
  925. :ref:`bool<class_bool>` **map_get_use_async_iterations**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_use_async_iterations>`
  926. Returns ``true`` if the ``map`` synchronization uses an async process that runs on a background thread.
  927. .. rst-class:: classref-item-separator
  928. ----
  929. .. _class_NavigationServer3D_method_map_get_use_edge_connections:
  930. .. rst-class:: classref-method
  931. :ref:`bool<class_bool>` **map_get_use_edge_connections**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_get_use_edge_connections>`
  932. Returns ``true`` if the navigation ``map`` allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
  933. .. rst-class:: classref-item-separator
  934. ----
  935. .. _class_NavigationServer3D_method_map_is_active:
  936. .. rst-class:: classref-method
  937. :ref:`bool<class_bool>` **map_is_active**\ (\ map\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_is_active>`
  938. Returns ``true`` if the map is active.
  939. .. rst-class:: classref-item-separator
  940. ----
  941. .. _class_NavigationServer3D_method_map_set_active:
  942. .. rst-class:: classref-method
  943. |void| **map_set_active**\ (\ map\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_active>`
  944. Sets the map active.
  945. .. rst-class:: classref-item-separator
  946. ----
  947. .. _class_NavigationServer3D_method_map_set_cell_height:
  948. .. rst-class:: classref-method
  949. |void| **map_set_cell_height**\ (\ map\: :ref:`RID<class_RID>`, cell_height\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_cell_height>`
  950. Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes.
  951. .. rst-class:: classref-item-separator
  952. ----
  953. .. _class_NavigationServer3D_method_map_set_cell_size:
  954. .. rst-class:: classref-method
  955. |void| **map_set_cell_size**\ (\ map\: :ref:`RID<class_RID>`, cell_size\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_cell_size>`
  956. Sets the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size of the used navigation meshes.
  957. .. rst-class:: classref-item-separator
  958. ----
  959. .. _class_NavigationServer3D_method_map_set_edge_connection_margin:
  960. .. rst-class:: classref-method
  961. |void| **map_set_edge_connection_margin**\ (\ map\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_edge_connection_margin>`
  962. Set the map edge connection margin used to weld the compatible region edges.
  963. .. rst-class:: classref-item-separator
  964. ----
  965. .. _class_NavigationServer3D_method_map_set_link_connection_radius:
  966. .. rst-class:: classref-method
  967. |void| **map_set_link_connection_radius**\ (\ map\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_link_connection_radius>`
  968. Set the map's link connection radius used to connect links to navigation polygons.
  969. .. rst-class:: classref-item-separator
  970. ----
  971. .. _class_NavigationServer3D_method_map_set_merge_rasterizer_cell_scale:
  972. .. rst-class:: classref-method
  973. |void| **map_set_merge_rasterizer_cell_scale**\ (\ map\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_merge_rasterizer_cell_scale>`
  974. Set the map's internal merge rasterizer cell scale used to control merging sensitivity.
  975. .. rst-class:: classref-item-separator
  976. ----
  977. .. _class_NavigationServer3D_method_map_set_up:
  978. .. rst-class:: classref-method
  979. |void| **map_set_up**\ (\ map\: :ref:`RID<class_RID>`, up\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_up>`
  980. Sets the map up direction.
  981. .. rst-class:: classref-item-separator
  982. ----
  983. .. _class_NavigationServer3D_method_map_set_use_async_iterations:
  984. .. rst-class:: classref-method
  985. |void| **map_set_use_async_iterations**\ (\ map\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_use_async_iterations>`
  986. If ``enabled`` is ``true`` the ``map`` synchronization uses an async process that runs on a background thread.
  987. .. rst-class:: classref-item-separator
  988. ----
  989. .. _class_NavigationServer3D_method_map_set_use_edge_connections:
  990. .. rst-class:: classref-method
  991. |void| **map_set_use_edge_connections**\ (\ map\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_map_set_use_edge_connections>`
  992. Set the navigation ``map`` edge connection use. If ``enabled`` is ``true``, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
  993. .. rst-class:: classref-item-separator
  994. ----
  995. .. _class_NavigationServer3D_method_obstacle_create:
  996. .. rst-class:: classref-method
  997. :ref:`RID<class_RID>` **obstacle_create**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_create>`
  998. Creates a new obstacle.
  999. .. rst-class:: classref-item-separator
  1000. ----
  1001. .. _class_NavigationServer3D_method_obstacle_get_avoidance_enabled:
  1002. .. rst-class:: classref-method
  1003. :ref:`bool<class_bool>` **obstacle_get_avoidance_enabled**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_avoidance_enabled>`
  1004. Returns ``true`` if the provided ``obstacle`` has avoidance enabled.
  1005. .. rst-class:: classref-item-separator
  1006. ----
  1007. .. _class_NavigationServer3D_method_obstacle_get_avoidance_layers:
  1008. .. rst-class:: classref-method
  1009. :ref:`int<class_int>` **obstacle_get_avoidance_layers**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_avoidance_layers>`
  1010. Returns the ``avoidance_layers`` bitmask of the specified ``obstacle``.
  1011. .. rst-class:: classref-item-separator
  1012. ----
  1013. .. _class_NavigationServer3D_method_obstacle_get_height:
  1014. .. rst-class:: classref-method
  1015. :ref:`float<class_float>` **obstacle_get_height**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_height>`
  1016. Returns the ``height`` of the specified ``obstacle``.
  1017. .. rst-class:: classref-item-separator
  1018. ----
  1019. .. _class_NavigationServer3D_method_obstacle_get_map:
  1020. .. rst-class:: classref-method
  1021. :ref:`RID<class_RID>` **obstacle_get_map**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_map>`
  1022. Returns the navigation map :ref:`RID<class_RID>` the requested ``obstacle`` is currently assigned to.
  1023. .. rst-class:: classref-item-separator
  1024. ----
  1025. .. _class_NavigationServer3D_method_obstacle_get_paused:
  1026. .. rst-class:: classref-method
  1027. :ref:`bool<class_bool>` **obstacle_get_paused**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_paused>`
  1028. Returns ``true`` if the specified ``obstacle`` is paused.
  1029. .. rst-class:: classref-item-separator
  1030. ----
  1031. .. _class_NavigationServer3D_method_obstacle_get_position:
  1032. .. rst-class:: classref-method
  1033. :ref:`Vector3<class_Vector3>` **obstacle_get_position**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_position>`
  1034. Returns the position of the specified ``obstacle`` in world space.
  1035. .. rst-class:: classref-item-separator
  1036. ----
  1037. .. _class_NavigationServer3D_method_obstacle_get_radius:
  1038. .. rst-class:: classref-method
  1039. :ref:`float<class_float>` **obstacle_get_radius**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_radius>`
  1040. Returns the radius of the specified dynamic ``obstacle``.
  1041. .. rst-class:: classref-item-separator
  1042. ----
  1043. .. _class_NavigationServer3D_method_obstacle_get_use_3d_avoidance:
  1044. .. rst-class:: classref-method
  1045. :ref:`bool<class_bool>` **obstacle_get_use_3d_avoidance**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_use_3d_avoidance>`
  1046. Returns ``true`` if the provided ``obstacle`` uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).
  1047. .. rst-class:: classref-item-separator
  1048. ----
  1049. .. _class_NavigationServer3D_method_obstacle_get_velocity:
  1050. .. rst-class:: classref-method
  1051. :ref:`Vector3<class_Vector3>` **obstacle_get_velocity**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_velocity>`
  1052. Returns the velocity of the specified dynamic ``obstacle``.
  1053. .. rst-class:: classref-item-separator
  1054. ----
  1055. .. _class_NavigationServer3D_method_obstacle_get_vertices:
  1056. .. rst-class:: classref-method
  1057. :ref:`PackedVector3Array<class_PackedVector3Array>` **obstacle_get_vertices**\ (\ obstacle\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_get_vertices>`
  1058. Returns the outline vertices for the specified ``obstacle``.
  1059. .. rst-class:: classref-item-separator
  1060. ----
  1061. .. _class_NavigationServer3D_method_obstacle_set_avoidance_enabled:
  1062. .. rst-class:: classref-method
  1063. |void| **obstacle_set_avoidance_enabled**\ (\ obstacle\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_avoidance_enabled>`
  1064. If ``enabled`` is ``true``, the provided ``obstacle`` affects avoidance using agents.
  1065. .. rst-class:: classref-item-separator
  1066. ----
  1067. .. _class_NavigationServer3D_method_obstacle_set_avoidance_layers:
  1068. .. rst-class:: classref-method
  1069. |void| **obstacle_set_avoidance_layers**\ (\ obstacle\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_avoidance_layers>`
  1070. Set the obstacles's ``avoidance_layers`` bitmask.
  1071. .. rst-class:: classref-item-separator
  1072. ----
  1073. .. _class_NavigationServer3D_method_obstacle_set_height:
  1074. .. rst-class:: classref-method
  1075. |void| **obstacle_set_height**\ (\ obstacle\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_height>`
  1076. Sets the ``height`` for the ``obstacle``. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance.
  1077. .. rst-class:: classref-item-separator
  1078. ----
  1079. .. _class_NavigationServer3D_method_obstacle_set_map:
  1080. .. rst-class:: classref-method
  1081. |void| **obstacle_set_map**\ (\ obstacle\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_map>`
  1082. Assigns the ``obstacle`` to a navigation map.
  1083. .. rst-class:: classref-item-separator
  1084. ----
  1085. .. _class_NavigationServer3D_method_obstacle_set_paused:
  1086. .. rst-class:: classref-method
  1087. |void| **obstacle_set_paused**\ (\ obstacle\: :ref:`RID<class_RID>`, paused\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_paused>`
  1088. If ``paused`` is ``true`` the specified ``obstacle`` will not be processed, e.g. affect avoidance velocities.
  1089. .. rst-class:: classref-item-separator
  1090. ----
  1091. .. _class_NavigationServer3D_method_obstacle_set_position:
  1092. .. rst-class:: classref-method
  1093. |void| **obstacle_set_position**\ (\ obstacle\: :ref:`RID<class_RID>`, position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_position>`
  1094. Updates the ``position`` in world space for the ``obstacle``.
  1095. .. rst-class:: classref-item-separator
  1096. ----
  1097. .. _class_NavigationServer3D_method_obstacle_set_radius:
  1098. .. rst-class:: classref-method
  1099. |void| **obstacle_set_radius**\ (\ obstacle\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_radius>`
  1100. Sets the radius of the dynamic obstacle.
  1101. .. rst-class:: classref-item-separator
  1102. ----
  1103. .. _class_NavigationServer3D_method_obstacle_set_use_3d_avoidance:
  1104. .. rst-class:: classref-method
  1105. |void| **obstacle_set_use_3d_avoidance**\ (\ obstacle\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_use_3d_avoidance>`
  1106. Sets if the ``obstacle`` uses the 2D avoidance or the 3D avoidance while avoidance is enabled.
  1107. .. rst-class:: classref-item-separator
  1108. ----
  1109. .. _class_NavigationServer3D_method_obstacle_set_velocity:
  1110. .. rst-class:: classref-method
  1111. |void| **obstacle_set_velocity**\ (\ obstacle\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_velocity>`
  1112. Sets ``velocity`` of the dynamic ``obstacle``. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle.
  1113. .. rst-class:: classref-item-separator
  1114. ----
  1115. .. _class_NavigationServer3D_method_obstacle_set_vertices:
  1116. .. rst-class:: classref-method
  1117. |void| **obstacle_set_vertices**\ (\ obstacle\: :ref:`RID<class_RID>`, vertices\: :ref:`PackedVector3Array<class_PackedVector3Array>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_obstacle_set_vertices>`
  1118. Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out.
  1119. .. rst-class:: classref-item-separator
  1120. ----
  1121. .. _class_NavigationServer3D_method_parse_source_geometry_data:
  1122. .. rst-class:: classref-method
  1123. |void| **parse_source_geometry_data**\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, source_geometry_data\: :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>`, root_node\: :ref:`Node<class_Node>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_parse_source_geometry_data>`
  1124. Parses the :ref:`SceneTree<class_SceneTree>` for source geometry according to the properties of ``navigation_mesh``. Updates the provided ``source_geometry_data`` resource with the resulting data. The resource can then be used to bake a navigation mesh with :ref:`bake_from_source_geometry_data()<class_NavigationServer3D_method_bake_from_source_geometry_data>`. After the process is finished the optional ``callback`` will be called.
  1125. \ **Note:** This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe.
  1126. \ **Performance:** While convenient, reading data arrays from :ref:`Mesh<class_Mesh>` resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the :ref:`RenderingServer<class_RenderingServer>` in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code.
  1127. .. rst-class:: classref-item-separator
  1128. ----
  1129. .. _class_NavigationServer3D_method_query_path:
  1130. .. rst-class:: classref-method
  1131. |void| **query_path**\ (\ parameters\: :ref:`NavigationPathQueryParameters3D<class_NavigationPathQueryParameters3D>`, result\: :ref:`NavigationPathQueryResult3D<class_NavigationPathQueryResult3D>`, callback\: :ref:`Callable<class_Callable>` = Callable()\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_query_path>`
  1132. Queries a path in a given navigation map. Start and target position and other parameters are defined through :ref:`NavigationPathQueryParameters3D<class_NavigationPathQueryParameters3D>`. Updates the provided :ref:`NavigationPathQueryResult3D<class_NavigationPathQueryResult3D>` result object with the path among other results requested by the query. After the process is finished the optional ``callback`` will be called.
  1133. .. rst-class:: classref-item-separator
  1134. ----
  1135. .. _class_NavigationServer3D_method_region_bake_navigation_mesh:
  1136. .. rst-class:: classref-method
  1137. |void| **region_bake_navigation_mesh**\ (\ navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`, root_node\: :ref:`Node<class_Node>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_bake_navigation_mesh>`
  1138. **Deprecated:** This method is deprecated due to core threading changes. To upgrade existing code, first create a :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>` resource. Use this resource with :ref:`parse_source_geometry_data()<class_NavigationServer3D_method_parse_source_geometry_data>` to parse the :ref:`SceneTree<class_SceneTree>` for nodes that should contribute to the navigation mesh baking. The :ref:`SceneTree<class_SceneTree>` parsing needs to happen on the main thread. After the parsing is finished use the resource with :ref:`bake_from_source_geometry_data()<class_NavigationServer3D_method_bake_from_source_geometry_data>` to bake a navigation mesh.
  1139. Bakes the ``navigation_mesh`` with bake source geometry collected starting from the ``root_node``.
  1140. .. rst-class:: classref-item-separator
  1141. ----
  1142. .. _class_NavigationServer3D_method_region_create:
  1143. .. rst-class:: classref-method
  1144. :ref:`RID<class_RID>` **region_create**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_create>`
  1145. Creates a new region.
  1146. .. rst-class:: classref-item-separator
  1147. ----
  1148. .. _class_NavigationServer3D_method_region_get_bounds:
  1149. .. rst-class:: classref-method
  1150. :ref:`AABB<class_AABB>` **region_get_bounds**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_bounds>`
  1151. Returns the axis-aligned bounding box for the ``region``'s transformed navigation mesh.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _class_NavigationServer3D_method_region_get_closest_point:
  1155. .. rst-class:: classref-method
  1156. :ref:`Vector3<class_Vector3>` **region_get_closest_point**\ (\ region\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_closest_point>`
  1157. Returns the navigation mesh surface point closest to the provided ``to_point`` on the navigation ``region``.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _class_NavigationServer3D_method_region_get_closest_point_normal:
  1161. .. rst-class:: classref-method
  1162. :ref:`Vector3<class_Vector3>` **region_get_closest_point_normal**\ (\ region\: :ref:`RID<class_RID>`, to_point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_closest_point_normal>`
  1163. Returns the navigation mesh surface normal closest to the provided ``to_point`` on the navigation ``region``.
  1164. .. rst-class:: classref-item-separator
  1165. ----
  1166. .. _class_NavigationServer3D_method_region_get_closest_point_to_segment:
  1167. .. rst-class:: classref-method
  1168. :ref:`Vector3<class_Vector3>` **region_get_closest_point_to_segment**\ (\ region\: :ref:`RID<class_RID>`, start\: :ref:`Vector3<class_Vector3>`, end\: :ref:`Vector3<class_Vector3>`, use_collision\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_closest_point_to_segment>`
  1169. Returns the navigation mesh surface point closest to the provided ``start`` and ``end`` segment on the navigation ``region``.
  1170. If ``use_collision`` is ``true``, a closest point test is only done when the segment intersects with the navigation mesh surface.
  1171. .. rst-class:: classref-item-separator
  1172. ----
  1173. .. _class_NavigationServer3D_method_region_get_connection_pathway_end:
  1174. .. rst-class:: classref-method
  1175. :ref:`Vector3<class_Vector3>` **region_get_connection_pathway_end**\ (\ region\: :ref:`RID<class_RID>`, connection\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_connection_pathway_end>`
  1176. Returns the ending point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count()<class_NavigationServer3D_method_region_get_connections_count>`.
  1177. .. rst-class:: classref-item-separator
  1178. ----
  1179. .. _class_NavigationServer3D_method_region_get_connection_pathway_start:
  1180. .. rst-class:: classref-method
  1181. :ref:`Vector3<class_Vector3>` **region_get_connection_pathway_start**\ (\ region\: :ref:`RID<class_RID>`, connection\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_connection_pathway_start>`
  1182. Returns the starting point of a connection door. ``connection`` is an index between 0 and the return value of :ref:`region_get_connections_count()<class_NavigationServer3D_method_region_get_connections_count>`.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_NavigationServer3D_method_region_get_connections_count:
  1186. .. rst-class:: classref-method
  1187. :ref:`int<class_int>` **region_get_connections_count**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_connections_count>`
  1188. Returns how many connections this ``region`` has with other regions in the map.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_NavigationServer3D_method_region_get_enabled:
  1192. .. rst-class:: classref-method
  1193. :ref:`bool<class_bool>` **region_get_enabled**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_enabled>`
  1194. Returns ``true`` if the specified ``region`` is enabled.
  1195. .. rst-class:: classref-item-separator
  1196. ----
  1197. .. _class_NavigationServer3D_method_region_get_enter_cost:
  1198. .. rst-class:: classref-method
  1199. :ref:`float<class_float>` **region_get_enter_cost**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_enter_cost>`
  1200. Returns the enter cost of this ``region``.
  1201. .. rst-class:: classref-item-separator
  1202. ----
  1203. .. _class_NavigationServer3D_method_region_get_iteration_id:
  1204. .. rst-class:: classref-method
  1205. :ref:`int<class_int>` **region_get_iteration_id**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_iteration_id>`
  1206. Returns the current iteration ID of the navigation region. Every time the navigation region changes and synchronizes, the iteration ID increases. An iteration ID of ``0`` means the navigation region has never synchronized.
  1207. \ **Note:** The iteration ID will wrap around to ``1`` after reaching its range limit.
  1208. .. rst-class:: classref-item-separator
  1209. ----
  1210. .. _class_NavigationServer3D_method_region_get_map:
  1211. .. rst-class:: classref-method
  1212. :ref:`RID<class_RID>` **region_get_map**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_map>`
  1213. Returns the navigation map :ref:`RID<class_RID>` the requested ``region`` is currently assigned to.
  1214. .. rst-class:: classref-item-separator
  1215. ----
  1216. .. _class_NavigationServer3D_method_region_get_navigation_layers:
  1217. .. rst-class:: classref-method
  1218. :ref:`int<class_int>` **region_get_navigation_layers**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_navigation_layers>`
  1219. Returns the region's navigation layers.
  1220. .. rst-class:: classref-item-separator
  1221. ----
  1222. .. _class_NavigationServer3D_method_region_get_owner_id:
  1223. .. rst-class:: classref-method
  1224. :ref:`int<class_int>` **region_get_owner_id**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_owner_id>`
  1225. Returns the ``ObjectID`` of the object which manages this region.
  1226. .. rst-class:: classref-item-separator
  1227. ----
  1228. .. _class_NavigationServer3D_method_region_get_random_point:
  1229. .. rst-class:: classref-method
  1230. :ref:`Vector3<class_Vector3>` **region_get_random_point**\ (\ region\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`, uniformly\: :ref:`bool<class_bool>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_random_point>`
  1231. Returns a random position picked from all region polygons with matching ``navigation_layers``.
  1232. If ``uniformly`` is ``true``, all region polygons and faces are weighted by their surface area (slower).
  1233. If ``uniformly`` is ``false``, just a random polygon and face is picked (faster).
  1234. .. rst-class:: classref-item-separator
  1235. ----
  1236. .. _class_NavigationServer3D_method_region_get_transform:
  1237. .. rst-class:: classref-method
  1238. :ref:`Transform3D<class_Transform3D>` **region_get_transform**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_transform>`
  1239. Returns the global transformation of this ``region``.
  1240. .. rst-class:: classref-item-separator
  1241. ----
  1242. .. _class_NavigationServer3D_method_region_get_travel_cost:
  1243. .. rst-class:: classref-method
  1244. :ref:`float<class_float>` **region_get_travel_cost**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_travel_cost>`
  1245. Returns the travel cost of this ``region``.
  1246. .. rst-class:: classref-item-separator
  1247. ----
  1248. .. _class_NavigationServer3D_method_region_get_use_edge_connections:
  1249. .. rst-class:: classref-method
  1250. :ref:`bool<class_bool>` **region_get_use_edge_connections**\ (\ region\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_get_use_edge_connections>`
  1251. Returns ``true`` if the navigation ``region`` is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _class_NavigationServer3D_method_region_owns_point:
  1255. .. rst-class:: classref-method
  1256. :ref:`bool<class_bool>` **region_owns_point**\ (\ region\: :ref:`RID<class_RID>`, point\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_owns_point>`
  1257. Returns ``true`` if the provided ``point`` in world space is currently owned by the provided navigation ``region``. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region.
  1258. If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer.
  1259. \ **Note:** If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.
  1260. .. rst-class:: classref-item-separator
  1261. ----
  1262. .. _class_NavigationServer3D_method_region_set_enabled:
  1263. .. rst-class:: classref-method
  1264. |void| **region_set_enabled**\ (\ region\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_enabled>`
  1265. If ``enabled`` is ``true``, the specified ``region`` will contribute to its current navigation map.
  1266. .. rst-class:: classref-item-separator
  1267. ----
  1268. .. _class_NavigationServer3D_method_region_set_enter_cost:
  1269. .. rst-class:: classref-method
  1270. |void| **region_set_enter_cost**\ (\ region\: :ref:`RID<class_RID>`, enter_cost\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_enter_cost>`
  1271. Sets the ``enter_cost`` for this ``region``.
  1272. .. rst-class:: classref-item-separator
  1273. ----
  1274. .. _class_NavigationServer3D_method_region_set_map:
  1275. .. rst-class:: classref-method
  1276. |void| **region_set_map**\ (\ region\: :ref:`RID<class_RID>`, map\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_map>`
  1277. Sets the map for the region.
  1278. .. rst-class:: classref-item-separator
  1279. ----
  1280. .. _class_NavigationServer3D_method_region_set_navigation_layers:
  1281. .. rst-class:: classref-method
  1282. |void| **region_set_navigation_layers**\ (\ region\: :ref:`RID<class_RID>`, navigation_layers\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_navigation_layers>`
  1283. Set the region's navigation layers. This allows selecting regions from a path request (when using :ref:`map_get_path()<class_NavigationServer3D_method_map_get_path>`).
  1284. .. rst-class:: classref-item-separator
  1285. ----
  1286. .. _class_NavigationServer3D_method_region_set_navigation_mesh:
  1287. .. rst-class:: classref-method
  1288. |void| **region_set_navigation_mesh**\ (\ region\: :ref:`RID<class_RID>`, navigation_mesh\: :ref:`NavigationMesh<class_NavigationMesh>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_navigation_mesh>`
  1289. Sets the navigation mesh for the region.
  1290. .. rst-class:: classref-item-separator
  1291. ----
  1292. .. _class_NavigationServer3D_method_region_set_owner_id:
  1293. .. rst-class:: classref-method
  1294. |void| **region_set_owner_id**\ (\ region\: :ref:`RID<class_RID>`, owner_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_owner_id>`
  1295. Set the ``ObjectID`` of the object which manages this region.
  1296. .. rst-class:: classref-item-separator
  1297. ----
  1298. .. _class_NavigationServer3D_method_region_set_transform:
  1299. .. rst-class:: classref-method
  1300. |void| **region_set_transform**\ (\ region\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_transform>`
  1301. Sets the global transformation for the region.
  1302. .. rst-class:: classref-item-separator
  1303. ----
  1304. .. _class_NavigationServer3D_method_region_set_travel_cost:
  1305. .. rst-class:: classref-method
  1306. |void| **region_set_travel_cost**\ (\ region\: :ref:`RID<class_RID>`, travel_cost\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_travel_cost>`
  1307. Sets the ``travel_cost`` for this ``region``.
  1308. .. rst-class:: classref-item-separator
  1309. ----
  1310. .. _class_NavigationServer3D_method_region_set_use_edge_connections:
  1311. .. rst-class:: classref-method
  1312. |void| **region_set_use_edge_connections**\ (\ region\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_region_set_use_edge_connections>`
  1313. If ``enabled`` is ``true``, the navigation ``region`` will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
  1314. .. rst-class:: classref-item-separator
  1315. ----
  1316. .. _class_NavigationServer3D_method_set_active:
  1317. .. rst-class:: classref-method
  1318. |void| **set_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_set_active>`
  1319. Control activation of this server.
  1320. .. rst-class:: classref-item-separator
  1321. ----
  1322. .. _class_NavigationServer3D_method_set_debug_enabled:
  1323. .. rst-class:: classref-method
  1324. |void| **set_debug_enabled**\ (\ enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_set_debug_enabled>`
  1325. If ``true`` enables debug mode on the NavigationServer.
  1326. .. rst-class:: classref-item-separator
  1327. ----
  1328. .. _class_NavigationServer3D_method_simplify_path:
  1329. .. rst-class:: classref-method
  1330. :ref:`PackedVector3Array<class_PackedVector3Array>` **simplify_path**\ (\ path\: :ref:`PackedVector3Array<class_PackedVector3Array>`, epsilon\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_simplify_path>`
  1331. Returns a simplified version of ``path`` with less critical path points removed. The simplification amount is in worlds units and controlled by ``epsilon``. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
  1332. Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
  1333. .. rst-class:: classref-item-separator
  1334. ----
  1335. .. _class_NavigationServer3D_method_source_geometry_parser_create:
  1336. .. rst-class:: classref-method
  1337. :ref:`RID<class_RID>` **source_geometry_parser_create**\ (\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_source_geometry_parser_create>`
  1338. Creates a new source geometry parser. If a :ref:`Callable<class_Callable>` is set for the parser with :ref:`source_geometry_parser_set_callback()<class_NavigationServer3D_method_source_geometry_parser_set_callback>` the callback will be called for every single node that gets parsed whenever :ref:`parse_source_geometry_data()<class_NavigationServer3D_method_parse_source_geometry_data>` is used.
  1339. .. rst-class:: classref-item-separator
  1340. ----
  1341. .. _class_NavigationServer3D_method_source_geometry_parser_set_callback:
  1342. .. rst-class:: classref-method
  1343. |void| **source_geometry_parser_set_callback**\ (\ parser\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_NavigationServer3D_method_source_geometry_parser_set_callback>`
  1344. Sets the ``callback`` :ref:`Callable<class_Callable>` for the specific source geometry ``parser``. The :ref:`Callable<class_Callable>` will receive a call with the following parameters:
  1345. - ``navigation_mesh`` - The :ref:`NavigationMesh<class_NavigationMesh>` reference used to define the parse settings. Do NOT edit or add directly to the navigation mesh.
  1346. - ``source_geometry_data`` - The :ref:`NavigationMeshSourceGeometryData3D<class_NavigationMeshSourceGeometryData3D>` reference. Add custom source geometry for navigation mesh baking to this object.
  1347. - ``node`` - The :ref:`Node<class_Node>` that is parsed.
  1348. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1349. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1350. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1351. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1352. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1353. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1354. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  1355. .. |void| replace:: :abbr:`void (No return value.)`