Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-04-13 23:30:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix godot4 syntax in docs.

Browse Source
This commit is contained in:
Relintai 2023-06-10 21:10:45 +02:00
parent f058c87868
commit a0e5645d18
19 changed files with 242 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

124
doc/classes/Navigation2DServer.xml
View File

@ -25,7 +25,7 @@
</method> </method>
<method name="agent_get_avoidance_enabled" qualifiers="const"> <method name="agent_get_avoidance_enabled" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<description> <description>
Return [code]true[/code] if the specified [param agent] uses avoidance. Return [code]true[/code] if the specified [param agent] uses avoidance.
</description> </description>
@ -57,32 +57,32 @@
</method> </method>
<method name="agent_set_avoidance_enabled"> <method name="agent_set_avoidance_enabled">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <description>
If [param enabled] is [code]true[/code] the specified [param agent] uses avoidance. If [param enabled] is [code]true[/code] the specified [param agent] uses avoidance.
</description> </description>
</method> </method>
<method name="agent_set_avoidance_layers"> <method name="agent_set_avoidance_layers">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="layers" type="int" /> <argument index="1" name="layers" type="int" />
<description> <description>
Set the agent's [code]avoidance_layers[/code] bitmask. Set the agent's [code]avoidance_layers[/code] bitmask.
</description> </description>
</method> </method>
<method name="agent_set_avoidance_mask"> <method name="agent_set_avoidance_mask">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="mask" type="int" /> <argument index="1" name="mask" type="int" />
<description> <description>
Set the agent's [code]avoidance_mask[/code] bitmask. Set the agent's [code]avoidance_mask[/code] bitmask.
</description> </description>
</method> </method>
<method name="agent_set_avoidance_priority"> <method name="agent_set_avoidance_priority">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="priority" type="float" /> <argument index="1" name="priority" type="float" />
<description> <description>
Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority).
The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.
@ -162,8 +162,8 @@
</method> </method>
<method name="agent_set_velocity_forced"> <method name="agent_set_velocity_forced">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="velocity" type="Vector2" /> <argument index="1" name="velocity" type="Vector2" />
<description> <description>
Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position far away this function should be used in the same frame. If called frequently this function can get agents stuck. Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position far away this function should be used in the same frame. If called frequently this function can get agents stuck.
</description> </description>
@ -195,120 +195,120 @@
</method> </method>
<method name="link_get_end_position" qualifiers="const"> <method name="link_get_end_position" qualifiers="const">
<return type="Vector2" /> <return type="Vector2" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the ending position of this [code]link[/code]. Returns the ending position of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_enter_cost" qualifiers="const"> <method name="link_get_enter_cost" qualifiers="const">
<return type="float" /> <return type="float" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the [code]enter_cost[/code] of this [code]link[/code]. Returns the [code]enter_cost[/code] of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_map" qualifiers="const"> <method name="link_get_map" qualifiers="const">
<return type="RID" /> <return type="RID" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to. Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to.
</description> </description>
</method> </method>
<method name="link_get_navigation_layers" qualifiers="const"> <method name="link_get_navigation_layers" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the navigation layers for this [code]link[/code]. Returns the navigation layers for this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_owner_id" qualifiers="const"> <method name="link_get_owner_id" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the [code]ObjectID[/code] of the object which manages this link. Returns the [code]ObjectID[/code] of the object which manages this link.
</description> </description>
</method> </method>
<method name="link_get_start_position" qualifiers="const"> <method name="link_get_start_position" qualifiers="const">
<return type="Vector2" /> <return type="Vector2" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the starting position of this [code]link[/code]. Returns the starting position of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_travel_cost" qualifiers="const"> <method name="link_get_travel_cost" qualifiers="const">
<return type="float" /> <return type="float" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the [code]travel_cost[/code] of this [code]link[/code]. Returns the [code]travel_cost[/code] of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_is_bidirectional" qualifiers="const"> <method name="link_is_bidirectional" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns whether this [code]link[/code] can be travelled in both directions. Returns whether this [code]link[/code] can be travelled in both directions.
</description> </description>
</method> </method>
<method name="link_set_bidirectional"> <method name="link_set_bidirectional">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="bidirectional" type="bool" /> <argument index="1" name="bidirectional" type="bool" />
<description> <description>
Sets whether this [code]link[/code] can be travelled in both directions. Sets whether this [code]link[/code] can be travelled in both directions.
</description> </description>
</method> </method>
<method name="link_set_end_position"> <method name="link_set_end_position">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="position" type="Vector2" /> <argument index="1" name="position" type="Vector2" />
<description> <description>
Sets the exit position for the [code]link[/code]. Sets the exit position for the [code]link[/code].
</description> </description>
</method> </method>
<method name="link_set_enter_cost"> <method name="link_set_enter_cost">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="enter_cost" type="float" /> <argument index="1" name="enter_cost" type="float" />
<description> <description>
Sets the [code]enter_cost[/code] for this [code]link[/code]. Sets the [code]enter_cost[/code] for this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_set_map"> <method name="link_set_map">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="map" type="RID" /> <argument index="1" name="map" type="RID" />
<description> <description>
Sets the navigation map [RID] for the link. Sets the navigation map [RID] for the link.
</description> </description>
</method> </method>
<method name="link_set_navigation_layers"> <method name="link_set_navigation_layers">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="navigation_layers" type="int" /> <argument index="1" name="navigation_layers" type="int" />
<description> <description>
Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer2D.map_get_path]). Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer2D.map_get_path]).
</description> </description>
</method> </method>
<method name="link_set_owner_id"> <method name="link_set_owner_id">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="owner_id" type="int" /> <argument index="1" name="owner_id" type="int" />
<description> <description>
Set the [code]ObjectID[/code] of the object which manages this link. Set the [code]ObjectID[/code] of the object which manages this link.
</description> </description>
</method> </method>
<method name="link_set_start_position"> <method name="link_set_start_position">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="position" type="Vector2" /> <argument index="1" name="position" type="Vector2" />
<description> <description>
Sets the entry position for this [code]link[/code]. Sets the entry position for this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_set_travel_cost"> <method name="link_set_travel_cost">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="travel_cost" type="float" /> <argument index="1" name="travel_cost" type="float" />
<description> <description>
Sets the [code]travel_cost[/code] for this [code]link[/code]. Sets the [code]travel_cost[/code] for this [code]link[/code].
</description> </description>
@ -375,21 +375,21 @@
</method> </method>
<method name="map_get_link_connection_radius" qualifiers="const"> <method name="map_get_link_connection_radius" qualifiers="const">
<return type="float" /> <return type="float" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to.
</description> </description>
</method> </method>
<method name="map_get_links" qualifiers="const"> <method name="map_get_links" qualifiers="const">
<return type="RID[]" /> <return type="Array" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code]. Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description> </description>
</method> </method>
<method name="map_get_obstacles" qualifiers="const"> <method name="map_get_obstacles" qualifiers="const">
<return type="RID[]" /> <return type="Array" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code]. Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description> </description>
@ -414,7 +414,7 @@
</method> </method>
<method name="map_get_use_edge_connections" qualifiers="const"> <method name="map_get_use_edge_connections" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns whether the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Returns whether the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description> </description>
@ -466,62 +466,62 @@
</method> </method>
<method name="obstacle_get_map" qualifiers="const"> <method name="obstacle_get_map" qualifiers="const">
<return type="RID" /> <return type="RID" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<description> <description>
Returns the navigation map [RID] the requested [param obstacle] is currently assigned to. Returns the navigation map [RID] the requested [param obstacle] is currently assigned to.
</description> </description>
</method> </method>
<method name="obstacle_set_avoidance_layers"> <method name="obstacle_set_avoidance_layers">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="layers" type="int" /> <argument index="1" name="layers" type="int" />
<description> <description>
</description> </description>
</method> </method>
<method name="obstacle_set_map"> <method name="obstacle_set_map">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="map" type="RID" /> <argument index="1" name="map" type="RID" />
<description> <description>
Sets the navigation map [RID] for the obstacle. Sets the navigation map [RID] for the obstacle.
</description> </description>
</method> </method>
<method name="obstacle_set_position"> <method name="obstacle_set_position">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="position" type="Vector2" /> <argument index="1" name="position" type="Vector2" />
<description> <description>
Sets the position of the obstacle in world space. Sets the position of the obstacle in world space.
</description> </description>
</method> </method>
<method name="obstacle_set_vertices"> <method name="obstacle_set_vertices">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="vertices" type="PackedVector2Array" /> <argument index="1" name="vertices" type="PoolVector2Array" />
<description> <description>
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. 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> </description>
</method> </method>
<method name="query_path" qualifiers="const"> <method name="query_path" qualifiers="const">
<return type="void" /> <return type="void" />
<param index="0" name="parameters" type="NavigationPathQueryParameters2D" /> <argument index="0" name="parameters" type="NavigationPathQueryParameters2D" />
<param index="1" name="result" type="NavigationPathQueryResult2D" /> <argument index="1" name="result" type="NavigationPathQueryResult2D" />
<description> <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. 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> </description>
</method> </method>
<method name="map_set_link_connection_radius"> <method name="map_set_link_connection_radius">
<return type="void" /> <return type="void" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<param index="1" name="radius" type="float" /> <argument index="1" name="radius" type="float" />
<description> <description>
Set the map's link connection radius used to connect links to navigation polygons. Set the map's link connection radius used to connect links to navigation polygons.
</description> </description>
</method> </method>
<method name="map_set_use_edge_connections"> <method name="map_set_use_edge_connections">
<return type="void" /> <return type="void" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <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. 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> </description>
@ -578,7 +578,7 @@
</method> </method>
<method name="region_get_owner_id" qualifiers="const"> <method name="region_get_owner_id" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<description> <description>
Returns the [code]ObjectID[/code] of the object which manages this region. Returns the [code]ObjectID[/code] of the object which manages this region.
</description> </description>
@ -592,7 +592,7 @@
</method> </method>
<method name="region_get_use_edge_connections" qualifiers="const"> <method name="region_get_use_edge_connections" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<description> <description>
Returns whether the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Returns whether the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description> </description>
@ -641,8 +641,8 @@
</method> </method>
<method name="region_set_owner_id"> <method name="region_set_owner_id">
<return type="void" /> <return type="void" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<param index="1" name="owner_id" type="int" /> <argument index="1" name="owner_id" type="int" />
<description> <description>
Set the [code]ObjectID[/code] of the object which manages this region. Set the [code]ObjectID[/code] of the object which manages this region.
</description> </description>
@ -665,8 +665,8 @@
</method> </method>
<method name="region_set_use_edge_connections"> <method name="region_set_use_edge_connections">
<return type="void" /> <return type="void" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <description>
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. 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> </description>

16
doc/classes/NavigationAgent.xml
View File

@ -18,14 +18,14 @@
</method> </method>
<method name="get_avoidance_layer_value" qualifiers="const"> <method name="get_avoidance_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. 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> </description>
</method> </method>
<method name="get_avoidance_mask_value" qualifiers="const"> <method name="get_avoidance_mask_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="mask_number" type="int" /> <argument index="0" name="mask_number" type="int" />
<description> <description>
Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32. 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> </description>
@ -112,16 +112,16 @@
</method> </method>
<method name="set_avoidance_layer_value"> <method name="set_avoidance_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>
</method> </method>
<method name="set_avoidance_mask_value"> <method name="set_avoidance_mask_value">
<return type="void" /> <return type="void" />
<param index="0" name="mask_number" type="int" /> <argument index="0" name="mask_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
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. 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> </description>
@ -227,7 +227,7 @@
</members> </members>
<signals> <signals>
<signal name="link_reached"> <signal name="link_reached">
<param index="0" name="details" type="Dictionary" /> <argument index="0" name="details" type="Dictionary" />
<description> <description>
Notifies when a navigation link has been reached. Notifies when a navigation link has been reached.
The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
@ -261,7 +261,7 @@
</description> </description>
</signal> </signal>
<signal name="waypoint_reached"> <signal name="waypoint_reached">
<param index="0" name="details" type="Dictionary" /> <argument index="0" name="details" type="Dictionary" />
<description> <description>
Notifies when a waypoint along the path has been reached. Notifies when a waypoint along the path has been reached.
The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:

16
doc/classes/NavigationAgent2D.xml
View File

@ -18,14 +18,14 @@
</method> </method>
<method name="get_avoidance_layer_value" qualifiers="const"> <method name="get_avoidance_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. 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> </description>
</method> </method>
<method name="get_avoidance_mask_value" qualifiers="const"> <method name="get_avoidance_mask_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="mask_number" type="int" /> <argument index="0" name="mask_number" type="int" />
<description> <description>
Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32. 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> </description>
@ -112,16 +112,16 @@
</method> </method>
<method name="set_avoidance_layer_value"> <method name="set_avoidance_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>
</method> </method>
<method name="set_avoidance_mask_value"> <method name="set_avoidance_mask_value">
<return type="void" /> <return type="void" />
<param index="0" name="mask_number" type="int" /> <argument index="0" name="mask_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
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. 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> </description>
@ -220,7 +220,7 @@
</members> </members>
<signals> <signals>
<signal name="link_reached"> <signal name="link_reached">
<param index="0" name="details" type="Dictionary" /> <argument index="0" name="details" type="Dictionary" />
<description> <description>
Notifies when a navigation link has been reached. Notifies when a navigation link has been reached.
The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
@ -254,7 +254,7 @@
</description> </description>
</signal> </signal>
<signal name="waypoint_reached"> <signal name="waypoint_reached">
<param index="0" name="details" type="Dictionary" /> <argument index="0" name="details" type="Dictionary" />
<description> <description>
Notifies when a waypoint along the path has been reached. Notifies when a waypoint along the path has been reached.
The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]: The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:

8
doc/classes/NavigationGeometryParser2D.xml
View File

@ -11,16 +11,16 @@
<methods> <methods>
<method name="_parse_geometry" qualifiers="virtual const"> <method name="_parse_geometry" qualifiers="virtual const">
<return type="void" /> <return type="void" />
<param index="0" name="node" type="Node" /> <argument index="0" name="node" type="Node" />
<param index="1" name="navigation_polygon" type="NavigationPolygon" /> <argument index="1" name="navigation_polygon" type="NavigationPolygon" />
<param index="2" name="source_geometry" type="NavigationMeshSourceGeometryData2D" /> <argument index="2" name="source_geometry" type="NavigationMeshSourceGeometryData2D" />
<description> <description>
Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationPolygon] baking. Custom 2D geometry can be added to the [param source_geometry]. Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationPolygon] baking. Custom 2D geometry can be added to the [param source_geometry].
</description> </description>
</method> </method>
<method name="_parses_node" qualifiers="virtual const"> <method name="_parses_node" qualifiers="virtual const">
<return type="bool" /> <return type="bool" />
<param index="0" name="node" type="Node" /> <argument index="0" name="node" type="Node" />
<description> <description>
Called when parsing geometry nodes for [NavigationPolygon] baking. If [code]true[/code] will call [method _parse_geometry] with this node. Called when parsing geometry nodes for [NavigationPolygon] baking. If [code]true[/code] will call [method _parse_geometry] with this node.
</description> </description>

8
doc/classes/NavigationGeometryParser3D.xml
View File

@ -11,16 +11,16 @@
<methods> <methods>
<method name="_parse_geometry" qualifiers="virtual const"> <method name="_parse_geometry" qualifiers="virtual const">
<return type="void" /> <return type="void" />
<param index="0" name="node" type="Node" /> <argument index="0" name="node" type="Node" />
<param index="1" name="navigation_mesh" type="NavigationMesh" /> <argument index="1" name="navigation_mesh" type="NavigationMesh" />
<param index="2" name="source_geometry" type="NavigationMeshSourceGeometryData3D" /> <argument index="2" name="source_geometry" type="NavigationMeshSourceGeometryData3D" />
<description> <description>
Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationMesh] baking. Custom 3D geometry can be added to the [param source_geometry]. Called when overridden and the [NavigationMeshGenerator] is parsing geometry for [NavigationMesh] baking. Custom 3D geometry can be added to the [param source_geometry].
</description> </description>
</method> </method>
<method name="_parses_node" qualifiers="virtual const"> <method name="_parses_node" qualifiers="virtual const">
<return type="bool" /> <return type="bool" />
<param index="0" name="node" type="Node" /> <argument index="0" name="node" type="Node" />
<description> <description>
Called when parsing geometry nodes for [NavigationMesh] baking. If [code]true[/code] will call [method _parse_geometry] with this node. Called when parsing geometry nodes for [NavigationMesh] baking. If [code]true[/code] will call [method _parse_geometry] with this node.
</description> </description>

10
doc/classes/NavigationLink2D.xml
View File

@ -24,29 +24,29 @@
</method> </method>
<method name="get_navigation_layer_value" qualifiers="const"> <method name="get_navigation_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32.
</description> </description>
</method> </method>
<method name="set_global_end_position"> <method name="set_global_end_position">
<return type="void" /> <return type="void" />
<param index="0" name="position" type="Vector2" /> <argument index="0" name="position" type="Vector2" />
<description> <description>
Sets the [member end_position] that is relative to the link from a global [param position]. Sets the [member end_position] that is relative to the link from a global [param position].
</description> </description>
</method> </method>
<method name="set_global_start_position"> <method name="set_global_start_position">
<return type="void" /> <return type="void" />
<param index="0" name="position" type="Vector2" /> <argument index="0" name="position" type="Vector2" />
<description> <description>
Sets the [member start_position] that is relative to the link from a global [param position]. Sets the [member start_position] that is relative to the link from a global [param position].
</description> </description>
</method> </method>
<method name="set_navigation_layer_value"> <method name="set_navigation_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>

10
doc/classes/NavigationLink3D.xml
View File

@ -24,29 +24,29 @@
</method> </method>
<method name="get_navigation_layer_value" qualifiers="const"> <method name="get_navigation_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32.
</description> </description>
</method> </method>
<method name="set_global_end_position"> <method name="set_global_end_position">
<return type="void" /> <return type="void" />
<param index="0" name="position" type="Vector3" /> <argument index="0" name="position" type="Vector3" />
<description> <description>
Sets the [member end_position] that is relative to the link from a global [param position]. Sets the [member end_position] that is relative to the link from a global [param position].
</description> </description>
</method> </method>
<method name="set_global_start_position"> <method name="set_global_start_position">
<return type="void" /> <return type="void" />
<param index="0" name="position" type="Vector3" /> <argument index="0" name="position" type="Vector3" />
<description> <description>
Sets the [member start_position] that is relative to the link from a global [param position]. Sets the [member start_position] that is relative to the link from a global [param position].
</description> </description>
</method> </method>
<method name="set_navigation_layer_value"> <method name="set_navigation_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>

2
doc/classes/NavigationMesh.xml
View File

@ -38,7 +38,7 @@
</method> </method>
<method name="set_polygons"> <method name="set_polygons">
<return type="void" /> <return type="void" />
<param index="0" name="polygons" type="Array" /> <argument index="0" name="polygons" type="Array" />
<description> <description>
Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon. Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon.
</description> </description>

48
doc/classes/NavigationMeshGenerator.xml
View File

@ -14,96 +14,96 @@
<methods> <methods>
<method name="bake_2d_from_source_geometry_data"> <method name="bake_2d_from_source_geometry_data">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_polygon" type="NavigationPolygon" /> <argument index="0" name="navigation_polygon" type="NavigationPolygon" />
<param index="1" name="source_geometry_data" type="NavigationMeshSourceGeometryData2D" /> <argument index="1" name="source_geometry_data" type="NavigationMeshSourceGeometryData2D" />
<param index="2" name="callback" type="Callable" /> <argument index="2" name="callback" type="Callable" />
<description> <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. 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> </description>
</method> </method>
<method name="bake_3d_from_source_geometry_data"> <method name="bake_3d_from_source_geometry_data">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_mesh" type="NavigationMesh" /> <argument index="0" name="navigation_mesh" type="NavigationMesh" />
<param index="1" name="source_geometry_data" type="NavigationMeshSourceGeometryData3D" /> <argument index="1" name="source_geometry_data" type="NavigationMeshSourceGeometryData3D" />
<param index="2" name="callback" type="Callable" /> <argument index="2" name="callback" type="Callable" />
<description> <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. 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> </description>
</method> </method>
<method name="is_navigation_mesh_baking" qualifiers="const"> <method name="is_navigation_mesh_baking" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="navigation_mesh" type="NavigationMesh" /> <argument index="0" name="navigation_mesh" type="NavigationMesh" />
<description> <description>
Returns [code]true[/code] if [param navigation_mesh] is currently baking or geometry parsing. Returns [code]true[/code] if [param navigation_mesh] is currently baking or geometry parsing.
</description> </description>
</method> </method>
<method name="is_navigation_polygon_baking" qualifiers="const"> <method name="is_navigation_polygon_baking" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="navigation_polygon" type="NavigationPolygon" /> <argument index="0" name="navigation_polygon" type="NavigationPolygon" />
<description> <description>
Returns [code]true[/code] if [param navigation_polygon] is currently baking or geometry parsing. Returns [code]true[/code] if [param navigation_polygon] is currently baking or geometry parsing.
</description> </description>
</method> </method>
<method name="parse_2d_source_geometry_data"> <method name="parse_2d_source_geometry_data">
<return type="NavigationMeshSourceGeometryData2D" /> <return type="NavigationMeshSourceGeometryData2D" />
<param index="0" name="navigation_polygon" type="NavigationPolygon" /> <argument index="0" name="navigation_polygon" type="NavigationPolygon" />
<param index="1" name="root_node" type="Node" /> <argument index="1" name="root_node" type="Node" />
<param index="2" name="callback" type="Callable" /> <argument index="2" name="callback" type="Callable" />
<description> <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. 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> </description>
</method> </method>
<method name="parse_3d_source_geometry_data"> <method name="parse_3d_source_geometry_data">
<return type="NavigationMeshSourceGeometryData3D" /> <return type="NavigationMeshSourceGeometryData3D" />
<param index="0" name="navigation_mesh" type="NavigationMesh" /> <argument index="0" name="navigation_mesh" type="NavigationMesh" />
<param index="1" name="root_node" type="Node" /> <argument index="1" name="root_node" type="Node" />
<param index="2" name="callback" type="Callable" /> <argument index="2" name="callback" type="Callable" />
<description> <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. 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> </description>
</method> </method>
<method name="parse_and_bake_2d"> <method name="parse_and_bake_2d">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_polygon" type="NavigationPolygon" /> <argument index="0" name="navigation_polygon" type="NavigationPolygon" />
<param index="1" name="root_node" type="Node" /> <argument index="1" name="root_node" type="Node" />
<param index="2" name="callback" type="Callable" /> <argument index="2" name="callback" type="Callable" />
<description> <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. 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> </description>
</method> </method>
<method name="parse_and_bake_3d"> <method name="parse_and_bake_3d">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_mesh" type="NavigationMesh" /> <argument index="0" name="navigation_mesh" type="NavigationMesh" />
<param index="1" name="root_node" type="Node" /> <argument index="1" name="root_node" type="Node" />
<param index="2" name="callback" type="Callable" /> <argument index="2" name="callback" type="Callable" />
<description> <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. 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> </description>
</method> </method>
<method name="register_geometry_parser_2d"> <method name="register_geometry_parser_2d">
<return type="void" /> <return type="void" />
<param index="0" name="geometry_parser" type="NavigationGeometryParser2D" /> <argument index="0" name="geometry_parser" type="NavigationGeometryParser2D" />
<description> <description>
Registers a 2d navigation geometry parser to contribute geometry data from parser specified node class(es) for navigation mesh baking. Registers a 2d navigation geometry parser to contribute geometry data from parser specified node class(es) for navigation mesh baking.
</description> </description>
</method> </method>
<method name="register_geometry_parser_3d"> <method name="register_geometry_parser_3d">
<return type="void" /> <return type="void" />
<param index="0" name="geometry_parser" type="NavigationGeometryParser3D" /> <argument index="0" name="geometry_parser" type="NavigationGeometryParser3D" />
<description> <description>
Registers a 3d navigation geometry parser to contribute geometry data from parser specified node class(es) for navigation mesh baking. Registers a 3d navigation geometry parser to contribute geometry data from parser specified node class(es) for navigation mesh baking.
</description> </description>
</method> </method>
<method name="unregister_geometry_parser_2d"> <method name="unregister_geometry_parser_2d">
<return type="void" /> <return type="void" />
<param index="0" name="geometry_parser" type="NavigationGeometryParser2D" /> <argument index="0" name="geometry_parser" type="NavigationGeometryParser2D" />
<description> <description>
Unregisters the specific 2d navigation geometry parser. Unregisters the specific 2d navigation geometry parser.
</description> </description>
</method> </method>
<method name="unregister_geometry_parser_3d"> <method name="unregister_geometry_parser_3d">
<return type="void" /> <return type="void" />
<param index="0" name="geometry_parser" type="NavigationGeometryParser3D" /> <argument index="0" name="geometry_parser" type="NavigationGeometryParser3D" />
<description> <description>
Unregisters the specific 3d navigation geometry parser. Unregisters the specific 3d navigation geometry parser.
</description> </description>

2
doc/classes/NavigationMeshInstance.xml
View File

@ -52,7 +52,7 @@
</method> </method>
<method name="set_navigation_map"> <method name="set_navigation_map">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_map" type="RID" /> <argument index="0" name="navigation_map" type="RID" />
<description> <description>
Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World3D] default navigation map so this function is only required to override the default map. Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World3D] default navigation map so this function is only required to override the default map.
</description> </description>

12
doc/classes/NavigationMeshSourceGeometryData2D.xml
View File

@ -11,14 +11,14 @@
<methods> <methods>
<method name="add_obstruction_outline"> <method name="add_obstruction_outline">
<return type="void" /> <return type="void" />
<param index="0" name="shape_outline" type="PackedVector2Array" /> <argument index="0" name="shape_outline" type="PoolVector2Array" />
<description> <description>
Adds the outline points of a shape as obstructed area. Adds the outline points of a shape as obstructed area.
</description> </description>
</method> </method>
<method name="add_traversable_outline"> <method name="add_traversable_outline">
<return type="void" /> <return type="void" />
<param index="0" name="shape_outline" type="PackedVector2Array" /> <argument index="0" name="shape_outline" type="PoolVector2Array" />
<description> <description>
Adds the outline points of a shape as traversable area. Adds the outline points of a shape as traversable area.
</description> </description>
@ -30,13 +30,13 @@
</description> </description>
</method> </method>
<method name="get_obstruction_outlines" qualifiers="const"> <method name="get_obstruction_outlines" qualifiers="const">
<return type="PackedVector2Array[]" /> <return type="Array" />
<description> <description>
Returns all the obstructed area outlines arrays. Returns all the obstructed area outlines arrays.
</description> </description>
</method> </method>
<method name="get_traversable_outlines" qualifiers="const"> <method name="get_traversable_outlines" qualifiers="const">
<return type="PackedVector2Array[]" /> <return type="Array" />
<description> <description>
Returns all the traversable area outlines arrays. Returns all the traversable area outlines arrays.
</description> </description>
@ -49,14 +49,14 @@
</method> </method>
<method name="set_obstruction_outlines"> <method name="set_obstruction_outlines">
<return type="void" /> <return type="void" />
<param index="0" name="obstruction_outlines" type="PackedVector2Array[]" /> <argument index="0" name="obstruction_outlines" type="Array" />
<description> <description>
Sets all the obstructed area outlines arrays. Sets all the obstructed area outlines arrays.
</description> </description>
</method> </method>
<method name="set_traversable_outlines"> <method name="set_traversable_outlines">
<return type="void" /> <return type="void" />
<param index="0" name="traversable_outlines" type="PackedVector2Array[]" /> <argument index="0" name="traversable_outlines" type="Array" />
<description> <description>
Sets all the traversable area outlines arrays. Sets all the traversable area outlines arrays.
</description> </description>

20
doc/classes/NavigationMeshSourceGeometryData3D.xml
View File

@ -11,24 +11,24 @@
<methods> <methods>
<method name="add_faces"> <method name="add_faces">
<return type="void" /> <return type="void" />
<param index="0" name="faces" type="PackedVector3Array" /> <argument index="0" name="faces" type="PoolVector3Array" />
<param index="1" name="xform" type="Transform3D" /> <argument index="1" name="xform" type="Transform3D" />
<description> <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. 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> </description>
</method> </method>
<method name="add_mesh"> <method name="add_mesh">
<return type="void" /> <return type="void" />
<param index="0" name="mesh" type="Mesh" /> <argument index="0" name="mesh" type="Mesh" />
<param index="1" name="xform" type="Transform3D" /> <argument index="1" name="xform" type="Transform3D" />
<description> <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. 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> </description>
</method> </method>
<method name="add_mesh_array"> <method name="add_mesh_array">
<return type="void" /> <return type="void" />
<param index="0" name="mesh_array" type="Array" /> <argument index="0" name="mesh_array" type="Array" />
<param index="1" name="xform" type="Transform3D" /> <argument index="1" name="xform" type="Transform3D" />
<description> <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. 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> </description>
@ -40,13 +40,13 @@
</description> </description>
</method> </method>
<method name="get_indices" qualifiers="const"> <method name="get_indices" qualifiers="const">
<return type="PackedInt32Array" /> <return type="PoolIntArray" />
<description> <description>
Returns the parsed source geometry data indices array. Returns the parsed source geometry data indices array.
</description> </description>
</method> </method>
<method name="get_vertices" qualifiers="const"> <method name="get_vertices" qualifiers="const">
<return type="PackedFloat32Array" /> <return type="PoolRealArray" />
<description> <description>
Returns the parsed source geometry data vertices array. Returns the parsed source geometry data vertices array.
</description> </description>
@ -59,7 +59,7 @@
</method> </method>
<method name="set_indices"> <method name="set_indices">
<return type="void" /> <return type="void" />
<param index="0" name="indices" type="PackedInt32Array" /> <argument index="0" name="indices" type="PoolIntArray" />
<description> <description>
Sets the parsed source geometry data indices. The indices need to be matched with appropriated vertices. Sets the parsed source geometry data indices. The indices need to be matched with appropriated vertices.
[b]Warning:[/b] Inappropriate data can crash the baking process of the involved third-party libraries. [b]Warning:[/b] Inappropriate data can crash the baking process of the involved third-party libraries.
@ -67,7 +67,7 @@
</method> </method>
<method name="set_vertices"> <method name="set_vertices">
<return type="void" /> <return type="void" />
<param index="0" name="vertices" type="PackedFloat32Array" /> <argument index="0" name="vertices" type="PoolRealArray" />
<description> <description>
Sets the parsed source geometry data vertices. The vertices need to be matched with appropriated indices. Sets the parsed source geometry data vertices. The vertices need to be matched with appropriated indices.
[b]Warning:[/b] Inappropriate data can crash the baking process of the involved third-party libraries. [b]Warning:[/b] Inappropriate data can crash the baking process of the involved third-party libraries.

10
doc/classes/NavigationObstacle.xml
View File

@ -20,7 +20,7 @@
</method> </method>
<method name="get_avoidance_layer_value" qualifiers="const"> <method name="get_avoidance_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. 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> </description>
@ -45,8 +45,8 @@
</method> </method>
<method name="set_avoidance_layer_value"> <method name="set_avoidance_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>
@ -60,7 +60,7 @@
</method> </method>
<method name="set_navigation_map"> <method name="set_navigation_map">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_map" type="RID" /> <argument index="0" name="navigation_map" type="RID" />
<description> <description>
Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer. Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer.
</description> </description>
@ -83,7 +83,7 @@
<member name="velocity" type="Vector3" setter="set_velocity" getter="get_velocity" default="Vector3(0, 0, 0)"> <member name="velocity" type="Vector3" setter="set_velocity" getter="get_velocity" default="Vector3(0, 0, 0)">
Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices. Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices.
</member> </member>
<member name="vertices" type="PackedVector3Array" setter="set_vertices" getter="get_vertices" default="PackedVector3Array()"> <member name="vertices" type="PoolVector3Array" setter="set_vertices" getter="get_vertices" default="PoolVector3Array()">
The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle.
</member> </member>
</members> </members>

10
doc/classes/NavigationObstacle2D.xml
View File

@ -20,7 +20,7 @@
</method> </method>
<method name="get_avoidance_layer_value" qualifiers="const"> <method name="get_avoidance_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. 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> </description>
@ -45,8 +45,8 @@
</method> </method>
<method name="set_avoidance_layer_value"> <method name="set_avoidance_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>
@ -60,7 +60,7 @@
</method> </method>
<method name="set_navigation_map"> <method name="set_navigation_map">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_map" type="RID" /> <argument index="0" name="navigation_map" type="RID" />
<description> <description>
Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer. Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the [code]obstacle[/code] on the NavigationServer.
</description> </description>
@ -76,7 +76,7 @@
<member name="velocity" type="Vector2" setter="set_velocity" getter="get_velocity" default="Vector2(0, 0)"> <member name="velocity" type="Vector2" setter="set_velocity" getter="get_velocity" default="Vector2(0, 0)">
Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices. Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices.
</member> </member>
<member name="vertices" type="PackedVector2Array" setter="set_vertices" getter="get_vertices" default="PackedVector2Array()"> <member name="vertices" type="PoolVector2Array" setter="set_vertices" getter="get_vertices" default="PoolVector2Array()">
The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle.
</member> </member>
</members> </members>

8
doc/classes/NavigationPathQueryResult2D.xml
View File

@ -18,16 +18,16 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="path" type="PackedVector2Array" setter="set_path" getter="get_path" default="PackedVector2Array()"> <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]. 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>
<member name="path_owner_ids" type="PackedInt64Array" setter="set_path_owner_ids" getter="get_path_owner_ids" default="PackedInt64Array()"> <member name="path_owner_ids" type="PoolIntArray" setter="set_path_owner_ids" getter="get_path_owner_ids" default="PoolIntArray()">
The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
</member> </member>
<member name="path_rids" type="RID[]" setter="set_path_rids" getter="get_path_rids" default="[]"> <member name="path_rids" type="Array" setter="set_path_rids" getter="get_path_rids" default="[]">
The [RID]s of the regions and links that each point of the path goes through. The [RID]s of the regions and links that each point of the path goes through.
</member> </member>
<member name="path_types" type="PackedInt32Array" setter="set_path_types" getter="get_path_types" default="PackedInt32Array()"> <member name="path_types" type="PoolIntArray" setter="set_path_types" getter="get_path_types" default="PoolIntArray()">
The type of navigation primitive (region or link) that each point of the path goes through. The type of navigation primitive (region or link) that each point of the path goes through.
</member> </member>
</members> </members>

8
doc/classes/NavigationPathQueryResult3D.xml
View File

@ -18,16 +18,16 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="path" type="PackedVector3Array" setter="set_path" getter="get_path" default="PackedVector3Array()"> <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]. 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>
<member name="path_owner_ids" type="PackedInt64Array" setter="set_path_owner_ids" getter="get_path_owner_ids" default="PackedInt64Array()"> <member name="path_owner_ids" type="PoolIntArray" setter="set_path_owner_ids" getter="get_path_owner_ids" default="PoolIntArray()">
The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through. The [code]ObjectID[/code]s of the [Object]s which manage the regions and links each point of the path goes through.
</member> </member>
<member name="path_rids" type="RID[]" setter="set_path_rids" getter="get_path_rids" default="[]"> <member name="path_rids" type="Array" setter="set_path_rids" getter="get_path_rids" default="[]">
The [RID]s of the regions and links that each point of the path goes through. The [RID]s of the regions and links that each point of the path goes through.
</member> </member>
<member name="path_types" type="PackedInt32Array" setter="set_path_types" getter="get_path_types" default="PackedInt32Array()"> <member name="path_types" type="PoolIntArray" setter="set_path_types" getter="get_path_types" default="PoolIntArray()">
The type of navigation primitive (region or link) that each point of the path goes through. The type of navigation primitive (region or link) that each point of the path goes through.
</member> </member>
</members> </members>

16
doc/classes/NavigationPolygon.xml
View File

@ -10,7 +10,7 @@
Using [method add_outline]: Using [method add_outline]:
[codeblock] [codeblock]
var new_navigation_polygon = NavigationPolygon.new() var new_navigation_polygon = NavigationPolygon.new()
var new_navigation_polygon_outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) var new_navigation_polygon_outline = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
new_navigation_polygon.add_outline(new_navigation_polygon_outline) new_navigation_polygon.add_outline(new_navigation_polygon_outline)
NavigationMeshGenerator.bake_2d_from_source_geometry_data(new_navigation_polygon, NavigationMeshSourceGeometryData2D.new()); NavigationMeshGenerator.bake_2d_from_source_geometry_data(new_navigation_polygon, NavigationMeshSourceGeometryData2D.new());
$NavigationRegion2D.navigation_polygon = new_navigation_polygon $NavigationRegion2D.navigation_polygon = new_navigation_polygon
@ -18,9 +18,9 @@
Using [method add_polygon] and indices of the vertices array. Using [method add_polygon] and indices of the vertices array.
[codeblock] [codeblock]
var new_navigation_polygon = NavigationPolygon.new() var new_navigation_polygon = NavigationPolygon.new()
var new_navigation_polygon_vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) var new_navigation_polygon_vertices = PoolVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
new_navigation_polygon.vertices = new_navigation_polygon_vertices new_navigation_polygon.vertices = new_navigation_polygon_vertices
var new_navigation_polygon_polygon_indices = PackedInt32Array([0, 1, 2, 3]) var new_navigation_polygon_polygon_indices = PoolIntArray([0, 1, 2, 3])
new_navigation_polygon.add_polygon(new_navigation_polygon_polygon_indices) new_navigation_polygon.add_polygon(new_navigation_polygon_polygon_indices)
new_navigation_polygon.commit_changes() new_navigation_polygon.commit_changes()
$NavigationRegion2D.navigation_polygon = new_navigation_polygon $NavigationRegion2D.navigation_polygon = new_navigation_polygon
@ -104,21 +104,21 @@
</method> </method>
<method name="set_baked_outlines"> <method name="set_baked_outlines">
<return type="void" /> <return type="void" />
<param index="0" name="baked_outlines" type="Array" /> <argument index="0" name="baked_outlines" type="Array" />
<description> <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. 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> </description>
</method> </method>
<method name="set_outlines"> <method name="set_outlines">
<return type="void" /> <return type="void" />
<param index="0" name="outlines" type="Array" /> <argument index="0" name="outlines" type="Array" />
<description> <description>
Sets the outline arrays. The outlines need to be baked to actual navigation mesh polygons by using the [NavigationMeshGenerator]. Sets the outline arrays. The outlines need to be baked to actual navigation mesh polygons by using the [NavigationMeshGenerator].
</description> </description>
</method> </method>
<method name="set_polygons"> <method name="set_polygons">
<return type="void" /> <return type="void" />
<param index="0" name="polygons" type="Array" /> <argument index="0" name="polygons" type="Array" />
<description> <description>
Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon. Sets the navigation mesh polygons. Each polygon array needs to consist of the indices for the vertices that make the polygon.
</description> </description>
@ -164,14 +164,14 @@
</description> </description>
</method> </method>
<method name="get_baked_outlines" qualifiers="const"> <method name="get_baked_outlines" qualifiers="const">
<return type="PackedVector2Array[]" /> <return type="Array" />
<description> <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. 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> </description>
</method> </method>
<method name="get_collision_mask_value" qualifiers="const"> <method name="get_collision_mask_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <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. 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> </description>

10
doc/classes/NavigationPolygonInstance.xml
View File

@ -17,7 +17,7 @@
<methods> <methods>
<method name="get_avoidance_layer_value" qualifiers="const"> <method name="get_avoidance_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<description> <description>
Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. 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> </description>
@ -37,7 +37,7 @@
</method> </method>
<method name="bake_navigation_polygon"> <method name="bake_navigation_polygon">
<return type="void" /> <return type="void" />
<param index="0" name="on_thread" type="bool" default="true" /> <argument index="0" name="on_thread" type="bool" default="true" />
<description> <description>
Bakes the [NavigationPolygon]. If [param on_thread] is set to [code]true[/code] (default), the baking is done on a separate thread. Bakes the [NavigationPolygon]. If [param on_thread] is set to [code]true[/code] (default), the baking is done on a separate thread.
</description> </description>
@ -50,8 +50,8 @@
</method> </method>
<method name="set_avoidance_layer_value"> <method name="set_avoidance_layer_value">
<return type="void" /> <return type="void" />
<param index="0" name="layer_number" type="int" /> <argument index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" /> <argument index="1" name="value" type="bool" />
<description> <description>
Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32.
</description> </description>
@ -66,7 +66,7 @@
</method> </method>
<method name="set_navigation_map"> <method name="set_navigation_map">
<return type="void" /> <return type="void" />
<param index="0" name="navigation_map" type="RID" /> <argument index="0" name="navigation_map" type="RID" />
<description> <description>
Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map. Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map.
</description> </description>

146
doc/classes/NavigationServer.xml
View File

@ -25,7 +25,7 @@
</method> </method>
<method name="agent_get_avoidance_enabled" qualifiers="const"> <method name="agent_get_avoidance_enabled" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<description> <description>
Returns [code]true[/code] if the provided [param agent] has avoidance enabled. Returns [code]true[/code] if the provided [param agent] has avoidance enabled.
</description> </description>
@ -39,7 +39,7 @@
</method> </method>
<method name="agent_get_use_3d_avoidance" qualifiers="const"> <method name="agent_get_use_3d_avoidance" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<description> <description>
Returns [code]true[/code] if the provided [param agent] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). Returns [code]true[/code] if the provided [param agent] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).
</description> </description>
@ -64,32 +64,32 @@
</method> </method>
<method name="agent_set_avoidance_enabled"> <method name="agent_set_avoidance_enabled">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <description>
If [param enabled] the provided [param agent] calculates avoidance. If [param enabled] the provided [param agent] calculates avoidance.
</description> </description>
</method> </method>
<method name="agent_set_avoidance_layers"> <method name="agent_set_avoidance_layers">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="layers" type="int" /> <argument index="1" name="layers" type="int" />
<description> <description>
Set the agent's [code]avoidance_layers[/code] bitmask. Set the agent's [code]avoidance_layers[/code] bitmask.
</description> </description>
</method> </method>
<method name="agent_set_avoidance_mask"> <method name="agent_set_avoidance_mask">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="mask" type="int" /> <argument index="1" name="mask" type="int" />
<description> <description>
Set the agent's [code]avoidance_mask[/code] bitmask. Set the agent's [code]avoidance_mask[/code] bitmask.
</description> </description>
</method> </method>
<method name="agent_set_avoidance_priority"> <method name="agent_set_avoidance_priority">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="priority" type="float" /> <argument index="1" name="priority" type="float" />
<description> <description>
Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority).
The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.
@ -97,8 +97,8 @@
</method> </method>
<method name="agent_set_height"> <method name="agent_set_height">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="height" type="float" /> <argument index="1" name="height" type="float" />
<description> <description>
Updates the provided [param agent] [param height]. Updates the provided [param agent] [param height].
</description> </description>
@ -153,8 +153,8 @@
</method> </method>
<method name="agent_set_time_horizon_agents"> <method name="agent_set_time_horizon_agents">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="time_horizon" type="float" /> <argument index="1" name="time_horizon" type="float" />
<description> <description>
The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
</description> </description>
@ -162,7 +162,7 @@
<method name="agent_set_time_horizon_obstacles"> <method name="agent_set_time_horizon_obstacles">
<return type="void" /> <return type="void" />
<argument index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="time_horizon" type="float" /> <argument index="1" name="time_horizon" type="float" />
<description> <description>
The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.
</description> </description>
@ -170,7 +170,7 @@
<method name="agent_set_use_3d_avoidance"> <method name="agent_set_use_3d_avoidance">
<return type="void" /> <return type="void" />
<argument index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <description>
Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled.
If [code]true[/code] the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, unterwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's. If [code]true[/code] the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, unterwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's.
@ -187,8 +187,8 @@
</method> </method>
<method name="agent_set_velocity_forced"> <method name="agent_set_velocity_forced">
<return type="void" /> <return type="void" />
<param index="0" name="agent" type="RID" /> <argument index="0" name="agent" type="RID" />
<param index="1" name="velocity" type="Vector3" /> <argument index="1" name="velocity" type="Vector3" />
<description> <description>
Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck.
</description> </description>
@ -202,7 +202,7 @@
</method> </method>
<method name="set_debug_enabled"> <method name="set_debug_enabled">
<return type="void" /> <return type="void" />
<param index="0" name="enabled" type="bool" /> <argument index="0" name="enabled" type="bool" />
<description> <description>
If [code]true[/code] enables debug mode on the NavigationServer. If [code]true[/code] enables debug mode on the NavigationServer.
</description> </description>
@ -215,7 +215,7 @@
</method> </method>
<method name="get_process_info" qualifiers="const"> <method name="get_process_info" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="process_info" type="int" enum="NavigationServer3D.ProcessInfo" /> <argument index="0" name="process_info" type="int" enum="NavigationServer3D.ProcessInfo" />
<description> <description>
Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states. Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states.
</description> </description>
@ -228,120 +228,120 @@
</method> </method>
<method name="link_get_end_position" qualifiers="const"> <method name="link_get_end_position" qualifiers="const">
<return type="Vector3" /> <return type="Vector3" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the ending position of this [code]link[/code]. Returns the ending position of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_enter_cost" qualifiers="const"> <method name="link_get_enter_cost" qualifiers="const">
<return type="float" /> <return type="float" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the [code]enter_cost[/code] of this [code]link[/code]. Returns the [code]enter_cost[/code] of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_map" qualifiers="const"> <method name="link_get_map" qualifiers="const">
<return type="RID" /> <return type="RID" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to. Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to.
</description> </description>
</method> </method>
<method name="link_get_navigation_layers" qualifiers="const"> <method name="link_get_navigation_layers" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the navigation layers for this [code]link[/code]. Returns the navigation layers for this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_owner_id" qualifiers="const"> <method name="link_get_owner_id" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the [code]ObjectID[/code] of the object which manages this link. Returns the [code]ObjectID[/code] of the object which manages this link.
</description> </description>
</method> </method>
<method name="link_get_start_position" qualifiers="const"> <method name="link_get_start_position" qualifiers="const">
<return type="Vector3" /> <return type="Vector3" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the starting position of this [code]link[/code]. Returns the starting position of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_get_travel_cost" qualifiers="const"> <method name="link_get_travel_cost" qualifiers="const">
<return type="float" /> <return type="float" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns the [code]travel_cost[/code] of this [code]link[/code]. Returns the [code]travel_cost[/code] of this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_is_bidirectional" qualifiers="const"> <method name="link_is_bidirectional" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<description> <description>
Returns whether this [code]link[/code] can be travelled in both directions. Returns whether this [code]link[/code] can be travelled in both directions.
</description> </description>
</method> </method>
<method name="link_set_bidirectional"> <method name="link_set_bidirectional">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="bidirectional" type="bool" /> <argument index="1" name="bidirectional" type="bool" />
<description> <description>
Sets whether this [code]link[/code] can be travelled in both directions. Sets whether this [code]link[/code] can be travelled in both directions.
</description> </description>
</method> </method>
<method name="link_set_end_position"> <method name="link_set_end_position">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="position" type="Vector3" /> <argument index="1" name="position" type="Vector3" />
<description> <description>
Sets the exit position for the [code]link[/code]. Sets the exit position for the [code]link[/code].
</description> </description>
</method> </method>
<method name="link_set_enter_cost"> <method name="link_set_enter_cost">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="enter_cost" type="float" /> <argument index="1" name="enter_cost" type="float" />
<description> <description>
Sets the [code]enter_cost[/code] for this [code]link[/code]. Sets the [code]enter_cost[/code] for this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_set_map"> <method name="link_set_map">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="map" type="RID" /> <argument index="1" name="map" type="RID" />
<description> <description>
Sets the navigation map [RID] for the link. Sets the navigation map [RID] for the link.
</description> </description>
</method> </method>
<method name="link_set_navigation_layers"> <method name="link_set_navigation_layers">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="navigation_layers" type="int" /> <argument index="1" name="navigation_layers" type="int" />
<description> <description>
Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer3D.map_get_path]). Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer3D.map_get_path]).
</description> </description>
</method> </method>
<method name="link_set_owner_id"> <method name="link_set_owner_id">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="owner_id" type="int" /> <argument index="1" name="owner_id" type="int" />
<description> <description>
Set the [code]ObjectID[/code] of the object which manages this link. Set the [code]ObjectID[/code] of the object which manages this link.
</description> </description>
</method> </method>
<method name="link_set_start_position"> <method name="link_set_start_position">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="position" type="Vector3" /> <argument index="1" name="position" type="Vector3" />
<description> <description>
Sets the entry position for this [code]link[/code]. Sets the entry position for this [code]link[/code].
</description> </description>
</method> </method>
<method name="link_set_travel_cost"> <method name="link_set_travel_cost">
<return type="void" /> <return type="void" />
<param index="0" name="link" type="RID" /> <argument index="0" name="link" type="RID" />
<param index="1" name="travel_cost" type="float" /> <argument index="1" name="travel_cost" type="float" />
<description> <description>
Sets the [code]travel_cost[/code] for this [code]link[/code]. Sets the [code]travel_cost[/code] for this [code]link[/code].
</description> </description>
@ -426,21 +426,21 @@
</method> </method>
<method name="map_get_link_connection_radius" qualifiers="const"> <method name="map_get_link_connection_radius" qualifiers="const">
<return type="float" /> <return type="float" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to.
</description> </description>
</method> </method>
<method name="map_get_links" qualifiers="const"> <method name="map_get_links" qualifiers="const">
<return type="RID[]" /> <return type="Array" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code]. Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description> </description>
</method> </method>
<method name="map_get_obstacles" qualifiers="const"> <method name="map_get_obstacles" qualifiers="const">
<return type="RID[]" /> <return type="Array" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code]. Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description> </description>
@ -472,7 +472,7 @@
</method> </method>
<method name="map_get_use_edge_connections" qualifiers="const"> <method name="map_get_use_edge_connections" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<description> <description>
Returns true if the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Returns true if the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description> </description>
@ -518,8 +518,8 @@
</method> </method>
<method name="map_set_link_connection_radius"> <method name="map_set_link_connection_radius">
<return type="void" /> <return type="void" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<param index="1" name="radius" type="float" /> <argument index="1" name="radius" type="float" />
<description> <description>
Set the map's link connection radius used to connect links to navigation polygons. Set the map's link connection radius used to connect links to navigation polygons.
</description> </description>
@ -540,55 +540,55 @@
</method> </method>
<method name="obstacle_get_map" qualifiers="const"> <method name="obstacle_get_map" qualifiers="const">
<return type="RID" /> <return type="RID" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<description> <description>
Returns the navigation map [RID] the requested [param obstacle] is currently assigned to. Returns the navigation map [RID] the requested [param obstacle] is currently assigned to.
</description> </description>
</method> </method>
<method name="obstacle_set_avoidance_layers"> <method name="obstacle_set_avoidance_layers">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="layers" type="int" /> <argument index="1" name="layers" type="int" />
<description> <description>
Set the obstacles's [code]avoidance_layers[/code] bitmask. Set the obstacles's [code]avoidance_layers[/code] bitmask.
</description> </description>
</method> </method>
<method name="obstacle_set_height"> <method name="obstacle_set_height">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="height" type="float" /> <argument index="1" name="height" type="float" />
<description> <description>
Sets the [param height] for the [param obstacle]. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance. Sets the [param height] for the [param obstacle]. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance.
</description> </description>
</method> </method>
<method name="obstacle_set_map"> <method name="obstacle_set_map">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="map" type="RID" /> <argument index="1" name="map" type="RID" />
<description> <description>
Assigns the [param obstacle] to a navigation map. Assigns the [param obstacle] to a navigation map.
</description> </description>
</method> </method>
<method name="obstacle_set_position"> <method name="obstacle_set_position">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="position" type="Vector3" /> <argument index="1" name="position" type="Vector3" />
<description> <description>
Updates the [param position] in world space for the [param obstacle]. Updates the [param position] in world space for the [param obstacle].
</description> </description>
</method> </method>
<method name="obstacle_set_vertices"> <method name="obstacle_set_vertices">
<return type="void" /> <return type="void" />
<param index="0" name="obstacle" type="RID" /> <argument index="0" name="obstacle" type="RID" />
<param index="1" name="vertices" type="PackedVector3Array" /> <argument index="1" name="vertices" type="PoolVector3Array" />
<description> <description>
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. 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> </description>
</method> </method>
<method name="map_set_use_edge_connections"> <method name="map_set_use_edge_connections">
<return type="void" /> <return type="void" />
<param index="0" name="map" type="RID" /> <argument index="0" name="map" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <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. 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> </description>
@ -604,8 +604,8 @@
</method> </method>
<method name="query_path" qualifiers="const"> <method name="query_path" qualifiers="const">
<return type="void" /> <return type="void" />
<param index="0" name="parameters" type="NavigationPathQueryParameters3D" /> <argument index="0" name="parameters" type="NavigationPathQueryParameters3D" />
<param index="1" name="result" type="NavigationPathQueryResult3D" /> <argument index="1" name="result" type="NavigationPathQueryResult3D" />
<description> <description>
Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query. Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query.
</description> </description>
@ -662,7 +662,7 @@
</method> </method>
<method name="region_get_owner_id" qualifiers="const"> <method name="region_get_owner_id" qualifiers="const">
<return type="int" /> <return type="int" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<description> <description>
Returns the [code]ObjectID[/code] of the object which manages this region. Returns the [code]ObjectID[/code] of the object which manages this region.
</description> </description>
@ -676,7 +676,7 @@
</method> </method>
<method name="region_get_use_edge_connections" qualifiers="const"> <method name="region_get_use_edge_connections" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<description> <description>
Returns true if the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Returns true if the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description> </description>
@ -725,8 +725,8 @@
</method> </method>
<method name="region_set_owner_id"> <method name="region_set_owner_id">
<return type="void" /> <return type="void" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<param index="1" name="owner_id" type="int" /> <argument index="1" name="owner_id" type="int" />
<description> <description>
Set the [code]ObjectID[/code] of the object which manages this region. Set the [code]ObjectID[/code] of the object which manages this region.
</description> </description>
@ -749,8 +749,8 @@
</method> </method>
<method name="region_set_use_edge_connections"> <method name="region_set_use_edge_connections">
<return type="void" /> <return type="void" />
<param index="0" name="region" type="RID" /> <argument index="0" name="region" type="RID" />
<param index="1" name="enabled" type="bool" /> <argument index="1" name="enabled" type="bool" />
<description> <description>
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. 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> </description>