UnityEngine.AIModule.xml 78 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.AIModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.AI.NavMesh">
  8. <summary>
  9. <para>Singleton class to access the baked NavMesh.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.AI.NavMesh.avoidancePredictionTime">
  13. <summary>
  14. <para>Describes how far in the future the agents predict collisions for avoidance.</para>
  15. </summary>
  16. </member>
  17. <member name="F:UnityEngine.AI.NavMesh.onPreUpdate">
  18. <summary>
  19. <para>Set a function to be called before the NavMesh is updated during the frame update execution.</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.AI.NavMesh.pathfindingIterationsPerFrame">
  23. <summary>
  24. <para>The maximum amount of nodes processed each frame in the asynchronous pathfinding process.</para>
  25. </summary>
  26. </member>
  27. <member name="M:UnityEngine.AI.NavMesh.AddLink(UnityEngine.AI.NavMeshLinkData)">
  28. <summary>
  29. <para>Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct.</para>
  30. </summary>
  31. <param name="link">Describing the properties of the link.</param>
  32. <returns>
  33. <para>Representing the added link.</para>
  34. </returns>
  35. </member>
  36. <member name="M:UnityEngine.AI.NavMesh.AddLink(UnityEngine.AI.NavMeshLinkData,UnityEngine.Vector3,UnityEngine.Quaternion)">
  37. <summary>
  38. <para>Adds a link to the NavMesh. The link is described by the NavMeshLinkData struct.</para>
  39. </summary>
  40. <param name="link">Describing the properties of the link.</param>
  41. <param name="position">Translate the link to this position.</param>
  42. <param name="rotation">Rotate the link to this orientation.</param>
  43. <returns>
  44. <para>Representing the added link.</para>
  45. </returns>
  46. </member>
  47. <member name="M:UnityEngine.AI.NavMesh.AddNavMeshData(UnityEngine.AI.NavMeshData)">
  48. <summary>
  49. <para>Adds the specified NavMeshData to the game.</para>
  50. </summary>
  51. <param name="navMeshData">Contains the data for the navmesh.</param>
  52. <returns>
  53. <para>Representing the added navmesh.</para>
  54. </returns>
  55. </member>
  56. <member name="M:UnityEngine.AI.NavMesh.AddNavMeshData(UnityEngine.AI.NavMeshData,UnityEngine.Vector3,UnityEngine.Quaternion)">
  57. <summary>
  58. <para>Adds the specified NavMeshData to the game.</para>
  59. </summary>
  60. <param name="navMeshData">Contains the data for the navmesh.</param>
  61. <param name="position">Translate the navmesh to this position.</param>
  62. <param name="rotation">Rotate the navmesh to this orientation.</param>
  63. <returns>
  64. <para>Representing the added navmesh.</para>
  65. </returns>
  66. </member>
  67. <member name="F:UnityEngine.AI.NavMesh.AllAreas">
  68. <summary>
  69. <para>Area mask constant that includes all NavMesh areas.</para>
  70. </summary>
  71. </member>
  72. <member name="M:UnityEngine.AI.NavMesh.CalculatePath(UnityEngine.Vector3,UnityEngine.Vector3,System.Int32,UnityEngine.AI.NavMeshPath)">
  73. <summary>
  74. <para>Calculate a path between two points and store the resulting path.</para>
  75. </summary>
  76. <param name="sourcePosition">The initial position of the path requested.</param>
  77. <param name="targetPosition">The final position of the path requested.</param>
  78. <param name="areaMask">A bitfield mask specifying which NavMesh areas can be passed when calculating a path.</param>
  79. <param name="path">The resulting path.</param>
  80. <returns>
  81. <para>True if a either a complete or partial path is found and false otherwise.</para>
  82. </returns>
  83. </member>
  84. <member name="M:UnityEngine.AI.NavMesh.CalculatePath(UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.AI.NavMeshQueryFilter,UnityEngine.AI.NavMeshPath)">
  85. <summary>
  86. <para>Calculates a path between two positions mapped to the NavMesh, subject to the constraints and costs defined by the filter argument.</para>
  87. </summary>
  88. <param name="sourcePosition">The initial position of the path requested.</param>
  89. <param name="targetPosition">The final position of the path requested.</param>
  90. <param name="filter">A filter specifying the cost of NavMesh areas that can be passed when calculating a path.</param>
  91. <param name="path">The resulting path.</param>
  92. <returns>
  93. <para>True if a either a complete or partial path is found and false otherwise.</para>
  94. </returns>
  95. </member>
  96. <member name="M:UnityEngine.AI.NavMesh.CalculateTriangulation">
  97. <summary>
  98. <para>Calculates triangulation of the current navmesh.</para>
  99. </summary>
  100. </member>
  101. <member name="M:UnityEngine.AI.NavMesh.CreateSettings">
  102. <summary>
  103. <para>Creates and returns a new entry of NavMesh build settings available for runtime NavMesh building.</para>
  104. </summary>
  105. <returns>
  106. <para>The created settings.</para>
  107. </returns>
  108. </member>
  109. <member name="M:UnityEngine.AI.NavMesh.FindClosestEdge(UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;,System.Int32)">
  110. <summary>
  111. <para>Locate the closest NavMesh edge from a point on the NavMesh.</para>
  112. </summary>
  113. <param name="sourcePosition">The origin of the distance query.</param>
  114. <param name="hit">Holds the properties of the resulting location.</param>
  115. <param name="areaMask">A bitfield mask specifying which NavMesh areas can be passed when finding the nearest edge.</param>
  116. <returns>
  117. <para>True if a nearest edge is found.</para>
  118. </returns>
  119. </member>
  120. <member name="M:UnityEngine.AI.NavMesh.FindClosestEdge(UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;,UnityEngine.AI.NavMeshQueryFilter)">
  121. <summary>
  122. <para>Locate the closest NavMesh edge from a point on the NavMesh, subject to the constraints of the filter argument.</para>
  123. </summary>
  124. <param name="sourcePosition">The origin of the distance query.</param>
  125. <param name="hit">Holds the properties of the resulting location.</param>
  126. <param name="filter">A filter specifying which NavMesh areas can be passed when finding the nearest edge.</param>
  127. <returns>
  128. <para>True if a nearest edge is found.</para>
  129. </returns>
  130. </member>
  131. <member name="M:UnityEngine.AI.NavMesh.GetAreaCost(System.Int32)">
  132. <summary>
  133. <para>Gets the cost for path finding over geometry of the area type.</para>
  134. </summary>
  135. <param name="areaIndex">Index of the area to get.</param>
  136. </member>
  137. <member name="M:UnityEngine.AI.NavMesh.GetAreaFromName(System.String)">
  138. <summary>
  139. <para>Returns the area index for a named NavMesh area type.</para>
  140. </summary>
  141. <param name="areaName">Name of the area to look up.</param>
  142. <returns>
  143. <para>Index if the specified are, or -1 if no area found.</para>
  144. </returns>
  145. </member>
  146. <member name="M:UnityEngine.AI.NavMesh.GetLayerCost(System.Int32)">
  147. <summary>
  148. <para>Gets the cost for traversing over geometry of the layer type on all agents.</para>
  149. </summary>
  150. <param name="layer"></param>
  151. </member>
  152. <member name="M:UnityEngine.AI.NavMesh.GetNavMeshLayerFromName(System.String)">
  153. <summary>
  154. <para>Returns the layer index for a named layer.</para>
  155. </summary>
  156. <param name="layerName"></param>
  157. </member>
  158. <member name="M:UnityEngine.AI.NavMesh.GetSettingsByID(System.Int32)">
  159. <summary>
  160. <para>Returns an existing entry of NavMesh build settings.</para>
  161. </summary>
  162. <param name="agentTypeID">The ID to look for.</param>
  163. <returns>
  164. <para>The settings found.</para>
  165. </returns>
  166. </member>
  167. <member name="M:UnityEngine.AI.NavMesh.GetSettingsByIndex(System.Int32)">
  168. <summary>
  169. <para>Returns an existing entry of NavMesh build settings by its ordered index.</para>
  170. </summary>
  171. <param name="index">The index to retrieve from.</param>
  172. <returns>
  173. <para>The found settings.</para>
  174. </returns>
  175. </member>
  176. <member name="M:UnityEngine.AI.NavMesh.GetSettingsCount">
  177. <summary>
  178. <para>Returns the number of registered NavMesh build settings.</para>
  179. </summary>
  180. <returns>
  181. <para>The number of registered entries.</para>
  182. </returns>
  183. </member>
  184. <member name="M:UnityEngine.AI.NavMesh.GetSettingsNameFromID(System.Int32)">
  185. <summary>
  186. <para>Returns the name associated with the NavMesh build settings matching the provided agent type ID.</para>
  187. </summary>
  188. <param name="agentTypeID">The ID to look for.</param>
  189. <returns>
  190. <para>The name associated with the ID found.</para>
  191. </returns>
  192. </member>
  193. <member name="T:UnityEngine.AI.NavMesh.OnNavMeshPreUpdate">
  194. <summary>
  195. <para>A delegate which can be used to register callback methods to be invoked before the NavMesh system updates.</para>
  196. </summary>
  197. </member>
  198. <member name="M:UnityEngine.AI.NavMesh.Raycast(UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;,System.Int32)">
  199. <summary>
  200. <para>Trace a line between two points on the NavMesh.</para>
  201. </summary>
  202. <param name="sourcePosition">The origin of the ray.</param>
  203. <param name="targetPosition">The end of the ray.</param>
  204. <param name="hit">Holds the properties of the ray cast resulting location.</param>
  205. <param name="areaMask">A bitfield mask specifying which NavMesh areas can be passed when tracing the ray.</param>
  206. <returns>
  207. <para>True if the ray is terminated before reaching target position. Otherwise returns false.</para>
  208. </returns>
  209. </member>
  210. <member name="M:UnityEngine.AI.NavMesh.Raycast(UnityEngine.Vector3,UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;,UnityEngine.AI.NavMeshQueryFilter)">
  211. <summary>
  212. <para>Traces a line between two positions on the NavMesh, subject to the constraints defined by the filter argument.</para>
  213. </summary>
  214. <param name="sourcePosition">The origin of the ray.</param>
  215. <param name="targetPosition">The end of the ray.</param>
  216. <param name="hit">Holds the properties of the ray cast resulting location.</param>
  217. <param name="filter">A filter specifying which NavMesh areas can be passed when tracing the ray.</param>
  218. <returns>
  219. <para>True if the ray is terminated before reaching target position. Otherwise returns false.</para>
  220. </returns>
  221. </member>
  222. <member name="M:UnityEngine.AI.NavMesh.RemoveAllNavMeshData">
  223. <summary>
  224. <para>Removes all NavMesh surfaces and links from the game.</para>
  225. </summary>
  226. </member>
  227. <member name="M:UnityEngine.AI.NavMesh.RemoveLink(UnityEngine.AI.NavMeshLinkInstance)">
  228. <summary>
  229. <para>Removes a link from the NavMesh.</para>
  230. </summary>
  231. <param name="handle">The instance of a link to remove.</param>
  232. </member>
  233. <member name="M:UnityEngine.AI.NavMesh.RemoveNavMeshData(UnityEngine.AI.NavMeshDataInstance)">
  234. <summary>
  235. <para>Removes the specified NavMeshDataInstance from the game, making it unavailable for agents and queries.</para>
  236. </summary>
  237. <param name="handle">The instance of a NavMesh to remove.</param>
  238. </member>
  239. <member name="M:UnityEngine.AI.NavMesh.RemoveSettings(System.Int32)">
  240. <summary>
  241. <para>Removes the build settings matching the agent type ID.</para>
  242. </summary>
  243. <param name="agentTypeID">The ID of the entry to remove.</param>
  244. </member>
  245. <member name="M:UnityEngine.AI.NavMesh.SamplePosition(UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;,System.Single,System.Int32)">
  246. <summary>
  247. <para>Finds the closest point on NavMesh within specified range.</para>
  248. </summary>
  249. <param name="sourcePosition">The origin of the sample query.</param>
  250. <param name="hit">Holds the properties of the resulting location.</param>
  251. <param name="maxDistance">Sample within this distance from sourcePosition.</param>
  252. <param name="areaMask">A mask specifying which NavMesh areas are allowed when finding the nearest point.</param>
  253. <returns>
  254. <para>True if a nearest point is found.</para>
  255. </returns>
  256. </member>
  257. <member name="M:UnityEngine.AI.NavMesh.SamplePosition(UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;,System.Single,UnityEngine.AI.NavMeshQueryFilter)">
  258. <summary>
  259. <para>Samples the position closest to sourcePosition - on any NavMesh built for the agent type specified by the filter.</para>
  260. </summary>
  261. <param name="sourcePosition">The origin of the sample query.</param>
  262. <param name="hit">Holds the properties of the resulting location.</param>
  263. <param name="maxDistance">Sample within this distance from sourcePosition.</param>
  264. <param name="filter">A filter specifying which NavMesh areas are allowed when finding the nearest point.</param>
  265. <returns>
  266. <para>True if a nearest point is found.</para>
  267. </returns>
  268. </member>
  269. <member name="M:UnityEngine.AI.NavMesh.SetAreaCost(System.Int32,System.Single)">
  270. <summary>
  271. <para>Sets the cost for finding path over geometry of the area type on all agents.</para>
  272. </summary>
  273. <param name="areaIndex">Index of the area to set.</param>
  274. <param name="cost">New cost.</param>
  275. </member>
  276. <member name="M:UnityEngine.AI.NavMesh.SetLayerCost(System.Int32,System.Single)">
  277. <summary>
  278. <para>Sets the cost for traversing over geometry of the layer type on all agents.</para>
  279. </summary>
  280. <param name="layer"></param>
  281. <param name="cost"></param>
  282. </member>
  283. <member name="T:UnityEngine.AI.NavMeshAgent">
  284. <summary>
  285. <para>Navigation mesh agent.</para>
  286. </summary>
  287. </member>
  288. <member name="P:UnityEngine.AI.NavMeshAgent.acceleration">
  289. <summary>
  290. <para>The maximum acceleration of an agent as it follows a path, given in units / sec^2.</para>
  291. </summary>
  292. </member>
  293. <member name="P:UnityEngine.AI.NavMeshAgent.agentTypeID">
  294. <summary>
  295. <para>The type ID for the agent.</para>
  296. </summary>
  297. </member>
  298. <member name="P:UnityEngine.AI.NavMeshAgent.angularSpeed">
  299. <summary>
  300. <para>Maximum turning speed in (deg/s) while following a path.</para>
  301. </summary>
  302. </member>
  303. <member name="P:UnityEngine.AI.NavMeshAgent.areaMask">
  304. <summary>
  305. <para>Specifies which NavMesh areas are passable. Changing areaMask will make the path stale (see isPathStale).</para>
  306. </summary>
  307. </member>
  308. <member name="P:UnityEngine.AI.NavMeshAgent.autoBraking">
  309. <summary>
  310. <para>Should the agent brake automatically to avoid overshooting the destination point?</para>
  311. </summary>
  312. </member>
  313. <member name="P:UnityEngine.AI.NavMeshAgent.autoRepath">
  314. <summary>
  315. <para>Should the agent attempt to acquire a new path if the existing path becomes invalid?</para>
  316. </summary>
  317. </member>
  318. <member name="P:UnityEngine.AI.NavMeshAgent.autoTraverseOffMeshLink">
  319. <summary>
  320. <para>Should the agent move across OffMeshLinks automatically?</para>
  321. </summary>
  322. </member>
  323. <member name="P:UnityEngine.AI.NavMeshAgent.avoidancePriority">
  324. <summary>
  325. <para>The avoidance priority level.</para>
  326. </summary>
  327. </member>
  328. <member name="P:UnityEngine.AI.NavMeshAgent.baseOffset">
  329. <summary>
  330. <para>The relative vertical displacement of the owning GameObject.</para>
  331. </summary>
  332. </member>
  333. <member name="P:UnityEngine.AI.NavMeshAgent.currentOffMeshLinkData">
  334. <summary>
  335. <para>The current OffMeshLinkData.</para>
  336. </summary>
  337. </member>
  338. <member name="P:UnityEngine.AI.NavMeshAgent.desiredVelocity">
  339. <summary>
  340. <para>The desired velocity of the agent including any potential contribution from avoidance. (Read Only)</para>
  341. </summary>
  342. </member>
  343. <member name="P:UnityEngine.AI.NavMeshAgent.destination">
  344. <summary>
  345. <para>Gets or attempts to set the destination of the agent in world-space units.</para>
  346. </summary>
  347. </member>
  348. <member name="P:UnityEngine.AI.NavMeshAgent.hasPath">
  349. <summary>
  350. <para>Does the agent currently have a path? (Read Only)</para>
  351. </summary>
  352. </member>
  353. <member name="P:UnityEngine.AI.NavMeshAgent.height">
  354. <summary>
  355. <para>The height of the agent for purposes of passing under obstacles, etc.</para>
  356. </summary>
  357. </member>
  358. <member name="P:UnityEngine.AI.NavMeshAgent.isOnNavMesh">
  359. <summary>
  360. <para>Is the agent currently bound to the navmesh? (Read Only)</para>
  361. </summary>
  362. </member>
  363. <member name="P:UnityEngine.AI.NavMeshAgent.isOnOffMeshLink">
  364. <summary>
  365. <para>Is the agent currently positioned on an OffMeshLink? (Read Only)</para>
  366. </summary>
  367. </member>
  368. <member name="P:UnityEngine.AI.NavMeshAgent.isPathStale">
  369. <summary>
  370. <para>Is the current path stale. (Read Only)</para>
  371. </summary>
  372. </member>
  373. <member name="P:UnityEngine.AI.NavMeshAgent.isStopped">
  374. <summary>
  375. <para>This property holds the stop or resume condition of the NavMesh agent.</para>
  376. </summary>
  377. </member>
  378. <member name="P:UnityEngine.AI.NavMeshAgent.navMeshOwner">
  379. <summary>
  380. <para>Returns the owning object of the NavMesh the agent is currently placed on (Read Only).</para>
  381. </summary>
  382. </member>
  383. <member name="P:UnityEngine.AI.NavMeshAgent.nextOffMeshLinkData">
  384. <summary>
  385. <para>The next OffMeshLinkData on the current path.</para>
  386. </summary>
  387. </member>
  388. <member name="P:UnityEngine.AI.NavMeshAgent.nextPosition">
  389. <summary>
  390. <para>Gets or sets the simulation position of the navmesh agent.</para>
  391. </summary>
  392. </member>
  393. <member name="P:UnityEngine.AI.NavMeshAgent.obstacleAvoidanceType">
  394. <summary>
  395. <para>The level of quality of avoidance.</para>
  396. </summary>
  397. </member>
  398. <member name="P:UnityEngine.AI.NavMeshAgent.path">
  399. <summary>
  400. <para>Property to get and set the current path.</para>
  401. </summary>
  402. </member>
  403. <member name="P:UnityEngine.AI.NavMeshAgent.pathPending">
  404. <summary>
  405. <para>Is a path in the process of being computed but not yet ready? (Read Only)</para>
  406. </summary>
  407. </member>
  408. <member name="P:UnityEngine.AI.NavMeshAgent.pathStatus">
  409. <summary>
  410. <para>The status of the current path (complete, partial or invalid).</para>
  411. </summary>
  412. </member>
  413. <member name="P:UnityEngine.AI.NavMeshAgent.radius">
  414. <summary>
  415. <para>The avoidance radius for the agent.</para>
  416. </summary>
  417. </member>
  418. <member name="P:UnityEngine.AI.NavMeshAgent.remainingDistance">
  419. <summary>
  420. <para>The distance between the agent's position and the destination on the current path. (Read Only)</para>
  421. </summary>
  422. </member>
  423. <member name="P:UnityEngine.AI.NavMeshAgent.speed">
  424. <summary>
  425. <para>Maximum movement speed when following a path.</para>
  426. </summary>
  427. </member>
  428. <member name="P:UnityEngine.AI.NavMeshAgent.steeringTarget">
  429. <summary>
  430. <para>Get the current steering target along the path. (Read Only)</para>
  431. </summary>
  432. </member>
  433. <member name="P:UnityEngine.AI.NavMeshAgent.stoppingDistance">
  434. <summary>
  435. <para>Stop within this distance from the target position.</para>
  436. </summary>
  437. </member>
  438. <member name="P:UnityEngine.AI.NavMeshAgent.updatePosition">
  439. <summary>
  440. <para>Gets or sets whether the transform position is synchronized with the simulated agent position. The default value is true.</para>
  441. </summary>
  442. </member>
  443. <member name="P:UnityEngine.AI.NavMeshAgent.updateRotation">
  444. <summary>
  445. <para>Should the agent update the transform orientation?</para>
  446. </summary>
  447. </member>
  448. <member name="P:UnityEngine.AI.NavMeshAgent.updateUpAxis">
  449. <summary>
  450. <para>Allows you to specify whether the agent should be aligned to the up-axis of the NavMesh or link that it is placed on.</para>
  451. </summary>
  452. </member>
  453. <member name="P:UnityEngine.AI.NavMeshAgent.velocity">
  454. <summary>
  455. <para>Access the current velocity of the NavMeshAgent component, or set a velocity to control the agent manually.</para>
  456. </summary>
  457. </member>
  458. <member name="P:UnityEngine.AI.NavMeshAgent.walkableMask">
  459. <summary>
  460. <para>Specifies which NavMesh layers are passable (bitfield). Changing walkableMask will make the path stale (see isPathStale).</para>
  461. </summary>
  462. </member>
  463. <member name="M:UnityEngine.AI.NavMeshAgent.ActivateCurrentOffMeshLink(System.Boolean)">
  464. <summary>
  465. <para>Enables or disables the current off-mesh link.</para>
  466. </summary>
  467. <param name="activated">Is the link activated?</param>
  468. </member>
  469. <member name="M:UnityEngine.AI.NavMeshAgent.CalculatePath(UnityEngine.Vector3,UnityEngine.AI.NavMeshPath)">
  470. <summary>
  471. <para>Calculate a path to a specified point and store the resulting path.</para>
  472. </summary>
  473. <param name="targetPosition">The final position of the path requested.</param>
  474. <param name="path">The resulting path.</param>
  475. <returns>
  476. <para>True if a path is found.</para>
  477. </returns>
  478. </member>
  479. <member name="M:UnityEngine.AI.NavMeshAgent.CompleteOffMeshLink">
  480. <summary>
  481. <para>Completes the movement on the current OffMeshLink.</para>
  482. </summary>
  483. </member>
  484. <member name="M:UnityEngine.AI.NavMeshAgent.FindClosestEdge(UnityEngine.AI.NavMeshHit&amp;)">
  485. <summary>
  486. <para>Locate the closest NavMesh edge.</para>
  487. </summary>
  488. <param name="hit">Holds the properties of the resulting location.</param>
  489. <returns>
  490. <para>True if a nearest edge is found.</para>
  491. </returns>
  492. </member>
  493. <member name="M:UnityEngine.AI.NavMeshAgent.GetAreaCost(System.Int32)">
  494. <summary>
  495. <para>Gets the cost for path calculation when crossing area of a particular type.</para>
  496. </summary>
  497. <param name="areaIndex">Area Index.</param>
  498. <returns>
  499. <para>Current cost for specified area index.</para>
  500. </returns>
  501. </member>
  502. <member name="M:UnityEngine.AI.NavMeshAgent.GetLayerCost(System.Int32)">
  503. <summary>
  504. <para>Gets the cost for crossing ground of a particular type.</para>
  505. </summary>
  506. <param name="layer">Layer index.</param>
  507. <returns>
  508. <para>Current cost of specified layer.</para>
  509. </returns>
  510. </member>
  511. <member name="M:UnityEngine.AI.NavMeshAgent.Move(UnityEngine.Vector3)">
  512. <summary>
  513. <para>Apply relative movement to current position.</para>
  514. </summary>
  515. <param name="offset">The relative movement vector.</param>
  516. </member>
  517. <member name="M:UnityEngine.AI.NavMeshAgent.Raycast(UnityEngine.Vector3,UnityEngine.AI.NavMeshHit&amp;)">
  518. <summary>
  519. <para>Trace a straight path towards a target postion in the NavMesh without moving the agent.</para>
  520. </summary>
  521. <param name="targetPosition">The desired end position of movement.</param>
  522. <param name="hit">Properties of the obstacle detected by the ray (if any).</param>
  523. <returns>
  524. <para>True if there is an obstacle between the agent and the target position, otherwise false.</para>
  525. </returns>
  526. </member>
  527. <member name="M:UnityEngine.AI.NavMeshAgent.ResetPath">
  528. <summary>
  529. <para>Clears the current path.</para>
  530. </summary>
  531. </member>
  532. <member name="M:UnityEngine.AI.NavMeshAgent.Resume">
  533. <summary>
  534. <para>Resumes the movement along the current path after a pause.</para>
  535. </summary>
  536. </member>
  537. <member name="M:UnityEngine.AI.NavMeshAgent.SamplePathPosition(System.Int32,System.Single,UnityEngine.AI.NavMeshHit&amp;)">
  538. <summary>
  539. <para>Sample a position along the current path.</para>
  540. </summary>
  541. <param name="areaMask">A bitfield mask specifying which NavMesh areas can be passed when tracing the path.</param>
  542. <param name="maxDistance">Terminate scanning the path at this distance.</param>
  543. <param name="hit">Holds the properties of the resulting location.</param>
  544. <returns>
  545. <para>True if terminated before reaching the position at maxDistance, false otherwise.</para>
  546. </returns>
  547. </member>
  548. <member name="M:UnityEngine.AI.NavMeshAgent.SetAreaCost(System.Int32,System.Single)">
  549. <summary>
  550. <para>Sets the cost for traversing over areas of the area type.</para>
  551. </summary>
  552. <param name="areaIndex">Area cost.</param>
  553. <param name="areaCost">New cost for the specified area index.</param>
  554. </member>
  555. <member name="M:UnityEngine.AI.NavMeshAgent.SetDestination(UnityEngine.Vector3)">
  556. <summary>
  557. <para>Sets or updates the destination thus triggering the calculation for a new path.</para>
  558. </summary>
  559. <param name="target">The target point to navigate to.</param>
  560. <returns>
  561. <para>True if the destination was requested successfully, otherwise false.</para>
  562. </returns>
  563. </member>
  564. <member name="M:UnityEngine.AI.NavMeshAgent.SetLayerCost(System.Int32,System.Single)">
  565. <summary>
  566. <para>Sets the cost for traversing over geometry of the layer type.</para>
  567. </summary>
  568. <param name="layer">Layer index.</param>
  569. <param name="cost">New cost for the specified layer.</param>
  570. </member>
  571. <member name="M:UnityEngine.AI.NavMeshAgent.SetPath(UnityEngine.AI.NavMeshPath)">
  572. <summary>
  573. <para>Assign a new path to this agent.</para>
  574. </summary>
  575. <param name="path">New path to follow.</param>
  576. <returns>
  577. <para>True if the path is succesfully assigned.</para>
  578. </returns>
  579. </member>
  580. <member name="M:UnityEngine.AI.NavMeshAgent.Stop">
  581. <summary>
  582. <para>Stop movement of this agent along its current path.</para>
  583. </summary>
  584. </member>
  585. <member name="M:UnityEngine.AI.NavMeshAgent.Warp(UnityEngine.Vector3)">
  586. <summary>
  587. <para>Warps agent to the provided position.</para>
  588. </summary>
  589. <param name="newPosition">New position to warp the agent to.</param>
  590. <returns>
  591. <para>True if agent is successfully warped, otherwise false.</para>
  592. </returns>
  593. </member>
  594. <member name="T:UnityEngine.AI.NavMeshBuildDebugFlags">
  595. <summary>
  596. <para>Bitmask used for operating with debug data from the NavMesh build process.</para>
  597. </summary>
  598. </member>
  599. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.All">
  600. <summary>
  601. <para>All debug data from the NavMesh build process is taken into consideration.</para>
  602. </summary>
  603. </member>
  604. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.InputGeometry">
  605. <summary>
  606. <para>The triangles of all the geometry that is used as a base for computing the new NavMesh.</para>
  607. </summary>
  608. </member>
  609. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.None">
  610. <summary>
  611. <para>No debug data from the NavMesh build process is taken into consideration.</para>
  612. </summary>
  613. </member>
  614. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.PolygonMeshes">
  615. <summary>
  616. <para>Meshes of convex polygons constructed within the unified contours of adjacent regions.</para>
  617. </summary>
  618. </member>
  619. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.PolygonMeshesDetail">
  620. <summary>
  621. <para>The triangulated meshes with height details that better approximate the source geometry.</para>
  622. </summary>
  623. </member>
  624. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.RawContours">
  625. <summary>
  626. <para>The contours that follow precisely the edges of each surface region.</para>
  627. </summary>
  628. </member>
  629. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.Regions">
  630. <summary>
  631. <para>The segmentation of the traversable surfaces into smaller areas necessary for producing simple polygons.</para>
  632. </summary>
  633. </member>
  634. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.SimplifiedContours">
  635. <summary>
  636. <para>Contours bounding each of the surface regions, described through fewer vertices and straighter edges compared to RawContours.</para>
  637. </summary>
  638. </member>
  639. <member name="F:UnityEngine.AI.NavMeshBuildDebugFlags.Voxels">
  640. <summary>
  641. <para>The voxels produced by rasterizing the source geometry into walkable and unwalkable areas.</para>
  642. </summary>
  643. </member>
  644. <member name="T:UnityEngine.AI.NavMeshBuildDebugSettings">
  645. <summary>
  646. <para>Specify which of the temporary data generated while building the NavMesh should be retained in memory after the process has completed.</para>
  647. </summary>
  648. </member>
  649. <member name="P:UnityEngine.AI.NavMeshBuildDebugSettings.flags">
  650. <summary>
  651. <para>Specify which types of debug data to collect when building the NavMesh.</para>
  652. </summary>
  653. </member>
  654. <member name="T:UnityEngine.AI.NavMeshBuilder">
  655. <summary>
  656. <para>Navigation mesh builder interface.</para>
  657. </summary>
  658. </member>
  659. <member name="M:UnityEngine.AI.NavMeshBuilder.BuildNavMeshData(UnityEngine.AI.NavMeshBuildSettings,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildSource&gt;,UnityEngine.Bounds,UnityEngine.Vector3,UnityEngine.Quaternion)">
  660. <summary>
  661. <para>Builds a NavMesh data object from the provided input sources.</para>
  662. </summary>
  663. <param name="buildSettings">Settings for the bake process, see NavMeshBuildSettings.</param>
  664. <param name="sources">List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid.</param>
  665. <param name="localBounds">Bounding box relative to position and rotation which describes the volume where the NavMesh should be built. Empty bounds is treated as no bounds, i.e. the NavMesh will cover all the inputs.</param>
  666. <param name="position">Center of the NavMeshData. This specifies the origin for the NavMesh tiles (See Also: NavMeshBuildSettings.tileSize).</param>
  667. <param name="rotation">Orientation of the NavMeshData, you can use this to generate NavMesh with an arbitrary up-vector – e.g. for walkable vertical surfaces.</param>
  668. <returns>
  669. <para>Returns a newly built NavMeshData, or null if the NavMeshData was empty or an error occurred.
  670. The newly built NavMeshData, or null if the NavMeshData was empty or an error occurred.</para>
  671. </returns>
  672. </member>
  673. <member name="M:UnityEngine.AI.NavMeshBuilder.Cancel(UnityEngine.AI.NavMeshData)">
  674. <summary>
  675. <para>Cancels an asynchronous update of the specified NavMesh data. See Also: UpdateNavMeshDataAsync.</para>
  676. </summary>
  677. <param name="data">The data associated with asynchronous updating.</param>
  678. </member>
  679. <member name="M:UnityEngine.AI.NavMeshBuilder.CollectSources(UnityEngine.Bounds,System.Int32,UnityEngine.AI.NavMeshCollectGeometry,System.Int32,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildMarkup&gt;,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildSource&gt;)">
  680. <summary>
  681. <para>Collects renderers or physics colliders, and terrains within a volume.</para>
  682. </summary>
  683. <param name="includedWorldBounds">The queried objects must overlap these bounds to be included in the results.</param>
  684. <param name="includedLayerMask">Specifies which layers are included in the query.</param>
  685. <param name="geometry">Which type of geometry to collect - e.g. physics colliders.</param>
  686. <param name="defaultArea">Area type to assign to results, unless modified by NavMeshMarkup.</param>
  687. <param name="markups">List of markups which allows finer control over how objects are collected.</param>
  688. <param name="results">List where results are stored, the list is cleared at the beginning of the call.</param>
  689. </member>
  690. <member name="M:UnityEngine.AI.NavMeshBuilder.CollectSources(UnityEngine.Transform,System.Int32,UnityEngine.AI.NavMeshCollectGeometry,System.Int32,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildMarkup&gt;,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildSource&gt;)">
  691. <summary>
  692. <para>Collects renderers or physics colliders, and terrains within a transform hierarchy.</para>
  693. </summary>
  694. <param name="root">If not null, consider only root and its children in the query; if null, includes everything loaded.</param>
  695. <param name="includedLayerMask">Specifies which layers are included in the query.</param>
  696. <param name="geometry">Which type of geometry to collect - e.g. physics colliders.</param>
  697. <param name="defaultArea">Area type to assign to results, unless modified by NavMeshMarkup.</param>
  698. <param name="markups">List of markups which allows finer control over how objects are collected.</param>
  699. <param name="results">List where results are stored, the list is cleared at the beginning of the call.</param>
  700. </member>
  701. <member name="M:UnityEngine.AI.NavMeshBuilder.UpdateNavMeshData(UnityEngine.AI.NavMeshData,UnityEngine.AI.NavMeshBuildSettings,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildSource&gt;,UnityEngine.Bounds)">
  702. <summary>
  703. <para>Incrementally updates the NavMeshData based on the sources.</para>
  704. </summary>
  705. <param name="data">The NavMeshData to update.</param>
  706. <param name="buildSettings">The build settings which is used to update the NavMeshData. The build settings is also hashed along with the data, so changing settings will cause a full rebuild.</param>
  707. <param name="sources">List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid.</param>
  708. <param name="localBounds">Bounding box relative to position and rotation which describes the volume where the NavMesh should be built. Empty bounds is treated as no-bounds, that is, the NavMesh will cover all the inputs.</param>
  709. <returns>
  710. <para>Returns true if the update was successful.</para>
  711. </returns>
  712. </member>
  713. <member name="M:UnityEngine.AI.NavMeshBuilder.UpdateNavMeshDataAsync(UnityEngine.AI.NavMeshData,UnityEngine.AI.NavMeshBuildSettings,System.Collections.Generic.List`1&lt;UnityEngine.AI.NavMeshBuildSource&gt;,UnityEngine.Bounds)">
  714. <summary>
  715. <para>Asynchronously and incrementally updates the NavMeshData based on the sources.</para>
  716. </summary>
  717. <param name="data">The NavMeshData to update.</param>
  718. <param name="buildSettings">The build settings which is used to update the NavMeshData. The build settings is also hashed along with the data, so changing settings will likely to cause full rebuild.</param>
  719. <param name="sources">List of input geometry used for baking, they describe the surfaces to walk on or obstacles to avoid.</param>
  720. <param name="localBounds">Bounding box relative to position and rotation which describes to volume where the NavMesh should be built. Empty bounds is treated as no-bounds, that is, the NavMesh will cover all the inputs.</param>
  721. <returns>
  722. <para>Can be used to check the progress of the update.</para>
  723. </returns>
  724. </member>
  725. <member name="T:UnityEngine.AI.NavMeshBuildMarkup">
  726. <summary>
  727. <para>The NavMesh build markup allows you to control how certain objects are treated during the NavMesh build process, specifically when collecting sources for building.</para>
  728. </summary>
  729. </member>
  730. <member name="P:UnityEngine.AI.NavMeshBuildMarkup.area">
  731. <summary>
  732. <para>The area type to use when override area is enabled.</para>
  733. </summary>
  734. </member>
  735. <member name="P:UnityEngine.AI.NavMeshBuildMarkup.ignoreFromBuild">
  736. <summary>
  737. <para>Use this to specify whether the GameObject and its children should be ignored.</para>
  738. </summary>
  739. </member>
  740. <member name="P:UnityEngine.AI.NavMeshBuildMarkup.overrideArea">
  741. <summary>
  742. <para>Use this to specify whether the area type of the GameObject and its children should be overridden by the area type specified in this struct.</para>
  743. </summary>
  744. </member>
  745. <member name="P:UnityEngine.AI.NavMeshBuildMarkup.root">
  746. <summary>
  747. <para>Use this to specify which GameObject (including the GameObject’s children) the markup should be applied to.</para>
  748. </summary>
  749. </member>
  750. <member name="T:UnityEngine.AI.NavMeshBuildSettings">
  751. <summary>
  752. <para>The NavMeshBuildSettings struct allows you to specify a collection of settings which describe the dimensions and limitations of a particular agent type.</para>
  753. </summary>
  754. </member>
  755. <member name="P:UnityEngine.AI.NavMeshBuildSettings.agentClimb">
  756. <summary>
  757. <para>The maximum vertical step size an agent can take.</para>
  758. </summary>
  759. </member>
  760. <member name="P:UnityEngine.AI.NavMeshBuildSettings.agentHeight">
  761. <summary>
  762. <para>The height of the agent for baking in world units.</para>
  763. </summary>
  764. </member>
  765. <member name="P:UnityEngine.AI.NavMeshBuildSettings.agentRadius">
  766. <summary>
  767. <para>The radius of the agent for baking in world units.</para>
  768. </summary>
  769. </member>
  770. <member name="P:UnityEngine.AI.NavMeshBuildSettings.agentSlope">
  771. <summary>
  772. <para>The maximum slope angle which is walkable (angle in degrees).</para>
  773. </summary>
  774. </member>
  775. <member name="P:UnityEngine.AI.NavMeshBuildSettings.agentTypeID">
  776. <summary>
  777. <para>The agent type ID the NavMesh will be baked for.</para>
  778. </summary>
  779. </member>
  780. <member name="P:UnityEngine.AI.NavMeshBuildSettings.debug">
  781. <summary>
  782. <para>Options for collecting debug data during the build process.</para>
  783. </summary>
  784. </member>
  785. <member name="P:UnityEngine.AI.NavMeshBuildSettings.minRegionArea">
  786. <summary>
  787. <para>The approximate minimum area of individual NavMesh regions.</para>
  788. </summary>
  789. </member>
  790. <member name="P:UnityEngine.AI.NavMeshBuildSettings.overrideTileSize">
  791. <summary>
  792. <para>Enables overriding the default tile size. See Also: tileSize.</para>
  793. </summary>
  794. </member>
  795. <member name="P:UnityEngine.AI.NavMeshBuildSettings.overrideVoxelSize">
  796. <summary>
  797. <para>Enables overriding the default voxel size. See Also: voxelSize.</para>
  798. </summary>
  799. </member>
  800. <member name="P:UnityEngine.AI.NavMeshBuildSettings.tileSize">
  801. <summary>
  802. <para>Sets the tile size in voxel units.</para>
  803. </summary>
  804. </member>
  805. <member name="P:UnityEngine.AI.NavMeshBuildSettings.voxelSize">
  806. <summary>
  807. <para>Sets the voxel size in world length units.</para>
  808. </summary>
  809. </member>
  810. <member name="M:UnityEngine.AI.NavMeshBuildSettings.ValidationReport(UnityEngine.Bounds)">
  811. <summary>
  812. <para>Validates the properties of NavMeshBuildSettings.</para>
  813. </summary>
  814. <param name="buildBounds">Describes the volume to build NavMesh for.</param>
  815. <returns>
  816. <para>The list of violated constraints.</para>
  817. </returns>
  818. </member>
  819. <member name="T:UnityEngine.AI.NavMeshBuildSource">
  820. <summary>
  821. <para>The input to the NavMesh builder is a list of NavMesh build sources.</para>
  822. </summary>
  823. </member>
  824. <member name="P:UnityEngine.AI.NavMeshBuildSource.area">
  825. <summary>
  826. <para>Describes the area type of the NavMesh surface for this object.</para>
  827. </summary>
  828. </member>
  829. <member name="P:UnityEngine.AI.NavMeshBuildSource.component">
  830. <summary>
  831. <para>Points to the owning component - if available, otherwise null.</para>
  832. </summary>
  833. </member>
  834. <member name="P:UnityEngine.AI.NavMeshBuildSource.shape">
  835. <summary>
  836. <para>The type of the shape this source describes. See Also: NavMeshBuildSourceShape.</para>
  837. </summary>
  838. </member>
  839. <member name="P:UnityEngine.AI.NavMeshBuildSource.size">
  840. <summary>
  841. <para>Describes the dimensions of the shape.</para>
  842. </summary>
  843. </member>
  844. <member name="P:UnityEngine.AI.NavMeshBuildSource.sourceObject">
  845. <summary>
  846. <para>Describes the object referenced for Mesh and Terrain types of input sources.</para>
  847. </summary>
  848. </member>
  849. <member name="P:UnityEngine.AI.NavMeshBuildSource.transform">
  850. <summary>
  851. <para>Describes the local to world transformation matrix of the build source. That is, position and orientation and scale of the shape.</para>
  852. </summary>
  853. </member>
  854. <member name="T:UnityEngine.AI.NavMeshBuildSourceShape">
  855. <summary>
  856. <para>Used with NavMeshBuildSource to define the shape for building NavMesh.</para>
  857. </summary>
  858. </member>
  859. <member name="F:UnityEngine.AI.NavMeshBuildSourceShape.Box">
  860. <summary>
  861. <para>Describes a box primitive for use with NavMeshBuildSource.</para>
  862. </summary>
  863. </member>
  864. <member name="F:UnityEngine.AI.NavMeshBuildSourceShape.Capsule">
  865. <summary>
  866. <para>Describes a capsule primitive for use with NavMeshBuildSource.</para>
  867. </summary>
  868. </member>
  869. <member name="F:UnityEngine.AI.NavMeshBuildSourceShape.Mesh">
  870. <summary>
  871. <para>Describes a Mesh source for use with NavMeshBuildSource.</para>
  872. </summary>
  873. </member>
  874. <member name="F:UnityEngine.AI.NavMeshBuildSourceShape.ModifierBox">
  875. <summary>
  876. <para>Describes a ModifierBox source for use with NavMeshBuildSource.</para>
  877. </summary>
  878. </member>
  879. <member name="F:UnityEngine.AI.NavMeshBuildSourceShape.Sphere">
  880. <summary>
  881. <para>Describes a sphere primitive for use with NavMeshBuildSource.</para>
  882. </summary>
  883. </member>
  884. <member name="F:UnityEngine.AI.NavMeshBuildSourceShape.Terrain">
  885. <summary>
  886. <para>Describes a TerrainData source for use with NavMeshBuildSource.</para>
  887. </summary>
  888. </member>
  889. <member name="T:UnityEngine.AI.NavMeshCollectGeometry">
  890. <summary>
  891. <para>Used for specifying the type of geometry to collect. Used with NavMeshBuilder.CollectSources.</para>
  892. </summary>
  893. </member>
  894. <member name="F:UnityEngine.AI.NavMeshCollectGeometry.PhysicsColliders">
  895. <summary>
  896. <para>Collect geometry from the 3D physics collision representation.</para>
  897. </summary>
  898. </member>
  899. <member name="F:UnityEngine.AI.NavMeshCollectGeometry.RenderMeshes">
  900. <summary>
  901. <para>Collect meshes form the rendered geometry.</para>
  902. </summary>
  903. </member>
  904. <member name="T:UnityEngine.AI.NavMeshData">
  905. <summary>
  906. <para>Contains and represents NavMesh data.</para>
  907. </summary>
  908. </member>
  909. <member name="P:UnityEngine.AI.NavMeshData.position">
  910. <summary>
  911. <para>Gets or sets the world space position of the NavMesh data.</para>
  912. </summary>
  913. </member>
  914. <member name="P:UnityEngine.AI.NavMeshData.rotation">
  915. <summary>
  916. <para>Gets or sets the orientation of the NavMesh data.</para>
  917. </summary>
  918. </member>
  919. <member name="P:UnityEngine.AI.NavMeshData.sourceBounds">
  920. <summary>
  921. <para>Returns the bounding volume of the input geometry used to build this NavMesh (Read Only).</para>
  922. </summary>
  923. </member>
  924. <member name="M:UnityEngine.AI.NavMeshData.#ctor">
  925. <summary>
  926. <para>Constructs a new object for representing a NavMesh for the default agent type.</para>
  927. </summary>
  928. </member>
  929. <member name="M:UnityEngine.AI.NavMeshData.#ctor(System.Int32)">
  930. <summary>
  931. <para>Constructs a new object representing a NavMesh for the specified agent type.</para>
  932. </summary>
  933. <param name="agentTypeID">The agent type ID to create a NavMesh for.</param>
  934. </member>
  935. <member name="T:UnityEngine.AI.NavMeshDataInstance">
  936. <summary>
  937. <para>The instance is returned when adding NavMesh data.</para>
  938. </summary>
  939. </member>
  940. <member name="P:UnityEngine.AI.NavMeshDataInstance.owner">
  941. <summary>
  942. <para>Get or set the owning Object.</para>
  943. </summary>
  944. </member>
  945. <member name="P:UnityEngine.AI.NavMeshDataInstance.valid">
  946. <summary>
  947. <para>True if the NavMesh data is added to the navigation system - otherwise false (Read Only).</para>
  948. </summary>
  949. </member>
  950. <member name="M:UnityEngine.AI.NavMeshDataInstance.Remove">
  951. <summary>
  952. <para>Removes this instance from the NavMesh system.</para>
  953. </summary>
  954. </member>
  955. <member name="T:UnityEngine.AI.NavMeshHit">
  956. <summary>
  957. <para>Result information for NavMesh queries.</para>
  958. </summary>
  959. </member>
  960. <member name="P:UnityEngine.AI.NavMeshHit.distance">
  961. <summary>
  962. <para>Distance to the point of hit.</para>
  963. </summary>
  964. </member>
  965. <member name="P:UnityEngine.AI.NavMeshHit.hit">
  966. <summary>
  967. <para>Flag set when hit.</para>
  968. </summary>
  969. </member>
  970. <member name="P:UnityEngine.AI.NavMeshHit.mask">
  971. <summary>
  972. <para>Mask specifying NavMesh area at point of hit.</para>
  973. </summary>
  974. </member>
  975. <member name="P:UnityEngine.AI.NavMeshHit.normal">
  976. <summary>
  977. <para>Normal at the point of hit.</para>
  978. </summary>
  979. </member>
  980. <member name="P:UnityEngine.AI.NavMeshHit.position">
  981. <summary>
  982. <para>Position of hit.</para>
  983. </summary>
  984. </member>
  985. <member name="T:UnityEngine.AI.NavMeshLinkData">
  986. <summary>
  987. <para>Used for runtime manipulation of links connecting polygons of the NavMesh.</para>
  988. </summary>
  989. </member>
  990. <member name="P:UnityEngine.AI.NavMeshLinkData.agentTypeID">
  991. <summary>
  992. <para>Specifies which agent type this link is available for.</para>
  993. </summary>
  994. </member>
  995. <member name="P:UnityEngine.AI.NavMeshLinkData.area">
  996. <summary>
  997. <para>Area type of the link.</para>
  998. </summary>
  999. </member>
  1000. <member name="P:UnityEngine.AI.NavMeshLinkData.bidirectional">
  1001. <summary>
  1002. <para>If true, the link can be traversed in both directions, otherwise only from start to end position.</para>
  1003. </summary>
  1004. </member>
  1005. <member name="P:UnityEngine.AI.NavMeshLinkData.costModifier">
  1006. <summary>
  1007. <para>If positive, overrides the pathfinder cost to traverse the link.</para>
  1008. </summary>
  1009. </member>
  1010. <member name="P:UnityEngine.AI.NavMeshLinkData.endPosition">
  1011. <summary>
  1012. <para>End position of the link.</para>
  1013. </summary>
  1014. </member>
  1015. <member name="P:UnityEngine.AI.NavMeshLinkData.startPosition">
  1016. <summary>
  1017. <para>Start position of the link.</para>
  1018. </summary>
  1019. </member>
  1020. <member name="P:UnityEngine.AI.NavMeshLinkData.width">
  1021. <summary>
  1022. <para>If positive, the link will be rectangle aligned along the line from start to end.</para>
  1023. </summary>
  1024. </member>
  1025. <member name="T:UnityEngine.AI.NavMeshLinkInstance">
  1026. <summary>
  1027. <para>An instance representing a link available for pathfinding.</para>
  1028. </summary>
  1029. </member>
  1030. <member name="P:UnityEngine.AI.NavMeshLinkInstance.owner">
  1031. <summary>
  1032. <para>Get or set the owning Object.</para>
  1033. </summary>
  1034. </member>
  1035. <member name="P:UnityEngine.AI.NavMeshLinkInstance.valid">
  1036. <summary>
  1037. <para>True if the NavMesh link is added to the navigation system - otherwise false (Read Only).</para>
  1038. </summary>
  1039. </member>
  1040. <member name="M:UnityEngine.AI.NavMeshLinkInstance.Remove">
  1041. <summary>
  1042. <para>Removes this instance from the game.</para>
  1043. </summary>
  1044. </member>
  1045. <member name="T:UnityEngine.AI.NavMeshObstacle">
  1046. <summary>
  1047. <para>An obstacle for NavMeshAgents to avoid.</para>
  1048. </summary>
  1049. </member>
  1050. <member name="P:UnityEngine.AI.NavMeshObstacle.carveOnlyStationary">
  1051. <summary>
  1052. <para>Should this obstacle be carved when it is constantly moving?</para>
  1053. </summary>
  1054. </member>
  1055. <member name="P:UnityEngine.AI.NavMeshObstacle.carving">
  1056. <summary>
  1057. <para>Should this obstacle make a cut-out in the navmesh.</para>
  1058. </summary>
  1059. </member>
  1060. <member name="P:UnityEngine.AI.NavMeshObstacle.carvingMoveThreshold">
  1061. <summary>
  1062. <para>Threshold distance for updating a moving carved hole (when carving is enabled).</para>
  1063. </summary>
  1064. </member>
  1065. <member name="P:UnityEngine.AI.NavMeshObstacle.carvingTimeToStationary">
  1066. <summary>
  1067. <para>Time to wait until obstacle is treated as stationary (when carving and carveOnlyStationary are enabled).</para>
  1068. </summary>
  1069. </member>
  1070. <member name="P:UnityEngine.AI.NavMeshObstacle.center">
  1071. <summary>
  1072. <para>The center of the obstacle, measured in the object's local space.</para>
  1073. </summary>
  1074. </member>
  1075. <member name="P:UnityEngine.AI.NavMeshObstacle.height">
  1076. <summary>
  1077. <para>Height of the obstacle's cylinder shape.</para>
  1078. </summary>
  1079. </member>
  1080. <member name="P:UnityEngine.AI.NavMeshObstacle.radius">
  1081. <summary>
  1082. <para>Radius of the obstacle's capsule shape.</para>
  1083. </summary>
  1084. </member>
  1085. <member name="P:UnityEngine.AI.NavMeshObstacle.shape">
  1086. <summary>
  1087. <para>The shape of the obstacle.</para>
  1088. </summary>
  1089. </member>
  1090. <member name="P:UnityEngine.AI.NavMeshObstacle.size">
  1091. <summary>
  1092. <para>The size of the obstacle, measured in the object's local space.</para>
  1093. </summary>
  1094. </member>
  1095. <member name="P:UnityEngine.AI.NavMeshObstacle.velocity">
  1096. <summary>
  1097. <para>Velocity at which the obstacle moves around the NavMesh.</para>
  1098. </summary>
  1099. </member>
  1100. <member name="T:UnityEngine.AI.NavMeshObstacleShape">
  1101. <summary>
  1102. <para>Shape of the obstacle.</para>
  1103. </summary>
  1104. </member>
  1105. <member name="F:UnityEngine.AI.NavMeshObstacleShape.Box">
  1106. <summary>
  1107. <para>Box shaped obstacle.</para>
  1108. </summary>
  1109. </member>
  1110. <member name="F:UnityEngine.AI.NavMeshObstacleShape.Capsule">
  1111. <summary>
  1112. <para>Capsule shaped obstacle.</para>
  1113. </summary>
  1114. </member>
  1115. <member name="T:UnityEngine.AI.NavMeshPath">
  1116. <summary>
  1117. <para>A path as calculated by the navigation system.</para>
  1118. </summary>
  1119. </member>
  1120. <member name="P:UnityEngine.AI.NavMeshPath.corners">
  1121. <summary>
  1122. <para>Corner points of the path. (Read Only)</para>
  1123. </summary>
  1124. </member>
  1125. <member name="P:UnityEngine.AI.NavMeshPath.status">
  1126. <summary>
  1127. <para>Status of the path. (Read Only)</para>
  1128. </summary>
  1129. </member>
  1130. <member name="M:UnityEngine.AI.NavMeshPath.ClearCorners">
  1131. <summary>
  1132. <para>Erase all corner points from path.</para>
  1133. </summary>
  1134. </member>
  1135. <member name="M:UnityEngine.AI.NavMeshPath.#ctor">
  1136. <summary>
  1137. <para>NavMeshPath constructor.</para>
  1138. </summary>
  1139. </member>
  1140. <member name="M:UnityEngine.AI.NavMeshPath.GetCornersNonAlloc(UnityEngine.Vector3[])">
  1141. <summary>
  1142. <para>Calculate the corners for the path.</para>
  1143. </summary>
  1144. <param name="results">Array to store path corners.</param>
  1145. <returns>
  1146. <para>The number of corners along the path - including start and end points.</para>
  1147. </returns>
  1148. </member>
  1149. <member name="T:UnityEngine.AI.NavMeshPathStatus">
  1150. <summary>
  1151. <para>Status of path.</para>
  1152. </summary>
  1153. </member>
  1154. <member name="F:UnityEngine.AI.NavMeshPathStatus.PathComplete">
  1155. <summary>
  1156. <para>The path terminates at the destination.</para>
  1157. </summary>
  1158. </member>
  1159. <member name="F:UnityEngine.AI.NavMeshPathStatus.PathInvalid">
  1160. <summary>
  1161. <para>The path is invalid.</para>
  1162. </summary>
  1163. </member>
  1164. <member name="F:UnityEngine.AI.NavMeshPathStatus.PathPartial">
  1165. <summary>
  1166. <para>The path cannot reach the destination.</para>
  1167. </summary>
  1168. </member>
  1169. <member name="T:UnityEngine.AI.NavMeshQueryFilter">
  1170. <summary>
  1171. <para>Specifies which agent type and areas to consider when searching the NavMesh.</para>
  1172. </summary>
  1173. </member>
  1174. <member name="P:UnityEngine.AI.NavMeshQueryFilter.agentTypeID">
  1175. <summary>
  1176. <para>The agent type ID, specifying which navigation meshes to consider for the query functions.</para>
  1177. </summary>
  1178. </member>
  1179. <member name="P:UnityEngine.AI.NavMeshQueryFilter.areaMask">
  1180. <summary>
  1181. <para>A bitmask representing the traversable area types.</para>
  1182. </summary>
  1183. </member>
  1184. <member name="M:UnityEngine.AI.NavMeshQueryFilter.GetAreaCost(System.Int32)">
  1185. <summary>
  1186. <para>Returns the area cost multiplier for the given area type for this filter.</para>
  1187. </summary>
  1188. <param name="areaIndex">Index to retreive the cost for.</param>
  1189. <returns>
  1190. <para>The cost multiplier for the supplied area index.</para>
  1191. </returns>
  1192. </member>
  1193. <member name="M:UnityEngine.AI.NavMeshQueryFilter.SetAreaCost(System.Int32,System.Single)">
  1194. <summary>
  1195. <para>Sets the pathfinding cost multiplier for this filter for a given area type.</para>
  1196. </summary>
  1197. <param name="areaIndex">The area index to set the cost for.</param>
  1198. <param name="cost">The cost for the supplied area index.</param>
  1199. </member>
  1200. <member name="T:UnityEngine.AI.NavMeshTriangulation">
  1201. <summary>
  1202. <para>Contains data describing a triangulation of a navmesh.</para>
  1203. </summary>
  1204. </member>
  1205. <member name="F:UnityEngine.AI.NavMeshTriangulation.areas">
  1206. <summary>
  1207. <para>NavMesh area indices for the navmesh triangulation.</para>
  1208. </summary>
  1209. </member>
  1210. <member name="F:UnityEngine.AI.NavMeshTriangulation.indices">
  1211. <summary>
  1212. <para>Triangle indices for the navmesh triangulation.</para>
  1213. </summary>
  1214. </member>
  1215. <member name="P:UnityEngine.AI.NavMeshTriangulation.layers">
  1216. <summary>
  1217. <para>NavMeshLayer values for the navmesh triangulation.</para>
  1218. </summary>
  1219. </member>
  1220. <member name="F:UnityEngine.AI.NavMeshTriangulation.vertices">
  1221. <summary>
  1222. <para>Vertices for the navmesh triangulation.</para>
  1223. </summary>
  1224. </member>
  1225. <member name="T:UnityEngine.AI.ObstacleAvoidanceType">
  1226. <summary>
  1227. <para>Level of obstacle avoidance.</para>
  1228. </summary>
  1229. </member>
  1230. <member name="F:UnityEngine.AI.ObstacleAvoidanceType.GoodQualityObstacleAvoidance">
  1231. <summary>
  1232. <para>Good avoidance. High performance impact.</para>
  1233. </summary>
  1234. </member>
  1235. <member name="F:UnityEngine.AI.ObstacleAvoidanceType.HighQualityObstacleAvoidance">
  1236. <summary>
  1237. <para>Enable highest precision. Highest performance impact.</para>
  1238. </summary>
  1239. </member>
  1240. <member name="F:UnityEngine.AI.ObstacleAvoidanceType.LowQualityObstacleAvoidance">
  1241. <summary>
  1242. <para>Enable simple avoidance. Low performance impact.</para>
  1243. </summary>
  1244. </member>
  1245. <member name="F:UnityEngine.AI.ObstacleAvoidanceType.MedQualityObstacleAvoidance">
  1246. <summary>
  1247. <para>Medium avoidance. Medium performance impact.</para>
  1248. </summary>
  1249. </member>
  1250. <member name="F:UnityEngine.AI.ObstacleAvoidanceType.NoObstacleAvoidance">
  1251. <summary>
  1252. <para>Disable avoidance.</para>
  1253. </summary>
  1254. </member>
  1255. <member name="T:UnityEngine.AI.OffMeshLink">
  1256. <summary>
  1257. <para>Link allowing movement outside the planar navigation mesh.</para>
  1258. </summary>
  1259. </member>
  1260. <member name="P:UnityEngine.AI.OffMeshLink.activated">
  1261. <summary>
  1262. <para>Is link active.</para>
  1263. </summary>
  1264. </member>
  1265. <member name="P:UnityEngine.AI.OffMeshLink.area">
  1266. <summary>
  1267. <para>NavMesh area index for this OffMeshLink component.</para>
  1268. </summary>
  1269. </member>
  1270. <member name="P:UnityEngine.AI.OffMeshLink.autoUpdatePositions">
  1271. <summary>
  1272. <para>Automatically update endpoints.</para>
  1273. </summary>
  1274. </member>
  1275. <member name="P:UnityEngine.AI.OffMeshLink.biDirectional">
  1276. <summary>
  1277. <para>Can link be traversed in both directions.</para>
  1278. </summary>
  1279. </member>
  1280. <member name="P:UnityEngine.AI.OffMeshLink.costOverride">
  1281. <summary>
  1282. <para>Modify pathfinding cost for the link.</para>
  1283. </summary>
  1284. </member>
  1285. <member name="P:UnityEngine.AI.OffMeshLink.endTransform">
  1286. <summary>
  1287. <para>The transform representing link end position.</para>
  1288. </summary>
  1289. </member>
  1290. <member name="P:UnityEngine.AI.OffMeshLink.navMeshLayer">
  1291. <summary>
  1292. <para>NavMeshLayer for this OffMeshLink component.</para>
  1293. </summary>
  1294. </member>
  1295. <member name="P:UnityEngine.AI.OffMeshLink.occupied">
  1296. <summary>
  1297. <para>Is link occupied. (Read Only)</para>
  1298. </summary>
  1299. </member>
  1300. <member name="P:UnityEngine.AI.OffMeshLink.startTransform">
  1301. <summary>
  1302. <para>The transform representing link start position.</para>
  1303. </summary>
  1304. </member>
  1305. <member name="M:UnityEngine.AI.OffMeshLink.UpdatePositions">
  1306. <summary>
  1307. <para>Explicitly update the link endpoints.</para>
  1308. </summary>
  1309. </member>
  1310. <member name="T:UnityEngine.AI.OffMeshLinkData">
  1311. <summary>
  1312. <para>State of OffMeshLink.</para>
  1313. </summary>
  1314. </member>
  1315. <member name="P:UnityEngine.AI.OffMeshLinkData.activated">
  1316. <summary>
  1317. <para>Is link active (Read Only).</para>
  1318. </summary>
  1319. </member>
  1320. <member name="P:UnityEngine.AI.OffMeshLinkData.endPos">
  1321. <summary>
  1322. <para>Link end world position (Read Only).</para>
  1323. </summary>
  1324. </member>
  1325. <member name="P:UnityEngine.AI.OffMeshLinkData.linkType">
  1326. <summary>
  1327. <para>Link type specifier (Read Only).</para>
  1328. </summary>
  1329. </member>
  1330. <member name="P:UnityEngine.AI.OffMeshLinkData.offMeshLink">
  1331. <summary>
  1332. <para>The OffMeshLink if the link type is a manually placed Offmeshlink (Read Only).</para>
  1333. </summary>
  1334. </member>
  1335. <member name="P:UnityEngine.AI.OffMeshLinkData.startPos">
  1336. <summary>
  1337. <para>Link start world position (Read Only).</para>
  1338. </summary>
  1339. </member>
  1340. <member name="P:UnityEngine.AI.OffMeshLinkData.valid">
  1341. <summary>
  1342. <para>Is link valid (Read Only).</para>
  1343. </summary>
  1344. </member>
  1345. <member name="T:UnityEngine.AI.OffMeshLinkType">
  1346. <summary>
  1347. <para>Link type specifier.</para>
  1348. </summary>
  1349. </member>
  1350. <member name="F:UnityEngine.AI.OffMeshLinkType.LinkTypeDropDown">
  1351. <summary>
  1352. <para>Vertical drop.</para>
  1353. </summary>
  1354. </member>
  1355. <member name="F:UnityEngine.AI.OffMeshLinkType.LinkTypeJumpAcross">
  1356. <summary>
  1357. <para>Horizontal jump.</para>
  1358. </summary>
  1359. </member>
  1360. <member name="F:UnityEngine.AI.OffMeshLinkType.LinkTypeManual">
  1361. <summary>
  1362. <para>Manually specified type of link.</para>
  1363. </summary>
  1364. </member>
  1365. <member name="T:UnityEngine.Experimental.AI.NavMeshLocation">
  1366. <summary>
  1367. <para>A world position that is guaranteed to be on the surface of the NavMesh.</para>
  1368. </summary>
  1369. </member>
  1370. <member name="P:UnityEngine.Experimental.AI.NavMeshLocation.polygon">
  1371. <summary>
  1372. <para>Unique identifier for the node in the NavMesh to which the world position has been mapped.</para>
  1373. </summary>
  1374. </member>
  1375. <member name="P:UnityEngine.Experimental.AI.NavMeshLocation.position">
  1376. <summary>
  1377. <para>A world position that sits precisely on the surface of the NavMesh or along its links.</para>
  1378. </summary>
  1379. </member>
  1380. <member name="T:UnityEngine.Experimental.AI.NavMeshPolyTypes">
  1381. <summary>
  1382. <para>The types of nodes in the navigation data.</para>
  1383. </summary>
  1384. </member>
  1385. <member name="F:UnityEngine.Experimental.AI.NavMeshPolyTypes.Ground">
  1386. <summary>
  1387. <para>Type of node in the NavMesh representing one surface polygon.</para>
  1388. </summary>
  1389. </member>
  1390. <member name="F:UnityEngine.Experimental.AI.NavMeshPolyTypes.OffMeshConnection">
  1391. <summary>
  1392. <para>Type of node in the NavMesh representing a point-to-point connection between two positions on the NavMesh surface.</para>
  1393. </summary>
  1394. </member>
  1395. <member name="T:UnityEngine.Experimental.AI.NavMeshQuery">
  1396. <summary>
  1397. <para>Object used for doing navigation operations in a NavMeshWorld.</para>
  1398. </summary>
  1399. </member>
  1400. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.BeginFindPath(UnityEngine.Experimental.AI.NavMeshLocation,UnityEngine.Experimental.AI.NavMeshLocation,System.Int32,Unity.Collections.NativeArray`1&lt;System.Single&gt;)">
  1401. <summary>
  1402. <para>Initiates a pathfinding operation between two locations on the NavMesh.</para>
  1403. </summary>
  1404. <param name="costs">Array of custom cost values for all of the 32 possible area types. Each value must be at least 1.0f. This parameter is optional and defaults to the area costs configured in the project settings. See Also: NavMesh.GetAreaCost.</param>
  1405. <param name="areaMask">Bitmask with values of 1 set at the indices for areas that can be traversed, and values of 0 for areas that are not traversable. This parameter is optional and defaults to NavMesh.AllAreas, if omitted. See Also:.</param>
  1406. <param name="start">The start location on the NavMesh for the path.</param>
  1407. <param name="end">The location on the NavMesh where the path ends.</param>
  1408. <returns>
  1409. <para>InProgress if the operation was successful and the query is ready to search for a path.
  1410. Failure if the query's NavMeshWorld or any of the received parameters are no longer valid.</para>
  1411. </returns>
  1412. </member>
  1413. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.CreateLocation(UnityEngine.Vector3,UnityEngine.Experimental.AI.PolygonId)">
  1414. <summary>
  1415. <para>Returns a valid NavMeshLocation for a position and a polygon provided by the user.</para>
  1416. </summary>
  1417. <param name="position">World position of the NavMeshLocation to be created.</param>
  1418. <param name="polygon">Valid identifier for the NavMesh node.</param>
  1419. <returns>
  1420. <para>Object containing the desired position and NavMesh node.</para>
  1421. </returns>
  1422. </member>
  1423. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.#ctor(UnityEngine.Experimental.AI.NavMeshWorld,Unity.Collections.Allocator,System.Int32)">
  1424. <summary>
  1425. <para>Creates the NavMeshQuery object and allocates memory to store NavMesh node information, if required.</para>
  1426. </summary>
  1427. <param name="world">NavMeshWorld object used as an entry point to the collection of NavMesh objects. This object that can be used by query operations.</param>
  1428. <param name="allocator">Label indicating the desired life time of the object. (Known issue: Currently allocator has no effect).</param>
  1429. <param name="pathNodePoolSize">The number of nodes that can be temporarily stored in the query during search operations. This value defaults to 0 if no other value is specified.</param>
  1430. </member>
  1431. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.Dispose">
  1432. <summary>
  1433. <para>Destroys the NavMeshQuery and deallocates all memory used by it.</para>
  1434. </summary>
  1435. </member>
  1436. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.EndFindPath(System.Int32&amp;)">
  1437. <summary>
  1438. <para>Obtains the number of nodes in the path that has been computed during a successful NavMeshQuery.UpdateFindPath operation.</para>
  1439. </summary>
  1440. <param name="pathSize">A reference to an int which will be set to the number of NavMesh nodes in the found path.</param>
  1441. <returns>
  1442. <para>Success when the number of nodes in the path was retrieved correctly.
  1443. PartialPath when a path was found but it falls short of the desired end location.
  1444. Failure when the path size can not be evaluated because the preceding call to UpdateFindPath was not successful.</para>
  1445. </returns>
  1446. </member>
  1447. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.GetAgentTypeIdForPolygon(UnityEngine.Experimental.AI.PolygonId)">
  1448. <summary>
  1449. <para>Returns the identifier of the agent type the NavMesh was baked for or for which the link has been configured.</para>
  1450. </summary>
  1451. <param name="polygon">Identifier of a node from a NavMesh surface or link.</param>
  1452. <returns>
  1453. <para>Agent type identifier.</para>
  1454. </returns>
  1455. </member>
  1456. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.GetPathResult(Unity.Collections.NativeSlice`1&lt;UnityEngine.Experimental.AI.PolygonId&gt;)">
  1457. <summary>
  1458. <para>Copies into the provided array the list of NavMesh nodes that form the path found by the NavMeshQuery operation.</para>
  1459. </summary>
  1460. <param name="path">Data array to be filled with the sequence of NavMesh nodes that comprises the found path.</param>
  1461. <returns>
  1462. <para>Number of path nodes successfully copied into the provided array.</para>
  1463. </returns>
  1464. </member>
  1465. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.GetPolygonType(UnityEngine.Experimental.AI.PolygonId)">
  1466. <summary>
  1467. <para>Returns whether the NavMesh node is a polygon or a link.</para>
  1468. </summary>
  1469. <param name="polygon">Identifier of a node from a NavMesh surface or link.</param>
  1470. <returns>
  1471. <para>Ground when the node is a polygon on a NavMesh surface.
  1472. OffMeshConnection when the node is a.</para>
  1473. </returns>
  1474. </member>
  1475. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.GetPortalPoints(UnityEngine.Experimental.AI.PolygonId,UnityEngine.Experimental.AI.PolygonId,UnityEngine.Vector3&amp;,UnityEngine.Vector3&amp;)">
  1476. <summary>
  1477. <para>Obtains the end points of the line segment common to two adjacent NavMesh nodes.</para>
  1478. </summary>
  1479. <param name="polygon">First NavMesh node.</param>
  1480. <param name="neighbourPolygon">Second NavMesh node.</param>
  1481. <param name="left">One of the world points for the resulting separation edge which must be passed through when traversing between the two specified nodes. This point is the left side of the edge when traversing from the first node to the second.</param>
  1482. <param name="right">One of the world points for the resulting separation edge which must be passed through when traversing between the two specified nodes. This point is the right side of the edge when traversing from the first node to the second.</param>
  1483. <returns>
  1484. <para>True if a connection exists between the two NavMesh nodes.
  1485. False if no connection exists between the two NavMesh nodes.</para>
  1486. </returns>
  1487. </member>
  1488. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.IsValid(UnityEngine.Experimental.AI.PolygonId)">
  1489. <summary>
  1490. <para>Returns true if the node referenced by the specified PolygonId is active in the NavMesh.</para>
  1491. </summary>
  1492. <param name="polygon">Identifier of the NavMesh node to be checked.</param>
  1493. </member>
  1494. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.IsValid(UnityEngine.Experimental.AI.NavMeshLocation)">
  1495. <summary>
  1496. <para>Returns true if the node referenced by the PolygonId contained in the NavMeshLocation is active in the NavMesh.</para>
  1497. </summary>
  1498. <param name="location">Location on the NavMesh to be checked. Same as checking location.polygon directly.</param>
  1499. </member>
  1500. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.MapLocation(UnityEngine.Vector3,UnityEngine.Vector3,System.Int32,System.Int32)">
  1501. <summary>
  1502. <para>Finds the closest point and PolygonId on the NavMesh for a given world position.</para>
  1503. </summary>
  1504. <param name="position">World position for which the closest point on the NavMesh needs to be found.</param>
  1505. <param name="extents">Maximum distance, from the specified position, expanding along all three axes, within which NavMesh surfaces are searched.</param>
  1506. <param name="agentTypeID">Identifier for the agent type whose NavMesh surfaces should be selected for this operation. The Humanoid agent type exists for all NavMeshes and has an ID of 0. Other agent types can be defined manually through the Editor. A separate NavMesh surface needs to be baked for each agent type.</param>
  1507. <param name="areaMask">Bitmask used to represent areas of the NavMesh that should (value of 1) or shouldn't (values of 0) be sampled. This parameter is optional and defaults to NavMesh.AllAreas if unspecified. See Also:.</param>
  1508. <returns>
  1509. <para>An object with position and valid PolygonId - when a point on the NavMesh has been found.
  1510. An invalid object - when no NavMesh surface with the desired features has been found within the search area. See Also: NavMeshQuery.IsValid.</para>
  1511. </returns>
  1512. </member>
  1513. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.MoveLocation(UnityEngine.Experimental.AI.NavMeshLocation,UnityEngine.Vector3,System.Int32)">
  1514. <summary>
  1515. <para>Translates a NavMesh location to another position without losing contact with the surface.</para>
  1516. </summary>
  1517. <param name="location">Position to be moved across the NavMesh surface.</param>
  1518. <param name="target">World position you require the agent to move to.</param>
  1519. <param name="areaMask">Bitmask with values of 1 set at the indices corresponding to areas that can be traversed, and with values of 0 for areas that should not be traversed. This parameter can be omitted, in which case it defaults to NavMesh.AllAreas. See Also:.</param>
  1520. <returns>
  1521. <para>A new location on the NavMesh placed as closely as possible to the specified target position.
  1522. The start location is returned when that start is inside an area which is not allowed by the areaMask.</para>
  1523. </returns>
  1524. </member>
  1525. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.MoveLocations(Unity.Collections.NativeSlice`1&lt;UnityEngine.Experimental.AI.NavMeshLocation&gt;,Unity.Collections.NativeSlice`1&lt;UnityEngine.Vector3&gt;,Unity.Collections.NativeSlice`1&lt;System.Int32&gt;)">
  1526. <summary>
  1527. <para>Translates a series of NavMesh locations to other positions without losing contact with the surface.</para>
  1528. </summary>
  1529. <param name="locations">Array of positions to be moved across the NavMesh surface. At the end of the method call this array contains the resulting locations.</param>
  1530. <param name="targets">World positions to be used as movement targets by the agent.</param>
  1531. <param name="areaMasks">Filters for the areas which can be traversed during the movement to each of the locations.</param>
  1532. </member>
  1533. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.MoveLocationsInSameAreas(Unity.Collections.NativeSlice`1&lt;UnityEngine.Experimental.AI.NavMeshLocation&gt;,Unity.Collections.NativeSlice`1&lt;UnityEngine.Vector3&gt;,System.Int32)">
  1534. <summary>
  1535. <para>Translates a series of NavMesh locations to other positions without losing contact with the surface, given one common area filter for all of them.</para>
  1536. </summary>
  1537. <param name="locations">Array of positions to be moved across the NavMesh surface. At the end of the method call this array contains the resulting locations.</param>
  1538. <param name="targets">World positions you want the agent to reach when moving to each of the locations.</param>
  1539. <param name="areaMask">Filters for the areas which can be traversed during the movement to each of the locations.</param>
  1540. </member>
  1541. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.PolygonLocalToWorldMatrix(UnityEngine.Experimental.AI.PolygonId)">
  1542. <summary>
  1543. <para>Returns the transformation matrix of the NavMesh surface that contains the specified NavMesh node (Read Only).</para>
  1544. </summary>
  1545. <param name="polygon">NavMesh node for which its owner's transform must be determined.</param>
  1546. <returns>
  1547. <para>Transformation matrix for the surface owning the specified polygon.
  1548. Matrix4x4.identity when the NavMesh node is a.</para>
  1549. </returns>
  1550. </member>
  1551. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.PolygonWorldToLocalMatrix(UnityEngine.Experimental.AI.PolygonId)">
  1552. <summary>
  1553. <para>Returns the inverse transformation matrix of the NavMesh surface that contains the specified NavMesh node (Read Only).</para>
  1554. </summary>
  1555. <param name="polygon">NavMesh node for which its owner's inverse transform must be determined.</param>
  1556. <returns>
  1557. <para>Inverse transformation matrix of the surface owning the specified polygon.
  1558. Matrix4x4.identity when the NavMesh node is a.</para>
  1559. </returns>
  1560. </member>
  1561. <member name="M:UnityEngine.Experimental.AI.NavMeshQuery.UpdateFindPath(System.Int32,System.Int32&amp;)">
  1562. <summary>
  1563. <para>Continues a path search that is in progress.</para>
  1564. </summary>
  1565. <param name="iterations">Maximum number of nodes to be traversed by the search algorithm during this call.</param>
  1566. <param name="iterationsPerformed">Outputs the actual number of nodes that have been traversed during this call.</param>
  1567. <returns>
  1568. <para>InProgress if the search needs to continue further by calling UpdateFindPath again.
  1569. Success if the search is completed and a path has been found or not.
  1570. Failure if the search for the desired position could not be completed because the NavMesh has changed significantly since the search was initiated.
  1571. Additionally the returned value can contain the OutOfNodes flag when the pathNodePoolSize parameter for the NavMeshQuery initialization was not large enough to accommodate the search space.</para>
  1572. </returns>
  1573. </member>
  1574. <member name="T:UnityEngine.Experimental.AI.NavMeshWorld">
  1575. <summary>
  1576. <para>Assembles together a collection of NavMesh surfaces and links that are used as a whole for performing navigation operations.</para>
  1577. </summary>
  1578. </member>
  1579. <member name="M:UnityEngine.Experimental.AI.NavMeshWorld.AddDependency(Unity.Jobs.JobHandle)">
  1580. <summary>
  1581. <para>Tells the NavMesh world to halt any changes until the specified job is completed.</para>
  1582. </summary>
  1583. <param name="job">The job that needs to be completed before the NavMesh world can be modified in any way.</param>
  1584. </member>
  1585. <member name="M:UnityEngine.Experimental.AI.NavMeshWorld.GetDefaultWorld">
  1586. <summary>
  1587. <para>Returns a reference to the single NavMeshWorld that can currently exist and be used in Unity.</para>
  1588. </summary>
  1589. </member>
  1590. <member name="M:UnityEngine.Experimental.AI.NavMeshWorld.IsValid">
  1591. <summary>
  1592. <para>Returns true if the NavMeshWorld has been properly initialized.</para>
  1593. </summary>
  1594. </member>
  1595. <member name="T:UnityEngine.Experimental.AI.PathQueryStatus">
  1596. <summary>
  1597. <para>Bit flags representing the resulting state of NavMeshQuery operations.</para>
  1598. </summary>
  1599. </member>
  1600. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.BufferTooSmall">
  1601. <summary>
  1602. <para>The node buffer of the query was too small to store all results.</para>
  1603. </summary>
  1604. </member>
  1605. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.Failure">
  1606. <summary>
  1607. <para>The operation has failed.</para>
  1608. </summary>
  1609. </member>
  1610. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.InProgress">
  1611. <summary>
  1612. <para>The operation is in progress.</para>
  1613. </summary>
  1614. </member>
  1615. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.InvalidParam">
  1616. <summary>
  1617. <para>A parameter did not contain valid information, useful for carring out the NavMesh query.</para>
  1618. </summary>
  1619. </member>
  1620. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.OutOfMemory">
  1621. <summary>
  1622. <para>Operation ran out of memory.</para>
  1623. </summary>
  1624. </member>
  1625. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.OutOfNodes">
  1626. <summary>
  1627. <para>Query ran out of node stack space during a search.</para>
  1628. </summary>
  1629. </member>
  1630. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.PartialResult">
  1631. <summary>
  1632. <para>Query did not reach the end location, returning best guess.</para>
  1633. </summary>
  1634. </member>
  1635. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.StatusDetailMask">
  1636. <summary>
  1637. <para>Bitmask that has 0 set for the Success, Failure and InProgress bits and 1 set for all the other flags.</para>
  1638. </summary>
  1639. </member>
  1640. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.Success">
  1641. <summary>
  1642. <para>The operation was successful.</para>
  1643. </summary>
  1644. </member>
  1645. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.WrongMagic">
  1646. <summary>
  1647. <para>Data in the NavMesh cannot be recognized and used.</para>
  1648. </summary>
  1649. </member>
  1650. <member name="F:UnityEngine.Experimental.AI.PathQueryStatus.WrongVersion">
  1651. <summary>
  1652. <para>Data in the NavMesh world has a wrong version.</para>
  1653. </summary>
  1654. </member>
  1655. <member name="T:UnityEngine.Experimental.AI.PolygonId">
  1656. <summary>
  1657. <para>Represents a compact identifier for the data of a NavMesh node.</para>
  1658. </summary>
  1659. </member>
  1660. <member name="M:UnityEngine.Experimental.AI.PolygonId.Equals(UnityEngine.Experimental.AI.PolygonId)">
  1661. <summary>
  1662. <para>Returns true if two PolygonId objects refer to the same NavMesh node.</para>
  1663. </summary>
  1664. <param name="rhs"></param>
  1665. <param name="obj"></param>
  1666. </member>
  1667. <member name="M:UnityEngine.Experimental.AI.PolygonId.Equals(System.Object)">
  1668. <summary>
  1669. <para>Returns true if two PolygonId objects refer to the same NavMesh node.</para>
  1670. </summary>
  1671. <param name="rhs"></param>
  1672. <param name="obj"></param>
  1673. </member>
  1674. <member name="M:UnityEngine.Experimental.AI.PolygonId.GetHashCode">
  1675. <summary>
  1676. <para>Returns the hash code for use in collections.</para>
  1677. </summary>
  1678. </member>
  1679. <member name="M:UnityEngine.Experimental.AI.PolygonId.IsNull">
  1680. <summary>
  1681. <para>Returns true if the PolygonId has been created empty and has never pointed to any node in the NavMesh.</para>
  1682. </summary>
  1683. </member>
  1684. <member name="?:UnityEngine.Experimental.AI.PolygonId.op_Equal(UnityEngine.Experimental.AI.PolygonId,UnityEngine.Experimental.AI.PolygonId)">
  1685. <summary>
  1686. <para>Returns true if two PolygonId objects refer to the same NavMesh node or if they are both null.</para>
  1687. </summary>
  1688. <param name="x"></param>
  1689. <param name="y"></param>
  1690. </member>
  1691. <member name="?:UnityEngine.Experimental.AI.PolygonId.op_NotEqual(UnityEngine.Experimental.AI.PolygonId,UnityEngine.Experimental.AI.PolygonId)">
  1692. <summary>
  1693. <para>Returns true if two PolygonId objects refer to different NavMesh nodes or if only one of them is null.</para>
  1694. </summary>
  1695. <param name="x"></param>
  1696. <param name="y"></param>
  1697. </member>
  1698. <member name="A:UnityEngine.AIModule">
  1699. <summary>
  1700. <para>The AI module implements the path finding features in Unity.</para>
  1701. </summary>
  1702. </member>
  1703. </members>
  1704. </doc>