virtualx-engine/doc/classes/NavigationMeshInstance.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationMeshInstance" inherits="Spatial" version="3.5">
	<brief_description>
		An instance of a [NavigationMesh].
	</brief_description>
	<description>
		An instance of a [NavigationMesh]. It tells the [Navigation] node what can be navigated and what cannot, based on the [NavigationMesh] resource. This should be a child of a [Navigation] node.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="bake_navigation_mesh">
			<return type="void" />
			<description>
				Bakes the [NavigationMesh]. The baking is done in a seperate thread because navigation baking is not a cheap operation. This can be done at runtime. When it is completed, it automatically sets the new [NavigationMesh].
			</description>
		</method>
	</methods>
	<members>
		<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled" default="true">
			Determines if the [NavigationMeshInstance] is enabled or disabled.
		</member>
		<member name="navmesh" type="NavigationMesh" setter="set_navigation_mesh" getter="get_navigation_mesh">
			The [NavigationMesh] resource to use.
		</member>
	</members>
	<signals>
		<signal name="bake_finished">
			<description>
				Notifies when the navigation mesh bake operation is completed.
			</description>
		</signal>
		<signal name="navigation_mesh_changed">
			<description>
				Notifies when the [NavigationMesh] has changed.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>