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

136 lines
6.0 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="NavigationMesh" inherits="Resource" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="3D Navmesh Demo">https://godotengine.org/asset-library/asset/124</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="add_polygon">
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="polygon" type="PackedInt32Array" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
<method name="clear_polygons">
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
<method name="create_from_mesh">
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="mesh" type="Mesh" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<method name="get_collision_mask_bit" qualifiers="const">
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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="bit" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_polygon">
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.
2021-07-30 13:28:05 +00:00
<return type="PackedInt32Array" />
<argument index="0" name="idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
<method name="get_polygon_count" qualifiers="const">
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.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
</description>
</method>
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 07:29:38 +00:00
<method name="get_vertices" qualifiers="const">
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.
2021-07-30 13:28:05 +00:00
<return type="PackedVector3Array" />
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 07:29:38 +00:00
<description>
</description>
</method>
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<method name="set_collision_mask_bit">
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="bit" type="int" />
<argument index="1" name="value" type="bool" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
</description>
</method>
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 07:29:38 +00:00
<method name="set_vertices">
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="vertices" type="PackedVector3Array" />
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 07:29:38 +00:00
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="agent/height" type="float" setter="set_agent_height" getter="get_agent_height" default="2.0">
Document more NavigationMesh properties
2020-10-21 19:50:19 +00:00
The minimum Y space needed for navigation to be generated.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="agent/max_climb" type="float" setter="set_agent_max_climb" getter="get_agent_max_climb" default="0.9">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The maximum height difference between two areas for navigation to be generated between them.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="agent/max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope" default="45.0">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The maximum angle a slope can be at for navigation to be generated on it.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="agent/radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="0.6">
Document more NavigationMesh properties
2020-10-21 19:50:19 +00:00
Determines where the edge of a navigation mesh is. This way an agent will not overlap with another mesh or stand over nothing.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="cell/height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.2">
Document more NavigationMesh properties
2020-10-21 19:50:19 +00:00
The height of a cell.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="cell/size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.3">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The size of cells in the [NavigationMesh].
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="detail/sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance" default="6.0">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="detail/sample_max_error" type="float" setter="set_detail_sample_max_error" getter="get_detail_sample_max_error" default="1.0">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="edge/max_error" type="float" setter="set_edge_max_error" getter="get_edge_max_error" default="1.3">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="edge/max_length" type="float" setter="set_edge_max_length" getter="get_edge_max_length" default="12.0">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<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">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="filter/ledge_spans" type="bool" setter="set_filter_ledge_spans" getter="get_filter_ledge_spans" default="false">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="filter/low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles" default="false">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="geometry/collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The physics layers used to generate the [NavigationMesh].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="geometry/parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type" default="0">
class reference proofreading
2021-03-18 11:04:28 +00:00
What kind of geometry is used to generate the [NavigationMesh].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</member>
Add option to create navmesh from objects in group Adds a new NavigationMesh property to select which objects will be taken into account for the generation. By default it will use all the NavigationMeshInstance children to keep compatibility. The new modes allow to build the NavigationMesh from all the nodes belonging to a specific group, and optionally include their children too.
2019-10-16 09:33:47 +00:00
<member name="geometry/source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" default="0">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
Which geometry is used to generate the [NavigationMesh].
Add option to create navmesh from objects in group Adds a new NavigationMesh property to select which objects will be taken into account for the generation. By default it will use all the NavigationMeshInstance children to keep compatibility. The new modes allow to build the NavigationMesh from all the nodes belonging to a specific group, and optionally include their children too.
2019-10-16 09:33:47 +00:00
</member>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<member name="geometry/source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The name of the group that is used to generate the [NavigationMesh].
Add option to create navmesh from objects in group Adds a new NavigationMesh property to select which objects will be taken into account for the generation. By default it will use all the NavigationMeshInstance children to keep compatibility. The new modes allow to build the NavigationMesh from all the nodes belonging to a specific group, and optionally include their children too.
2019-10-16 09:33:47 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly" default="6.0">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The number of vertices to use per polygon. Higher values will improve performance at the cost of lower precision.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="region/merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
If two adjacent regions' edges are separated by a distance lower than this value, the regions will be merged together.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="region/min_size" type="float" setter="set_region_min_size" getter="get_region_min_size" default="8.0">
Document some properties of NavigationMesh
2020-09-09 14:21:18 +00:00
The minimum size of a region for it to be created.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="sample_partition_type/sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type" default="0">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SAMPLE_PARTITION_WATERSHED" value="0">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SAMPLE_PARTITION_MONOTONE" value="1">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="SAMPLE_PARTITION_LAYERS" value="2">
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</constant>
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>