pandemonium_engine/doc/classes/NavigationGeometryParser3D.xml

32 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationGeometryParser3D" inherits="Reference" version="4.3">
<brief_description>
Parser to contribute a node's geometry data for [NavigationMesh] baking.
</brief_description>
<description>
Parser to contribute a node's geometry data for [NavigationMesh] baking. If a script extends this class and the function [method _parses_node] is overridden and returns [code]true[/code], the overridden function [method _parse_geometry] gets called and can be used to add custom geometry data for the [NavigationMesh] baking process.
</description>
<tutorials>
</tutorials>
<methods>
<method name="_parse_geometry" qualifiers="virtual">
<return type="void" />
<argument index="0" name="node" type="Node" />
<argument index="1" name="navigation_mesh" type="NavigationMesh" />
<argument index="2" name="source_geometry" type="NavigationMeshSourceGeometryData3D" />
<description>
Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationMesh] baking. Custom 3D geometry can be added to the [param source_geometry].
</description>
</method>
<method name="_parses_node" qualifiers="virtual">
<return type="bool" />
<argument index="0" name="node" type="Node" />
<description>
Called when parsing geometry nodes for [NavigationMesh] baking. If [code]true[/code] will call [method _parse_geometry] with this node.
</description>
</method>
</methods>
<constants>
</constants>
</class>