mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2025-01-23 09:37:17 +01:00
Fixed up the remaining newly extracted class doc xmls.
This commit is contained in:
parent
3346381a95
commit
fe56b4c6b5
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="Navigation2DServer" inherits="Object" version="3.11">
|
||||
<class name="Navigation2DServer" inherits="Object" version="3.12">
|
||||
<brief_description>
|
||||
Server interface for low-level 2D navigation access.
|
||||
</brief_description>
|
||||
@ -458,6 +458,22 @@
|
||||
Set the map edge connection margin used to weld the compatible region edges.
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_set_link_connection_radius">
|
||||
<return type="void" />
|
||||
<argument index="0" name="map" type="RID" />
|
||||
<argument index="1" name="radius" type="float" />
|
||||
<description>
|
||||
Set the map's link connection radius used to connect links to navigation polygons.
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_set_use_edge_connections">
|
||||
<return type="void" />
|
||||
<argument index="0" name="map" type="RID" />
|
||||
<argument index="1" name="enabled" type="bool" />
|
||||
<description>
|
||||
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
|
||||
</description>
|
||||
</method>
|
||||
<method name="obstacle_create">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
@ -502,30 +518,6 @@
|
||||
Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out.
|
||||
</description>
|
||||
</method>
|
||||
<method name="query_path" qualifiers="const">
|
||||
<return type="void" />
|
||||
<argument index="0" name="parameters" type="NavigationPathQueryParameters2D" />
|
||||
<argument index="1" name="result" type="NavigationPathQueryResult2D" />
|
||||
<description>
|
||||
Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters2D]. Updates the provided [NavigationPathQueryResult2D] result object with the path among other results requested by the query.
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_set_link_connection_radius">
|
||||
<return type="void" />
|
||||
<argument index="0" name="map" type="RID" />
|
||||
<argument index="1" name="radius" type="float" />
|
||||
<description>
|
||||
Set the map's link connection radius used to connect links to navigation polygons.
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_set_use_edge_connections">
|
||||
<return type="void" />
|
||||
<argument index="0" name="map" type="RID" />
|
||||
<argument index="1" name="enabled" type="bool" />
|
||||
<description>
|
||||
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
|
||||
</description>
|
||||
</method>
|
||||
<method name="region_create">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
@ -671,6 +663,12 @@
|
||||
If [param enabled] the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_debug_enabled">
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="map_changed">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationAgent" inherits="Node" version="3.11">
|
||||
<class name="NavigationAgent" inherits="Node" version="3.12">
|
||||
<brief_description>
|
||||
3D agent used in navigation for collision avoidance.
|
||||
</brief_description>
|
||||
@ -30,18 +30,6 @@
|
||||
Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_navigation_result" qualifiers="const">
|
||||
<return type="NavigationPathQueryResult3D" />
|
||||
<description>
|
||||
Returns the path query result for the path the agent is currently following.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_final_position">
|
||||
<return type="Vector3" />
|
||||
<description>
|
||||
Returns the reachable final position of the current navigation path in global coordinates. This position can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_navigation_path" qualifiers="const">
|
||||
<return type="PoolVector3Array" />
|
||||
<description>
|
||||
@ -54,6 +42,18 @@
|
||||
Returns which index the agent is currently on in the navigation path's [PoolVector3Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_navigation_result" qualifiers="const">
|
||||
<return type="NavigationPathQueryResult3D" />
|
||||
<description>
|
||||
Returns the path query result for the path the agent is currently following.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_final_position">
|
||||
<return type="Vector3" />
|
||||
<description>
|
||||
Returns the reachable final position of the current navigation path in global coordinates. This position can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation" qualifiers="const">
|
||||
<return type="Node" />
|
||||
<description>
|
||||
@ -103,13 +103,6 @@
|
||||
Returns [code]true[/code] if [member target_position] is reached. It may not always be possible to reach the target position. It should always be possible to reach the final position though. See [method get_final_position].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation" type="Node" />
|
||||
<description>
|
||||
Sets the [Navigation] node used by the agent. Useful when you don't want to make the agent a child of a [Navigation] node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_avoidance_layer_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
@ -126,6 +119,13 @@
|
||||
Based on [param value], enables or disables the specified mask in the [member avoidance_mask] bitmask, given a [param mask_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation" type="Node" />
|
||||
<description>
|
||||
Sets the [Navigation] node used by the agent. Useful when you don't want to make the agent a child of a [Navigation] node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation_layer_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
@ -186,7 +186,7 @@
|
||||
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
|
||||
A bitfield determining all navigation map layers the [NavigationAgent] belongs to. On path requests the agent will ignore navmeshes without at least one matching layer.
|
||||
</member>
|
||||
<member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="0.0">
|
||||
<member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="1.0">
|
||||
The distance to search for other agents.
|
||||
</member>
|
||||
<member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="1.0">
|
||||
@ -198,7 +198,7 @@
|
||||
<member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="3.0">
|
||||
The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
|
||||
</member>
|
||||
<member name="path_metadata_flags" type="int" setter="set_path_metadata_flags" getter="get_path_metadata_flags" enum="NavigationPathQueryParameters3D.PathMetadataFlags" default="7">
|
||||
<member name="path_metadata_flags" type="int" setter="set_path_metadata_flags" getter="get_path_metadata_flags" default="7">
|
||||
Additional information to return with the navigation path.
|
||||
</member>
|
||||
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationAgent2D" inherits="Node" version="3.11">
|
||||
<class name="NavigationAgent2D" inherits="Node" version="3.12">
|
||||
<brief_description>
|
||||
2D agent used in navigation for collision avoidance.
|
||||
</brief_description>
|
||||
@ -30,18 +30,6 @@
|
||||
Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_navigation_result" qualifiers="const">
|
||||
<return type="NavigationPathQueryResult2D" />
|
||||
<description>
|
||||
Returns the path query result for the path the agent is currently following.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_final_position">
|
||||
<return type="Vector2" />
|
||||
<description>
|
||||
Returns the reachable final position of the current navigation path in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_navigation_path" qualifiers="const">
|
||||
<return type="PoolVector2Array" />
|
||||
<description>
|
||||
@ -54,6 +42,18 @@
|
||||
Returns which index the agent is currently on in the navigation path's [PoolVector2Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_navigation_result" qualifiers="const">
|
||||
<return type="NavigationPathQueryResult2D" />
|
||||
<description>
|
||||
Returns the path query result for the path the agent is currently following.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_final_position">
|
||||
<return type="Vector2" />
|
||||
<description>
|
||||
Returns the reachable final position of the current navigation path in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation" qualifiers="const">
|
||||
<return type="Node" />
|
||||
<description>
|
||||
@ -103,13 +103,6 @@
|
||||
Returns [code]true[/code] if [member target_position] is reached. It may not always be possible to reach the target position. It should always be possible to reach the final position though. See [method get_final_position].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation" type="Node" />
|
||||
<description>
|
||||
Sets the [Navigation2D] node used by the agent. Useful when you don't want to make the agent a child of a [Navigation2D] node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_avoidance_layer_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
@ -126,6 +119,13 @@
|
||||
Based on [param value], enables or disables the specified mask in the [member avoidance_mask] bitmask, given a [param mask_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation" type="Node" />
|
||||
<description>
|
||||
Sets the [Navigation2D] node used by the agent. Useful when you don't want to make the agent a child of a [Navigation2D] node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation_layer_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
@ -177,16 +177,16 @@
|
||||
<member name="debug_use_custom" type="bool" setter="set_debug_use_custom" getter="get_debug_use_custom" default="false">
|
||||
If [code]true[/code] uses the defined [member debug_path_custom_color] for this agent instead of global color.
|
||||
</member>
|
||||
<member name="max_neighbors" type="int" setter="set_max_neighbors" getter="get_max_neighbors" default="0">
|
||||
<member name="max_neighbors" type="int" setter="set_max_neighbors" getter="get_max_neighbors" default="10">
|
||||
The maximum number of neighbors for the agent to consider.
|
||||
</member>
|
||||
<member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="0.0">
|
||||
<member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="200.0">
|
||||
The maximum speed that an agent can move.
|
||||
</member>
|
||||
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
|
||||
A bitfield determining all navigation map layers the [NavigationAgent2D] belongs to. On path requests the agent will ignore navmeshes without at least one matching layer.
|
||||
</member>
|
||||
<member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="0.0">
|
||||
<member name="neighbor_distance" type="float" setter="set_neighbor_distance" getter="get_neighbor_distance" default="500.0">
|
||||
The distance to search for other agents.
|
||||
</member>
|
||||
<member name="path_desired_distance" type="float" setter="set_path_desired_distance" getter="get_path_desired_distance" default="1.0">
|
||||
@ -195,10 +195,10 @@
|
||||
<member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="3.0">
|
||||
The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
|
||||
</member>
|
||||
<member name="path_metadata_flags" type="int" setter="set_path_metadata_flags" getter="get_path_metadata_flags" enum="NavigationPathQueryParameters2D.PathMetadataFlags" default="7">
|
||||
<member name="path_metadata_flags" type="int" setter="set_path_metadata_flags" getter="get_path_metadata_flags" default="7">
|
||||
Additional information to return with the navigation path.
|
||||
</member>
|
||||
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.0">
|
||||
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="10.0">
|
||||
The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]).
|
||||
Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationMesh] resources with a different [member NavigationMesh.agent_radius] property and use different navigation maps for each actor size.
|
||||
</member>
|
||||
@ -211,7 +211,7 @@
|
||||
<member name="time_horizon_agents" type="float" setter="set_time_horizon_agents" getter="get_time_horizon_agents" default="1.0">
|
||||
The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
|
||||
</member>
|
||||
<member name="time_horizon_obstacles" type="float" setter="set_time_horizon_obstacles" getter="get_time_horizon_obstacles" default="0.0">
|
||||
<member name="time_horizon_obstacles" type="float" setter="set_time_horizon_obstacles" getter="get_time_horizon_obstacles" default="1.2871e-33">
|
||||
The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to static avoidance obstacles. The larger the number, the sooner the agent will respond to static avoidance obstacles, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
|
||||
</member>
|
||||
<member name="velocity" type="Vector2" setter="set_velocity" getter="get_velocity" default="Vector2( 0, 0 )">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationGeometryParser2D" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationGeometryParser2D" inherits="Reference" version="3.12">
|
||||
<brief_description>
|
||||
Parser to contribute a node's geometry data for [NavigationPolygon] baking.
|
||||
</brief_description>
|
||||
@ -9,7 +9,7 @@
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_parse_geometry" qualifiers="virtual const">
|
||||
<method name="_parse_geometry" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<argument index="1" name="navigation_polygon" type="NavigationPolygon" />
|
||||
@ -18,7 +18,7 @@
|
||||
Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationPolygon] baking. Custom 2D geometry can be added to the [param source_geometry].
|
||||
</description>
|
||||
</method>
|
||||
<method name="_parses_node" qualifiers="virtual const">
|
||||
<method name="_parses_node" qualifiers="virtual">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<description>
|
||||
@ -26,4 +26,6 @@
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationGeometryParser3D" inherits="RefCounted" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationGeometryParser3D" inherits="Reference" version="3.12">
|
||||
<brief_description>
|
||||
Parser to contribute a node's geometry data for [NavigationMesh] baking.
|
||||
</brief_description>
|
||||
@ -9,7 +9,7 @@
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_parse_geometry" qualifiers="virtual const">
|
||||
<method name="_parse_geometry" qualifiers="virtual">
|
||||
<return type="void" />
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<argument index="1" name="navigation_mesh" type="NavigationMesh" />
|
||||
@ -18,7 +18,7 @@
|
||||
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 const">
|
||||
<method name="_parses_node" qualifiers="virtual">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<description>
|
||||
@ -26,4 +26,6 @@
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationLink2D" inherits="Node2D" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationLink2D" inherits="Node2D" version="3.12">
|
||||
<brief_description>
|
||||
A link between two positions on [NavigationRegion2D]s that agents can be routed through.
|
||||
</brief_description>
|
||||
@ -79,4 +79,6 @@
|
||||
When pathfinding moves along the link the traveled distance is multiplied with [member travel_cost] for determining the shortest path.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationLink3D" inherits="Spatial" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationLink3D" inherits="Spatial" version="3.12">
|
||||
<brief_description>
|
||||
A link between two positions on [NavigationRegion3D]s that agents can be routed through.
|
||||
</brief_description>
|
||||
@ -79,4 +79,6 @@
|
||||
When pathfinding moves along the link the traveled distance is multiplied with [member travel_cost] for determining the shortest path.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationMesh" inherits="Resource" version="3.11">
|
||||
<class name="NavigationMesh" inherits="Resource" version="3.12">
|
||||
<brief_description>
|
||||
A mesh that defines the areas traversable by navigation agents that are safe from obstructions.
|
||||
</brief_description>
|
||||
@ -24,31 +24,18 @@
|
||||
Clears both the internal polygons and vertices arrays.
|
||||
</description>
|
||||
</method>
|
||||
<method name="commit_changes">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Applies all changes to vertices and polygons and synchronizes with the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_polygons" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns the array of polygons used by the internal navigation mesh. Each polygon array consists of the indices for the vertices that make the polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_polygons">
|
||||
<return type="void" />
|
||||
<argument index="0" name="polygons" type="Array" />
|
||||
<description>
|
||||
Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_polygons">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Clears the array of polygons, but it doesn't clear the array of vertices.
|
||||
</description>
|
||||
</method>
|
||||
<method name="commit_changes">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Applies all changes to vertices and polygons and synchronizes with the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_from_mesh">
|
||||
<return type="void" />
|
||||
<argument index="0" name="mesh" type="Mesh" />
|
||||
@ -199,8 +186,7 @@
|
||||
<constant name="PARSED_GEOMETRY_MAX" value="3" enum="ParsedGeometryType">
|
||||
Represents the size of the [enum ParsedGeometryType] enum.
|
||||
</constant>
|
||||
<constant name="SOURCE_GEOMETRY_NAVMESH_CHILDREN" value="0" enum="SourceGeometryMode">
|
||||
Scans the child nodes of [NavigationMeshInstance] recursively for geometry.
|
||||
<constant name="SOURCE_GEOMETRY_ROOT_NODE_CHILDREN" value="0" enum="SourceGeometryMode">
|
||||
</constant>
|
||||
<constant name="SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN" value="1" enum="SourceGeometryMode">
|
||||
Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member geometry_source_group_name].
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationMeshGenerator" inherits="Object" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationMeshGenerator" inherits="Object" version="3.12">
|
||||
<brief_description>
|
||||
Server for navigation mesh baking and source geometry parsing.
|
||||
</brief_description>
|
||||
@ -16,7 +16,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation_polygon" type="NavigationPolygon" />
|
||||
<argument index="1" name="source_geometry_data" type="NavigationMeshSourceGeometryData2D" />
|
||||
<argument index="2" name="callback" type="Callable" />
|
||||
<argument index="2" name="callback" type="FuncRef" default="null" />
|
||||
<description>
|
||||
Bakes the provided [param navigation_polygon] with the data from the provided [param source_geometry_data]. After the process is finished the optional [param callback] will be called.
|
||||
</description>
|
||||
@ -25,7 +25,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation_mesh" type="NavigationMesh" />
|
||||
<argument index="1" name="source_geometry_data" type="NavigationMeshSourceGeometryData3D" />
|
||||
<argument index="2" name="callback" type="Callable" />
|
||||
<argument index="2" name="callback" type="FuncRef" default="null" />
|
||||
<description>
|
||||
Bakes the provided [param navigation_mesh] with the data from the provided [param source_geometry_data]. After the process is finished the optional [param callback] will be called.
|
||||
</description>
|
||||
@ -48,7 +48,7 @@
|
||||
<return type="NavigationMeshSourceGeometryData2D" />
|
||||
<argument index="0" name="navigation_polygon" type="NavigationPolygon" />
|
||||
<argument index="1" name="root_node" type="Node" />
|
||||
<argument index="2" name="callback" type="Callable" />
|
||||
<argument index="2" name="callback" type="FuncRef" default="null" />
|
||||
<description>
|
||||
Parses the [SceneTree] (not thread-safe) for source geometry according to the properties of [param navigation_polygon] and returns a [NavigationMeshSourceGeometryData2D] that can be used to bake a navigation mesh. After the process is finished the optional [param callback] will be called.
|
||||
</description>
|
||||
@ -57,7 +57,7 @@
|
||||
<return type="NavigationMeshSourceGeometryData3D" />
|
||||
<argument index="0" name="navigation_mesh" type="NavigationMesh" />
|
||||
<argument index="1" name="root_node" type="Node" />
|
||||
<argument index="2" name="callback" type="Callable" />
|
||||
<argument index="2" name="callback" type="FuncRef" default="null" />
|
||||
<description>
|
||||
Parses the [SceneTree] (not thread-safe) for source geometry according to the properties of [param navigation_mesh] and returns a [NavigationMeshSourceGeometryData2D] that can be used to bake a navigation mesh. After the process is finished the optional [param callback] will be called.
|
||||
</description>
|
||||
@ -66,7 +66,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation_polygon" type="NavigationPolygon" />
|
||||
<argument index="1" name="root_node" type="Node" />
|
||||
<argument index="2" name="callback" type="Callable" />
|
||||
<argument index="2" name="callback" type="FuncRef" default="null" />
|
||||
<description>
|
||||
Uses both [method parse_2d_source_geometry_data] and [method bake_2d_from_source_geometry_data] in sequence. After the process is finished the optional [param callback] will be called.
|
||||
</description>
|
||||
@ -75,7 +75,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation_mesh" type="NavigationMesh" />
|
||||
<argument index="1" name="root_node" type="Node" />
|
||||
<argument index="2" name="callback" type="Callable" />
|
||||
<argument index="2" name="callback" type="FuncRef" default="null" />
|
||||
<description>
|
||||
Uses both [method parse_3d_source_geometry_data] and [method bake_3d_from_source_geometry_data] in sequence. After the process is finished the optional [param callback] will be called.
|
||||
</description>
|
||||
@ -109,4 +109,6 @@
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationMeshSourceGeometryData2D" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationMeshSourceGeometryData2D" inherits="Resource" version="3.12">
|
||||
<brief_description>
|
||||
Contains parsed source geometry data for use in [NavigationPolygon] baking with the [NavigationMeshGenerator].
|
||||
</brief_description>
|
||||
@ -62,4 +62,6 @@
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationMeshSourceGeometryData3D" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationMeshSourceGeometryData3D" inherits="Resource" version="3.12">
|
||||
<brief_description>
|
||||
Contains parsed source geometry data for use in [NavigationMesh] baking with the [NavigationMeshGenerator].
|
||||
</brief_description>
|
||||
@ -12,7 +12,7 @@
|
||||
<method name="add_faces">
|
||||
<return type="void" />
|
||||
<argument index="0" name="faces" type="PoolVector3Array" />
|
||||
<argument index="1" name="xform" type="Transform3D" />
|
||||
<argument index="1" name="xform" type="Transform" />
|
||||
<description>
|
||||
Adds an array of vertex positions to the geometry data for navigation mesh baking to form triangulated faces. For each face the array must have three vertex positions in clockwise winding order. Since [NavigationMesh] resource have no transform all vertex positions need to be offset by the node's transform using the [code]xform[/code] parameter.
|
||||
</description>
|
||||
@ -20,7 +20,7 @@
|
||||
<method name="add_mesh">
|
||||
<return type="void" />
|
||||
<argument index="0" name="mesh" type="Mesh" />
|
||||
<argument index="1" name="xform" type="Transform3D" />
|
||||
<argument index="1" name="xform" type="Transform" />
|
||||
<description>
|
||||
Adds the geometry data of a [Mesh] resource to the navigation mesh baking data. The mesh must have valid triangulated mesh data to be considered. Since [NavigationMesh] resource have no transform all vertex positions need to be offset by the node's transform using the [code]xform[/code] parameter.
|
||||
</description>
|
||||
@ -28,7 +28,7 @@
|
||||
<method name="add_mesh_array">
|
||||
<return type="void" />
|
||||
<argument index="0" name="mesh_array" type="Array" />
|
||||
<argument index="1" name="xform" type="Transform3D" />
|
||||
<argument index="1" name="xform" type="Transform" />
|
||||
<description>
|
||||
Adds an [Array] the size of [constant Mesh.ARRAY_MAX] and with vertices at index [constant Mesh.ARRAY_VERTEX] and indices at index [constant Mesh.ARRAY_INDEX] to the navigation mesh baking data. The array must have valid triangulated mesh data to be considered. Since [NavigationMesh] resource have no transform all vertex positions need to be offset by the node's transform using the [code]xform[/code] parameter.
|
||||
</description>
|
||||
@ -74,4 +74,6 @@
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationObstacle" inherits="Spatial" version="3.11">
|
||||
<class name="NavigationObstacle" inherits="Spatial" version="3.12">
|
||||
<brief_description>
|
||||
3D Obstacle used in navigation to constrain avoidance controlled agents outside or inside an area.
|
||||
</brief_description>
|
||||
@ -25,18 +25,18 @@
|
||||
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation_map" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the [RID] of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation" qualifiers="const">
|
||||
<return type="Node" />
|
||||
<description>
|
||||
Returns the [Navigation] node that the obstacle is using for its navigation system.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation_map" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the [RID] of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_obstacle_rid" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationObstacle2D" inherits="Node2D" version="3.11">
|
||||
<class name="NavigationObstacle2D" inherits="Node2D" version="3.12">
|
||||
<brief_description>
|
||||
2D Obstacle used in navigation to constrain avoidance controlled agents outside or inside an area.
|
||||
</brief_description>
|
||||
@ -25,12 +25,6 @@
|
||||
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation_map" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the [RID] of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation" qualifiers="const">
|
||||
<return type="Node" />
|
||||
<description>
|
||||
@ -58,13 +52,6 @@
|
||||
Sets the [Navigation2D] node used by the obstacle. Useful when you don't want to make the obstacle a child of a [Navigation2D] node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_navigation_map">
|
||||
<return type="void" />
|
||||
<argument index="0" name="navigation_map" type="RID" />
|
||||
<description>
|
||||
Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="avoidance_layers" type="int" setter="set_avoidance_layers" getter="get_avoidance_layers" default="1">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationPathQueryParameters2D" inherits="Reference" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationPathQueryParameters2D" inherits="Reference" version="3.12">
|
||||
<brief_description>
|
||||
Provides parameters for 2D navigation path queries.
|
||||
</brief_description>
|
||||
@ -9,14 +9,13 @@
|
||||
<tutorials>
|
||||
<link title="Using NavigationPathQueryObjects">$DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html</link>
|
||||
</tutorials>
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="map" type="RID" setter="set_map" getter="get_map">
|
||||
The navigation [code]map[/code] [RID] used in the path query.
|
||||
</member>
|
||||
<member name="metadata_flags" type="int" setter="set_metadata_flags" getter="get_metadata_flags" enum="NavigationPathQueryParameters2D.PathMetadataFlags" default="7">
|
||||
Additional information to include with the navigation path.
|
||||
</member>
|
||||
<member name="metadata_flags" type="int" setter="set_metadata_flags" getter="get_metadata_flags" enum="NavigationPathQueryParameters2D.PathMetadataFlags" default="7">
|
||||
<member name="metadata_flags" type="int" setter="set_metadata_flags" getter="get_metadata_flags" default="7">
|
||||
Additional information to include with the navigation path.
|
||||
</member>
|
||||
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
|
||||
@ -45,34 +44,19 @@
|
||||
<constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing">
|
||||
Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_NONE" value="0" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_NONE" value="0" enum="PathMetadataFlags">
|
||||
Don't include any additional metadata about the returned path.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_TYPES" value="1" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_TYPES" value="1" enum="PathMetadataFlags">
|
||||
Include the type of navigation primitive (region or link) that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_RIDS" value="2" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_RIDS" value="2" enum="PathMetadataFlags">
|
||||
Include the [RID]s of the regions and links that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_OWNERS" value="4" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_OWNERS" value="4" enum="PathMetadataFlags">
|
||||
Include the [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_ALL" value="7" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include all available metadata about the returned path.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_NONE" value="0" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Don't include any additional metadata about the returned path.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_TYPES" value="1" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include the type of navigation primitive (region or link) that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_RIDS" value="2" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include the [RID]s of the regions and links that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_OWNERS" value="4" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include the [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_ALL" value="7" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_ALL" value="7" enum="PathMetadataFlags">
|
||||
Include all available metadata about the returned path.
|
||||
</constant>
|
||||
</constants>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationPathQueryParameters3D" inherits="Reference" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationPathQueryParameters3D" inherits="Reference" version="3.12">
|
||||
<brief_description>
|
||||
Provides parameters for 3D navigation path queries.
|
||||
</brief_description>
|
||||
@ -9,11 +9,13 @@
|
||||
<tutorials>
|
||||
<link title="Using NavigationPathQueryObjects">$DOCS_URL/tutorials/navigation/navigation_using_navigationpathqueryobjects.html</link>
|
||||
</tutorials>
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="map" type="RID" setter="set_map" getter="get_map">
|
||||
The navigation [code]map[/code] [RID] used in the path query.
|
||||
</member>
|
||||
<member name="metadata_flags" type="int" setter="set_metadata_flags" getter="get_metadata_flags" enum="NavigationPathQueryParameters3D.PathMetadataFlags" default="7">
|
||||
<member name="metadata_flags" type="int" setter="set_metadata_flags" getter="get_metadata_flags" default="7">
|
||||
Additional information to include with the navigation path.
|
||||
</member>
|
||||
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
|
||||
@ -42,34 +44,19 @@
|
||||
<constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing">
|
||||
Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_NONE" value="0" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_NONE" value="0" enum="PathMetadataFlags">
|
||||
Don't include any additional metadata about the returned path.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_TYPES" value="1" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_TYPES" value="1" enum="PathMetadataFlags">
|
||||
Include the type of navigation primitive (region or link) that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_RIDS" value="2" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_RIDS" value="2" enum="PathMetadataFlags">
|
||||
Include the [RID]s of the regions and links that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_OWNERS" value="4" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_OWNERS" value="4" enum="PathMetadataFlags">
|
||||
Include the [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_ALL" value="7" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include all available metadata about the returned path.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_NONE" value="0" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Don't include any additional metadata about the returned path.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_TYPES" value="1" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include the type of navigation primitive (region or link) that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_RIDS" value="2" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include the [RID]s of the regions and links that each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_OWNERS" value="4" enum="PathMetadataFlags" is_bitfield="true">
|
||||
Include the [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
|
||||
</constant>
|
||||
<constant name="PATH_METADATA_INCLUDE_ALL" value="7" enum="PathMetadataFlags" is_bitfield="true">
|
||||
<constant name="PATH_METADATA_INCLUDE_ALL" value="7" enum="PathMetadataFlags">
|
||||
Include all available metadata about the returned path.
|
||||
</constant>
|
||||
</constants>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationPathQueryResult2D" inherits="Reference" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationPathQueryResult2D" inherits="Reference" version="3.12">
|
||||
<brief_description>
|
||||
Represents the result of a 2D pathfinding query.
|
||||
</brief_description>
|
||||
@ -21,7 +21,7 @@
|
||||
<member name="path" type="PoolVector2Array" setter="set_path" getter="get_path" default="PoolVector2Array( )">
|
||||
The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer2D.map_get_path].
|
||||
</member>
|
||||
<member name="path_owner_ids" type="PoolIntArray" setter="set_path_owner_ids" getter="get_path_owner_ids" default="PoolIntArray()">
|
||||
<member name="path_owner_ids" type="Array" setter="set_path_owner_ids" getter="get_path_owner_ids" default="[ ]">
|
||||
The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
|
||||
</member>
|
||||
<member name="path_rids" type="Array" setter="set_path_rids" getter="get_path_rids" default="[ ]">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationPathQueryResult3D" inherits="Reference" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<class name="NavigationPathQueryResult3D" inherits="Reference" version="3.12">
|
||||
<brief_description>
|
||||
Represents the result of a 3D pathfinding query.
|
||||
</brief_description>
|
||||
@ -21,7 +21,7 @@
|
||||
<member name="path" type="PoolVector3Array" setter="set_path" getter="get_path" default="PoolVector3Array( )">
|
||||
The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer3D.map_get_path].
|
||||
</member>
|
||||
<member name="path_owner_ids" type="PoolIntArray" setter="set_path_owner_ids" getter="get_path_owner_ids" default="PoolIntArray()">
|
||||
<member name="path_owner_ids" type="Array" setter="set_path_owner_ids" getter="get_path_owner_ids" default="[ ]">
|
||||
The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
|
||||
</member>
|
||||
<member name="path_rids" type="Array" setter="set_path_rids" getter="get_path_rids" default="[ ]">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationPolygon" inherits="Resource" version="3.11">
|
||||
<class name="NavigationPolygon" inherits="Resource" version="3.12">
|
||||
<brief_description>
|
||||
A NavigationPolygon is used in pathfinding to describe the traversable area that is safe from collision and other obstructions, assuming an agent's center position at zero radius.
|
||||
</brief_description>
|
||||
@ -64,10 +64,28 @@
|
||||
Clears the array of polygons, but it doesn't clear the array of outlines and vertices.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_mesh">
|
||||
<method name="commit_changes">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Applies all changes to vertices and polygons and synchronizes with the [NavigationServer2D].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_baked_outlines" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns the array of baked outlines. The baked outlines are the result of a finished [NavigationMeshGenerator] baking process and primarily used for debugging purposes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_mask_value" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
<description>
|
||||
Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [param layer_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation_mesh">
|
||||
<return type="NavigationMesh" />
|
||||
<description>
|
||||
Returns the [NavigationMesh] resulting from this navigation polygon. This navmesh can be used to update the navmesh of a region with the [method NavigationServer.region_set_navmesh] API directly (as 2D uses the 3D server behind the scene).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_outline" qualifiers="const">
|
||||
@ -83,6 +101,11 @@
|
||||
Returns the number of outlines that were created in the editor or by script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_outlines" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_polygon">
|
||||
<return type="PoolIntArray" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
@ -102,27 +125,6 @@
|
||||
Returns the array of polygons used by the internal navigation mesh. Each polygon array consists of the indices for the vertices that make the polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_baked_outlines">
|
||||
<return type="void" />
|
||||
<argument index="0" name="baked_outlines" type="Array" />
|
||||
<description>
|
||||
Sets the array of baked outlines. The baked outlines are the result of a finished [NavigationMeshGenerator] baking process and primarily used for debugging purposes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_outlines">
|
||||
<return type="void" />
|
||||
<argument index="0" name="outlines" type="Array" />
|
||||
<description>
|
||||
Sets the outline arrays. The outlines need to be baked to actual navigation mesh polygons by using the [NavigationMeshGenerator].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_polygons">
|
||||
<return type="void" />
|
||||
<argument index="0" name="polygons" type="Array" />
|
||||
<description>
|
||||
Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_vertices" qualifiers="const">
|
||||
<return type="PoolVector2Array" />
|
||||
<description>
|
||||
@ -142,6 +144,20 @@
|
||||
Removes an outline created in the editor or by script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_baked_outlines">
|
||||
<return type="void" />
|
||||
<argument index="0" name="outlines" type="Array" />
|
||||
<description>
|
||||
Sets the array of baked outlines. The baked outlines are the result of a finished [NavigationMeshGenerator] baking process and primarily used for debugging purposes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_mask_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_outline">
|
||||
<return type="void" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
@ -150,6 +166,20 @@
|
||||
Changes an outline created in the editor or by script.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_outlines">
|
||||
<return type="void" />
|
||||
<argument index="0" name="outlines" type="Array" />
|
||||
<description>
|
||||
Sets the outline arrays. The outlines need to be baked to actual navigation mesh polygons by using the [NavigationMeshGenerator].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_polygons">
|
||||
<return type="void" />
|
||||
<argument index="0" name="polygons" type="Array" />
|
||||
<description>
|
||||
Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_vertices">
|
||||
<return type="void" />
|
||||
<argument index="0" name="vertices" type="PoolVector2Array" />
|
||||
@ -157,25 +187,6 @@
|
||||
Sets the vertices that need to be indexed with the [method add_polygon] or [method set_polygons] methods. When finished changing the navigation polygon call [method commit_changes] in order to synchronize the changes with the [Navigation2DServer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="commit_changes">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Applies all changes to vertices and polygons and synchronizes with the [NavigationServer2D].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_baked_outlines" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns the array of baked outlines. The baked outlines are the result of a finished [NavigationMeshGenerator] baking process and primarily used for debugging purposes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_mask_value" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
<description>
|
||||
Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [param layer_number] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="agent_radius" type="float" setter="set_agent_radius" getter="get_agent_radius" default="10.0">
|
||||
@ -190,7 +201,7 @@
|
||||
<member name="geometry_source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationPolygon.SourceGeometryMode" default="0">
|
||||
The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values.
|
||||
</member>
|
||||
<member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="&"navigation_polygon_source_group"">
|
||||
<member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="@"navigation_polygon_source_group"">
|
||||
The name of the group to scan for geometry. Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
|
||||
</member>
|
||||
<member name="offsetting_jointype" type="int" setter="set_offsetting_jointype" getter="get_offsetting_jointype" enum="NavigationPolygon.OffsettingJoinType" default="2">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationPolygonInstance" inherits="Node2D" version="3.11">
|
||||
<class name="NavigationPolygonInstance" inherits="Node2D" version="3.12">
|
||||
<brief_description>
|
||||
A region of the 2D navigation map.
|
||||
</brief_description>
|
||||
@ -15,6 +15,13 @@
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="bake_navigation_polygon">
|
||||
<return type="void" />
|
||||
<argument index="0" name="on_thread" type="bool" />
|
||||
<description>
|
||||
Bakes the [NavigationPolygon]. If [param on_thread] is set to [code]true[/code] (default), the baking is done on a separate thread.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_avoidance_layer_value" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
@ -29,25 +36,18 @@
|
||||
Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_region_rid" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the [RID] of this region on the [Navigation2DServer]. Combined with [method Navigation2DServer.map_get_closest_point_owner] can be used to identify the [NavigationPolygonInstance] closest to a point on the merged navigation map.
|
||||
</description>
|
||||
</method>
|
||||
<method name="bake_navigation_polygon">
|
||||
<return type="void" />
|
||||
<argument index="0" name="on_thread" type="bool" default="true" />
|
||||
<description>
|
||||
Bakes the [NavigationPolygon]. If [param on_thread] is set to [code]true[/code] (default), the baking is done on a separate thread.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_navigation_map" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the current navigation map [RID] use by this region.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_region_rid" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
Returns the [RID] of this region on the [Navigation2DServer]. Combined with [method Navigation2DServer.map_get_closest_point_owner] can be used to identify the [NavigationPolygonInstance] closest to a point on the merged navigation map.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_avoidance_layer_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="layer_number" type="int" />
|
||||
@ -99,8 +99,6 @@
|
||||
If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
</constants>
|
||||
<signals>
|
||||
<signal name="bake_finished">
|
||||
<description>
|
||||
@ -113,4 +111,6 @@
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NavigationServer" inherits="Object" version="3.11">
|
||||
<class name="NavigationServer" inherits="Object" version="3.12">
|
||||
<brief_description>
|
||||
Server interface for low-level 3D navigation access.
|
||||
</brief_description>
|
||||
@ -200,11 +200,9 @@
|
||||
Destroys the given RID.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_debug_enabled">
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<method name="get_debug_enabled" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
If [code]true[/code] enables debug mode on the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_maps" qualifiers="const">
|
||||
@ -215,7 +213,7 @@
|
||||
</method>
|
||||
<method name="get_process_info" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="process_info" type="int" enum="NavigationServer3D.ProcessInfo" />
|
||||
<argument index="0" name="process_info" type="int" enum="NavigationServer.ProcessInfo" />
|
||||
<description>
|
||||
Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states.
|
||||
</description>
|
||||
@ -532,6 +530,14 @@
|
||||
Sets the map up direction.
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_set_use_edge_connections">
|
||||
<return type="void" />
|
||||
<argument index="0" name="map" type="RID" />
|
||||
<argument index="1" name="enabled" type="bool" />
|
||||
<description>
|
||||
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
|
||||
</description>
|
||||
</method>
|
||||
<method name="obstacle_create">
|
||||
<return type="RID" />
|
||||
<description>
|
||||
@ -585,14 +591,6 @@
|
||||
Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out.
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_set_use_edge_connections">
|
||||
<return type="void" />
|
||||
<argument index="0" name="map" type="RID" />
|
||||
<argument index="1" name="enabled" type="bool" />
|
||||
<description>
|
||||
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
|
||||
</description>
|
||||
</method>
|
||||
<method name="process">
|
||||
<return type="void" />
|
||||
<argument index="0" name="delta_time" type="float" />
|
||||
@ -762,6 +760,13 @@
|
||||
Control activation of this server.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_debug_enabled">
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<description>
|
||||
If [code]true[/code] enables debug mode on the NavigationServer.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="avoidance_debug_changed">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user