virtualx-engine/doc/classes/NavigationMeshGenerator.xml
Hugo Locurcio b087538119
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 23:01:02 +01:00

30 lines
1,022 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationMeshGenerator" inherits="Object" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
This class is responsible for creating and clearing navigation meshes.
</brief_description>
<description>
This class is responsible for creating and clearing navigation meshes.
</description>
<tutorials>
</tutorials>
<methods>
<method name="bake">
<return type="void" />
<argument index="0" name="nav_mesh" type="NavigationMesh" />
<argument index="1" name="root_node" type="Node" />
<description>
Bakes the navigation mesh. This will allow you to use pathfinding with the navigation system.
</description>
</method>
<method name="clear">
<return type="void" />
<argument index="0" name="nav_mesh" type="NavigationMesh" />
<description>
Clears the navigation mesh.
</description>
</method>
</methods>
<constants>
</constants>
</class>