godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/NavigationMeshGenerator.xml

31 lines
1022 B
XML
Raw Normal View History

doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="NavigationMeshGenerator" inherits="Object" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<brief_description>
Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
This class is responsible for creating and clearing navigation meshes.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</brief_description>
<description>
Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
This class is responsible for creating and clearing navigation meshes.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="bake">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="nav_mesh" type="NavigationMesh" />
<argument index="1" name="root_node" type="Node" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
Bakes the navigation mesh. This will allow you to use pathfinding with the navigation system.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="nav_mesh" type="NavigationMesh" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Backport NavigationServer with RVO2 to `3.x` Change the entire navigation system. Remove editor prefix from nav mesh generator class. It is now used for baking at runtime as well. Navigation supports obstacle avoidance now with the RVO2 library. Nav system will also automatically link all nav meshes together to form one overall complete nav map.
2021-12-16 05:15:23 +00:00
Clears the navigation mesh.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
</methods>
<constants>
</constants>
</class>