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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

206 lines
13 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" ?>
Documentation: Add support for deprecated/experimental messages
2024-02-12 13:55:02 +00:00
<class name="NavigationMesh" inherits="Resource" experimental="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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>
Overhaul the top sections of the class reference (Physics classes)
2023-04-28 20:59:03 +00:00
A navigation mesh that defines traversable areas and obstacles.
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>
<description>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
A navigation mesh is a collection of polygons that define which areas of an environment are traversable to aid agents in pathfinding through complicated spaces.
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>
<tutorials>
Add navigation tutorial links inside class doc Adds navigation tutorial links inside the class doc to the related and more detailed godot-docs pages.
2023-01-11 05:05:04 +00:00
<link title="Using NavigationMeshes">$DOCS_URL/tutorials/navigation/navigation_using_navigationmeshes.html</link>
Update links to outdated asset library demos Update links to outdated asset library demos Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com>
2024-03-25 01:20:59 +00:00
<link title="3D Navigation Demo">https://godotengine.org/asset-library/asset/2743</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
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>
</method>
Add clear() function to NavigationMesh / NavigationPolygon Adds clear() function to NavigationMesh / NavigationPolygon.
2023-07-07 13:59:10 +00:00
<method name="clear">
<return type="void" />
<description>
Clears the internal arrays for vertices and polygon indices.
</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="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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Clears the array of polygons, but it doesn't clear the array of vertices.
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>
</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Initializes the navigation mesh by setting the vertices and indices according to a [Mesh].
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
[b]Note:[/b] The given [param mesh] must be of type [constant Mesh.PRIMITIVE_TRIANGLES] and have an index array.
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>
</method>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-11 23:01:38 +00:00
<method name="get_collision_mask_value" 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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_number" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [param layer_number] between 1 and 32.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon.
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>
</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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Returns the number of polygons in the navigation 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>
</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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Returns a [PackedVector3Array] containing all the vertices being used to create the polygons.
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 07:29:38 +00:00
</description>
</method>
Uniformize layer names, script methods and documentation - Back to 1-based layer names to make it clearer in editor UI - Layer bit accessors are renamed to layer value and 1-based too - Uniform errors and documentation in render and physics - Fix a few remaining collision_layer used in place of collision_mask
2021-08-11 23:01:38 +00:00
<method name="set_collision_mask_value">
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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Based on [param value], enables or disables the specified layer in the [member geometry_collision_mask], given a [param layer_number] between 1 and 32.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</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" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 07:29:38 +00:00
</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>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="agent_height" type="float" setter="set_agent_height" getter="get_agent_height" default="1.5">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The minimum floor to ceiling height that will still allow the floor area to be considered walkable.
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
[b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_height].
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="agent_max_climb" type="float" setter="set_agent_max_climb" getter="get_agent_max_climb" default="0.25">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The minimum ledge height that is considered to still be traversable.
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
[b]Note:[/b] While baking, this value will be rounded down to the nearest multiple of [member cell_height].
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="agent_max_slope" type="float" setter="set_agent_max_slope" getter="get_agent_max_slope" default="45.0">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The maximum slope that is considered walkable, in degrees.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="agent_radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="0.5">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The distance to erode/shrink the walkable area of the heightfield away from obstructions.
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
[b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size].
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Add NavigationMesh border_size property for tile baking Adds NavigationMesh border_size property for tile baking.
2024-01-19 15:33:43 +00:00
<member name="border_size" type="float" setter="set_border_size" getter="get_border_size" default="0.0">
The size of the non-navigable border around the bake bounding area.
In conjunction with the [member filter_baking_aabb] and a [member edge_max_error] value at [code]1.0[/code] or below the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by [member agent_radius].
[b]Note:[/b] While baking and not zero, this value will be rounded up to the nearest multiple of [member cell_size].
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="cell_height" type="float" setter="set_cell_height" getter="get_cell_height" default="0.25">
Fix `cell_height` for navigation meshes Fixes `cell_height` for navigation meshes.
2023-06-13 11:36:05 +00:00
The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.25">
Fix `cell_height` for navigation meshes Fixes `cell_height` for navigation meshes.
2023-06-13 11:36:05 +00:00
The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="detail_sample_distance" type="float" setter="set_detail_sample_distance" getter="get_detail_sample_distance" default="6.0">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The sampling distance to use when generating the detail mesh, in cell unit.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +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">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The maximum distance the detail mesh surface should deviate from heightfield, in cell unit.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="edge_max_error" type="float" setter="set_edge_max_error" getter="get_edge_max_error" default="1.3">
Fix various typos in documentation
2023-07-08 21:41:18 +00:00
The maximum distance a simplified contour's border edges should deviate the original raw contour.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Disable NavigationMesh edge_max_length property by default Disables NavigationMesh edge_max_length property by default.
2023-07-22 11:44:10 +00:00
<member name="edge_max_length" type="float" setter="set_edge_max_length" getter="get_edge_max_length" default="0.0">
The maximum allowed length for contour edges along the border of the mesh. A value of [code]0.0[/code] disables this feature.
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
[b]Note:[/b] While baking, this value will be rounded up to the nearest multiple of [member cell_size].
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Implement NavigationMesh bake area Adds two new properties to NavigationMesh resources to restrict the navmesh baking to an area enclosed by an AABB with volume.
2022-06-23 11:54:41 +00:00
<member name="filter_baking_aabb" type="AABB" setter="set_filter_baking_aabb" getter="get_filter_baking_aabb" default="AABB(0, 0, 0, 0, 0, 0)">
If the baking [AABB] has a volume the navigation mesh baking will be restricted to its enclosing area.
</member>
<member name="filter_baking_aabb_offset" type="Vector3" setter="set_filter_baking_aabb_offset" getter="get_filter_baking_aabb_offset" default="Vector3(0, 0, 0)">
The position offset applied to the [member filter_baking_aabb] [AABB].
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="filter_ledge_spans" type="bool" setter="set_filter_ledge_spans" getter="get_filter_ledge_spans" default="false">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
If [code]true[/code], marks spans that are ledges as non-walkable.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="filter_low_hanging_obstacles" type="bool" setter="set_filter_low_hanging_obstacles" getter="get_filter_low_hanging_obstacles" default="false">
If [code]true[/code], marks non-walkable spans as walkable if their maximum is within [member agent_max_climb] of a walkable neighbor.
</member>
<member name="filter_walkable_low_height_spans" type="bool" setter="set_filter_walkable_low_height_spans" getter="get_filter_walkable_low_height_spans" default="false">
If [code]true[/code], marks walkable spans as not walkable if the clearance above the span is less than [member agent_height].
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="geometry_collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="4294967295">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The physics layers to scan for static colliders.
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</member>
Change NavigationMesh to also parse collision shapes by default Changes NavigationMesh parse geometry types to include collision shapes as well by default.
2024-08-01 11:11:24 +00:00
<member name="geometry_parsed_geometry_type" type="int" setter="set_parsed_geometry_type" getter="get_parsed_geometry_type" enum="NavigationMesh.ParsedGeometryType" default="2">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Determines which type of nodes will be parsed as geometry. See [enum ParsedGeometryType] for possible values.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="geometry_source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationMesh.SourceGeometryMode" default="0">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values.
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>
Fix Navigation API abbreviations inconsistency Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
2022-12-11 17:02:35 +00:00
<member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="&amp;&quot;navigation_mesh_source_group&quot;">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
The name of the group to scan for geometry.
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
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>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="region_merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Any regions with a size smaller than this will be merged with larger regions if possible.
[b]Note:[/b] This value will be squared to calculate the number of cells. For example, a value of 20 will set the number of cells to 400.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="region_min_size" type="float" setter="set_region_min_size" getter="get_region_min_size" default="2.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.
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
[b]Note:[/b] This value will be squared to calculate the minimum number of cells allowed to form isolated island areas. For example, a value of 8 will set the number of cells to 64.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
<member name="sample_partition_type" type="int" setter="set_sample_partition_type" getter="get_sample_partition_type" enum="NavigationMesh.SamplePartitionType" default="0">
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
Partitioning algorithm for creating the navigation mesh polys. See [enum SamplePartitionType] for possible values.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</member>
Fix typo and ensure backwards compatibility for changed property names Changes to the name of the `navmesh` and `navpoly` properties on `NavigationRegion` caused navigation data to be lost on load. This PR creates uses `_set`/`_get` to handle compatibility with the older names on load, preserving the data. Also fixes a typo on `get_vertices_per_polygon` in `NavigationMesh`, and renames the property to remove the `polygon_` prefix which doesn't match the setter/getter. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2022-12-18 04:07:10 +00:00
<member name="vertices_per_polygon" type="float" setter="set_vertices_per_polygon" getter="get_vertices_per_polygon" default="6.0">
The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.
</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>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
<constant name="SAMPLE_PARTITION_WATERSHED" value="0" enum="SamplePartitionType">
Watershed partitioning. Generally the best choice if you precompute the navigation mesh, use this if you have large open areas.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</constant>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
<constant name="SAMPLE_PARTITION_MONOTONE" value="1" enum="SamplePartitionType">
Monotone partitioning. Use this if you want fast navigation mesh generation.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</constant>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
<constant name="SAMPLE_PARTITION_LAYERS" value="2" enum="SamplePartitionType">
Layer partitioning. Good choice to use for tiled navigation mesh with medium and small sized tiles.
doc: Sync classref with current source [ci skip]
2017-09-13 18:56:01 +00:00
</constant>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
<constant name="SAMPLE_PARTITION_MAX" value="3" enum="SamplePartitionType">
Represents the size of the [enum SamplePartitionType] enum.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</constant>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
<constant name="PARSED_GEOMETRY_MESH_INSTANCES" value="0" enum="ParsedGeometryType">
Parses mesh instances as geometry. This includes [MeshInstance3D], [CSGShape3D], and [GridMap] nodes.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</constant>
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
<constant name="PARSED_GEOMETRY_STATIC_COLLIDERS" value="1" enum="ParsedGeometryType">
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
Parses [StaticBody3D] colliders as geometry. The collider should be in any of the layers specified by [member geometry_collision_mask].
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
</constant>
<constant name="PARSED_GEOMETRY_BOTH" value="2" enum="ParsedGeometryType">
Both [constant PARSED_GEOMETRY_MESH_INSTANCES] and [constant PARSED_GEOMETRY_STATIC_COLLIDERS].
</constant>
<constant name="PARSED_GEOMETRY_MAX" value="3" enum="ParsedGeometryType">
Represents the size of the [enum ParsedGeometryType] enum.
</constant>
Fix Navigation API abbreviations inconsistency Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
2022-12-11 17:02:35 +00:00
<constant name="SOURCE_GEOMETRY_ROOT_NODE_CHILDREN" value="0" enum="SourceGeometryMode">
Scans the child nodes of the root node recursively for geometry.
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
</constant>
<constant name="SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN" value="1" enum="SourceGeometryMode">
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member geometry_source_group_name].
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
</constant>
<constant name="SOURCE_GEOMETRY_GROUPS_EXPLICIT" value="2" enum="SourceGeometryMode">
Remove slash delimiter from NavigationMesh properties Remove slash delimiter from NavigationMesh properties.
2022-06-08 14:31:51 +00:00
Uses nodes in a group for geometry. The group is specified by [member geometry_source_group_name].
Improve NavigationMesh typing, parameter validation and documentation
2021-08-11 08:23:14 +00:00
</constant>
<constant name="SOURCE_GEOMETRY_MAX" value="3" enum="SourceGeometryMode">
Represents the size of the [enum SourceGeometryMode] enum.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</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>