summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationServer2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/NavigationServer2D.xml')
-rw-r--r--doc/classes/NavigationServer2D.xml267
1 files changed, 89 insertions, 178 deletions
diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml
index b0a57ed227..042ab06e6f 100644
--- a/doc/classes/NavigationServer2D.xml
+++ b/doc/classes/NavigationServer2D.xml
@@ -16,337 +16,249 @@
</tutorials>
<methods>
<method name="agent_create" qualifiers="const">
- <return type="RID">
- </return>
+ <return type="RID" />
<description>
Creates the agent.
</description>
</method>
<method name="agent_is_map_changed" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="agent" type="RID" />
<description>
Returns true if the map got changed the previous frame.
</description>
</method>
<method name="agent_set_callback" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="receiver" type="Object">
- </argument>
- <argument index="2" name="method" type="StringName">
- </argument>
- <argument index="3" name="userdata" type="Variant" default="null">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="receiver" type="Object" />
+ <argument index="2" name="method" type="StringName" />
+ <argument index="3" name="userdata" type="Variant" default="null" />
<description>
Callback called at the end of the RVO process.
</description>
</method>
<method name="agent_set_map" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="map" type="RID">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="map" type="RID" />
<description>
Puts the agent in the map.
</description>
</method>
<method name="agent_set_max_neighbors" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="count" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="count" type="int" />
<description>
Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.
</description>
</method>
<method name="agent_set_max_speed" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="max_speed" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="max_speed" type="float" />
<description>
Sets the maximum speed of the agent. Must be positive.
</description>
</method>
<method name="agent_set_neighbor_dist" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="dist" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="dist" type="float" />
<description>
Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.
</description>
</method>
<method name="agent_set_position" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="position" type="Vector2">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="position" type="Vector2" />
<description>
Sets the position of the agent in world space.
</description>
</method>
<method name="agent_set_radius" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="radius" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="radius" type="float" />
<description>
Sets the radius of the agent.
</description>
</method>
<method name="agent_set_target_velocity" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="target_velocity" type="Vector2">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="target_velocity" type="Vector2" />
<description>
Sets the new target velocity.
</description>
</method>
<method name="agent_set_time_horizon" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="time" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="time" type="float" />
<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. Must be positive.
</description>
</method>
<method name="agent_set_velocity" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="agent" type="RID">
- </argument>
- <argument index="1" name="velocity" type="Vector2">
- </argument>
+ <return type="void" />
+ <argument index="0" name="agent" type="RID" />
+ <argument index="1" name="velocity" type="Vector2" />
<description>
Sets the current velocity of the agent.
</description>
</method>
<method name="free" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="object" type="RID">
- </argument>
+ <return type="void" />
+ <argument index="0" name="object" type="RID" />
<description>
Destroy the RID
</description>
</method>
<method name="map_create" qualifiers="const">
- <return type="RID">
- </return>
+ <return type="RID" />
<description>
Create a new map.
</description>
</method>
<method name="map_get_cell_size" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
+ <return type="float" />
+ <argument index="0" name="map" type="RID" />
<description>
Returns the map cell size.
</description>
</method>
<method name="map_get_closest_point" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
- <argument index="1" name="to_point" type="Vector2">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="map" type="RID" />
+ <argument index="1" name="to_point" type="Vector2" />
<description>
Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface.
</description>
</method>
<method name="map_get_closest_point_owner" qualifiers="const">
- <return type="RID">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
- <argument index="1" name="to_point" type="Vector2">
- </argument>
+ <return type="RID" />
+ <argument index="0" name="map" type="RID" />
+ <argument index="1" name="to_point" type="Vector2" />
<description>
Returns the owner region RID for the point returned by [method map_get_closest_point].
</description>
</method>
<method name="map_get_edge_connection_margin" qualifiers="const">
- <return type="float">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
+ <return type="float" />
+ <argument index="0" name="map" type="RID" />
<description>
Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions.
</description>
</method>
<method name="map_get_path" qualifiers="const">
- <return type="PackedVector2Array">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
- <argument index="1" name="origin" type="Vector2">
- </argument>
- <argument index="2" name="destination" type="Vector2">
- </argument>
- <argument index="3" name="optimize" type="bool">
- </argument>
- <argument index="4" name="layers" type="int" default="1">
- </argument>
+ <return type="PackedVector2Array" />
+ <argument index="0" name="map" type="RID" />
+ <argument index="1" name="origin" type="Vector2" />
+ <argument index="2" name="destination" type="Vector2" />
+ <argument index="3" name="optimize" type="bool" />
+ <argument index="4" name="layers" type="int" default="1" />
<description>
Returns the navigation path to reach the destination from the origin. [code]layers[/code] is a bitmask of all region layers that are allowed to be in the path.
</description>
</method>
<method name="map_is_active" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="nap" type="RID">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="nap" type="RID" />
<description>
Returns true if the map is active.
</description>
</method>
<method name="map_set_active" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
- <argument index="1" name="active" type="bool">
- </argument>
+ <return type="void" />
+ <argument index="0" name="map" type="RID" />
+ <argument index="1" name="active" type="bool" />
<description>
Sets the map active.
</description>
</method>
<method name="map_set_cell_size" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
- <argument index="1" name="cell_size" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="map" type="RID" />
+ <argument index="1" name="cell_size" type="float" />
<description>
Set the map cell size used to weld the navigation mesh polygons.
</description>
</method>
<method name="map_set_edge_connection_margin" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="map" type="RID">
- </argument>
- <argument index="1" name="margin" type="float">
- </argument>
+ <return type="void" />
+ <argument index="0" name="map" type="RID" />
+ <argument index="1" name="margin" type="float" />
<description>
Set the map edge connection margin used to weld the compatible region edges.
</description>
</method>
<method name="region_create" qualifiers="const">
- <return type="RID">
- </return>
+ <return type="RID" />
<description>
Creates a new region.
</description>
</method>
<method name="region_get_connection_pathway_end" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
- <argument index="1" name="connection" type="int">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="region" type="RID" />
+ <argument index="1" name="connection" type="int" />
<description>
Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count].
</description>
</method>
<method name="region_get_connection_pathway_start" qualifiers="const">
- <return type="Vector2">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
- <argument index="1" name="connection" type="int">
- </argument>
+ <return type="Vector2" />
+ <argument index="0" name="region" type="RID" />
+ <argument index="1" name="connection" type="int" />
<description>
Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count].
</description>
</method>
<method name="region_get_connections_count" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
+ <return type="int" />
+ <argument index="0" name="region" type="RID" />
<description>
Returns how many connections this [code]region[/code] has with other regions in the map.
</description>
</method>
<method name="region_get_layers" qualifiers="const">
- <return type="int">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
+ <return type="int" />
+ <argument index="0" name="region" type="RID" />
<description>
Returns the region's layers.
</description>
</method>
<method name="region_set_layers" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
- <argument index="1" name="layers" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="region" type="RID" />
+ <argument index="1" name="layers" type="int" />
<description>
Set the region's layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]).
</description>
</method>
<method name="region_set_map" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
- <argument index="1" name="map" type="RID">
- </argument>
+ <return type="void" />
+ <argument index="0" name="region" type="RID" />
+ <argument index="1" name="map" type="RID" />
<description>
Sets the map for the region.
</description>
</method>
<method name="region_set_navpoly" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
- <argument index="1" name="nav_poly" type="NavigationPolygon">
- </argument>
+ <return type="void" />
+ <argument index="0" name="region" type="RID" />
+ <argument index="1" name="nav_poly" type="NavigationPolygon" />
<description>
Sets the navigation mesh for the region.
</description>
</method>
<method name="region_set_transform" qualifiers="const">
- <return type="void">
- </return>
- <argument index="0" name="region" type="RID">
- </argument>
- <argument index="1" name="transform" type="Transform2D">
- </argument>
+ <return type="void" />
+ <argument index="0" name="region" type="RID" />
+ <argument index="1" name="transform" type="Transform2D" />
<description>
Sets the global transformation for the region.
</description>
@@ -354,8 +266,7 @@
</methods>
<signals>
<signal name="map_changed">
- <argument index="0" name="map" type="RID">
- </argument>
+ <argument index="0" name="map" type="RID" />
<description>
Emitted when a navigation map is updated, when a region moves or is modified.
</description>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-20 09:32:11 +0000