virtualx-engine/doc/classes/NavigationMesh.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationMesh" inherits="Resource" version="4.0">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
		<link title="3D Navmesh Demo">https://godotengine.org/asset-library/asset/124</link>
	</tutorials>
	<methods>
		<method name="add_polygon">
			<return type="void">
			</return>
			<argument index="0" name="polygon" type="PackedInt32Array">
			</argument>
			<description>
			</description>
		</method>
		<method name="clear_polygons">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
		<method name="create_from_mesh">
			<return type="void">
			</return>
			<argument index="0" name="mesh" type="Mesh">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_collision_mask_bit" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="bit" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_polygon">
			<return type="PackedInt32Array">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_polygon_count" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_vertices" qualifiers="const">
			<return type="PackedVector3Array">
			</return>
			<description>
			</description>
		</method>
		<method name="set_collision_mask_bit">
			<return type="void">
			</return>
			<argument index="0" name="bit" type="int">
			</argument>
			<argument index="1" name="value" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_vertices">
			<return type="void">
			</return>
			<argument index="0" name="vertices" type="PackedVector3Array">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height" default="2.0">
			The minimum Y space needed for navigation to be generated.
		</member>
		<member name="agent/max_climb" type="float" setter="set_agent_max_climb" getter="get_agent_max_climb" default="0.9">
			The maximum height difference between two areas for navigation to be generated between them.
		</member>
		<member name="agent/max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope" default="45.0">
			The maximum angle a slope can be at for navigation to be generated on it.
		</member>
		<member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="0.6">
			Determines where the edge of a navigation mesh is. This way an agent will not overlap with another mesh or stand over nothing.
		</member>
		<member name="cell/height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.2">
			The height of a cell.
		</member>
		<member name="cell/size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.3">
			The size of cells in the [NavigationMesh].
		</member>
		<member name="detail/sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance" default="6.0">
		</member>
		<member name="detail/sample_max_error" type="float" setter="set_detail_sample_max_error" getter="get_detail_sample_max_error" default="1.0">
		</member>
		<member name="edge/max_error" type="float" setter="set_edge_max_error" getter="get_edge_max_error" default="1.3">
		</member>
		<member name="edge/max_length" type="float" setter="set_edge_max_length" getter="get_edge_max_length" default="12.0">
		</member>
		<member name="filter/filter_walkable_low_height_spans" type="bool" setter="set_filter_walkable_low_height_spans" getter="get_filter_walkable_low_height_spans" default="false">
		</member>
		<member name="filter/ledge_spans" type="bool" setter="set_filter_ledge_spans" getter="get_filter_ledge_spans" default="false">
		</member>
		<member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles" default="false">
		</member>
		<member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
			The physics layers used to generate the [NavigationMesh].
		</member>
		<member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type" default="0">
			What kind of geometry is used to generate the [NavigationMesh].
		</member>
		<member name="geometry/source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" default="0">
			Which geometry is used to generate the [NavigationMesh].
		</member>
		<member name="geometry/source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name">
			The name of the group that is used to generate the [NavigationMesh].
		</member>
		<member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly" default="6.0">
			The number of vertices to use per polygon. Higher values will improve performance at the cost of lower precision.
		</member>
		<member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0">
			If two adjacent regions' edges are separated by a distance lower than this value, the regions will be merged together.
		</member>
		<member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size" default="8.0">
			The minimum size of a region for it to be created.
		</member>
		<member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type" default="0">
		</member>
	</members>
	<constants>
		<constant name="SAMPLE_PARTITION_WATERSHED" value="0">
		</constant>
		<constant name="SAMPLE_PARTITION_MONOTONE" value="1">
		</constant>
		<constant name="SAMPLE_PARTITION_LAYERS" value="2">
		</constant>
		<constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0">
		</constant>
		<constant name="PARSED_GEOMETRY_STATIC_COLLIDERS" value="1">
		</constant>
		<constant name="PARSED_GEOMETRY_BOTH" value="2">
		</constant>
	</constants>
</class>