Relintai/pandemonium_engine_minimal
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine_minimal.git synced 2024-11-10 20:12:10 +01:00
Code Issues Packages Projects Releases Wiki Activity
aa8aabf8d9
pandemonium_engine_minimal/doc/classes/NavigationServer.xml
Relintai 57640b138a Added back docs.
2023-12-14 23:24:47 +01:00

917 lines
41 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationServer" inherits="Object" version="4.2">
<brief_description>
Server interface for low-level 3D navigation access.
</brief_description>
<description>
NavigationServer is the server responsible for all 3D navigation. It handles several objects, namely maps, regions and agents.
Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D world.
[b]Note:[/b] Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts.
For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [member Navigation.edge_connection_margin] to the respective other edge's vertex.
To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
[b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.
[b]Note:[/b] By default, the expensive calculations for avoidance are done in a thread. In HTML5 exports without thread support, they will be done on the main thread, which can lead to performance issues.
This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying.
</description>
<tutorials>
<link title="3D Navmesh Demo">https://github.com/Relintai/pandemonium_demo_projects/tree/master/3d/navmesh</link>
<link title="Using NavigationServer">$DOCS_URL/tutorials/navigation/navigation_using_navigationservers.md</link>
</tutorials>
<methods>
<method name="agent_create">
<return type="RID" />
<description>
Creates the agent.
</description>
</method>
<method name="agent_get_avoidance_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="agent" type="RID" />
<description>
Returns [code]true[/code] if the provided [param agent] has avoidance enabled.
</description>
</method>
<method name="agent_get_map" qualifiers="const">
<return type="RID" />
<argument index="0" name="agent" type="RID" />
<description>
Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to.
</description>
</method>
<method name="agent_get_paused" qualifiers="const">
<return type="bool" />
<argument index="0" name="agent" type="RID" />
<description>
Returns [code]true[/code] if the specified [param agent] is paused.
</description>
</method>
<method name="agent_get_use_3d_avoidance" qualifiers="const">
<return type="bool" />
<argument index="0" name="agent" type="RID" />
<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).
</description>
</method>
<method name="agent_is_map_changed" qualifiers="const">
<return type="bool" />
<argument index="0" name="agent" type="RID" />
<description>
Returns [code]true[/code] if the map got changed the previous frame.
</description>
</method>
<method name="agent_set_avoidance_callback">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="object_id" type="int" />
<argument index="2" name="method" type="StringName" />
<argument index="3" name="userdata" type="Variant" default="null" />
<description>
Sets the callback [Callable] that gets called after each avoidance processing step for the [param agent]. The calculated [code]safe_velocity[/code] will be dispatched with a signal to the object just before the physics calculations.
[b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_avoidance_callback] again with an empty [Callable].
</description>
</method>
<method name="agent_set_avoidance_enabled">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param agent] calculates avoidance.
</description>
</method>
<method name="agent_set_avoidance_layers">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="layers" type="int" />
<description>
Set the agent's [code]avoidance_layers[/code] bitmask.
</description>
</method>
<method name="agent_set_avoidance_mask">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="mask" type="int" />
<description>
Set the agent's [code]avoidance_mask[/code] bitmask.
</description>
</method>
<method name="agent_set_avoidance_priority">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="priority" type="float" />
<description>
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.
</description>
</method>
<method name="agent_set_height">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="height" type="float" />
<description>
Updates the provided [param agent] [param height].
</description>
</method>
<method name="agent_set_map">
<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">
<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">
<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_distance">
<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_paused">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="paused" type="bool" />
<description>
If [param paused] is true the specified [param agent] will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks.
</description>
</method>
<method name="agent_set_position">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="position" type="Vector3" />
<description>
Sets the position of the agent in world space.
</description>
</method>
<method name="agent_set_radius">
<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_time_horizon_agents">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="time_horizon" 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. A too high value will slow down agents movement considerably. Must be positive.
</description>
</method>
<method name="agent_set_time_horizon_obstacles">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="time_horizon" 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 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>
</method>
<method name="agent_set_use_3d_avoidance">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
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]false[/code] the agent calculates avoidance velocities in 2D along the xz-axis ignoring the y-axis. The 2D using agent only avoids other 2D avoidance using agent's. The 2D using agent reacts to radius avoidance obstacles. The 2D using agent reacts to vertices based avoidance obstacles. The 2D using agent only avoids other 2D using agent's. 2D using agents will ignore other 2D using agents or obstacles that are below their current position or above their current position including the agents height in 2D avoidance.
</description>
</method>
<method name="agent_set_velocity">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="velocity" type="Vector3" />
<description>
Sets [param velocity] as the new wanted velocity for the specified [param agent]. The avoidance simulation will try to fulfil this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position use [method agent_set_velocity_forced] as well to reset the internal simulation velocity.
</description>
</method>
<method name="agent_set_velocity_forced">
<return type="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="velocity" type="Vector3" />
<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.
</description>
</method>
<method name="free_rid">
<return type="void" />
<argument index="0" name="rid" type="RID" />
<description>
Destroys the given RID.
</description>
</method>
<method name="get_debug_enabled" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
<method name="get_maps" qualifiers="const">
<return type="Array" />
<description>
Returns all created navigation map [RID]s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them.
</description>
</method>
<method name="get_process_info" qualifiers="const">
<return type="int" />
<argument index="0" name="process_info" type="int" enum="NavigationServer.ProcessInfo" />
<description>
Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states.
</description>
</method>
<method name="link_create">
<return type="RID" />
<description>
Create a new link between two positions on a map.
</description>
</method>
<method name="link_get_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="link" type="RID" />
<description>
Returns [code]true[/code] if the specified [param link] is enabled.
</description>
</method>
<method name="link_get_end_position" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="link" type="RID" />
<description>
Returns the ending position of this [code]link[/code].
</description>
</method>
<method name="link_get_enter_cost" qualifiers="const">
<return type="float" />
<argument index="0" name="link" type="RID" />
<description>
Returns the [code]enter_cost[/code] of this [code]link[/code].
</description>
</method>
<method name="link_get_map" qualifiers="const">
<return type="RID" />
<argument index="0" name="link" type="RID" />
<description>
Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to.
</description>
</method>
<method name="link_get_navigation_layers" qualifiers="const">
<return type="int" />
<argument index="0" name="link" type="RID" />
<description>
Returns the navigation layers for this [code]link[/code].
</description>
</method>
<method name="link_get_owner_id" qualifiers="const">
<return type="int" />
<argument index="0" name="link" type="RID" />
<description>
Returns the [code]ObjectID[/code] of the object which manages this link.
</description>
</method>
<method name="link_get_start_position" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="link" type="RID" />
<description>
Returns the starting position of this [code]link[/code].
</description>
</method>
<method name="link_get_travel_cost" qualifiers="const">
<return type="float" />
<argument index="0" name="link" type="RID" />
<description>
Returns the [code]travel_cost[/code] of this [code]link[/code].
</description>
</method>
<method name="link_is_bidirectional" qualifiers="const">
<return type="bool" />
<argument index="0" name="link" type="RID" />
<description>
Returns whether this [code]link[/code] can be travelled in both directions.
</description>
</method>
<method name="link_set_bidirectional">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="bidirectional" type="bool" />
<description>
Sets whether this [code]link[/code] can be travelled in both directions.
</description>
</method>
<method name="link_set_enabled">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param link] will contribute to its current navigation map.
</description>
</method>
<method name="link_set_end_position">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="position" type="Vector3" />
<description>
Sets the exit position for the [code]link[/code].
</description>
</method>
<method name="link_set_enter_cost">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="enter_cost" type="float" />
<description>
Sets the [code]enter_cost[/code] for this [code]link[/code].
</description>
</method>
<method name="link_set_map">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="map" type="RID" />
<description>
Sets the navigation map [RID] for the link.
</description>
</method>
<method name="link_set_navigation_layers">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="navigation_layers" type="int" />
<description>
Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer3D.map_get_path]).
</description>
</method>
<method name="link_set_owner_id">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="owner_id" type="int" />
<description>
Set the [code]ObjectID[/code] of the object which manages this link.
</description>
</method>
<method name="link_set_start_position">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="position" type="Vector3" />
<description>
Sets the entry position for this [code]link[/code].
</description>
</method>
<method name="link_set_travel_cost">
<return type="void" />
<argument index="0" name="link" type="RID" />
<argument index="1" name="travel_cost" type="float" />
<description>
Sets the [code]travel_cost[/code] for this [code]link[/code].
</description>
</method>
<method name="map_create">
<return type="RID" />
<description>
Create a new map.
</description>
</method>
<method name="map_force_update">
<return type="void" />
<argument index="0" name="map" type="RID" />
<description>
This function immediately forces synchronization of the specified navigation [code]map[/code] [RID]. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed).
Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update.
Avoidance processing and dispatch of the [code]safe_velocity[/code] signals is untouched by this function and continues to happen for all maps and agents at the end of the physics frame.
[b]Note:[/b] With great power comes great responsibility. This function should only be used by users that really know what they are doing and have a good reason for it. Forcing an immediate update of a navigation map requires locking the NavigationServer and flushing the entire NavigationServer command queue. Not only can this severely impact the performance of a game but it can also introduce bugs if used inappropriately without much foresight.
</description>
</method>
<method name="map_get_agents" qualifiers="const">
<return type="Array" />
<argument index="0" name="map" type="RID" />
<description>
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description>
</method>
<method name="map_get_cell_height" qualifiers="const">
<return type="float" />
<argument index="0" name="map" type="RID" />
<description>
Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis.
</description>
</method>
<method name="map_get_cell_size" qualifiers="const">
<return type="float" />
<argument index="0" name="map" type="RID" />
<description>
Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane.
</description>
</method>
<method name="map_get_closest_point" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="to_point" type="Vector3" />
<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_normal" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="to_point" type="Vector3" />
<description>
Returns the normal for the point returned by [method map_get_closest_point].
</description>
</method>
<method name="map_get_closest_point_owner" qualifiers="const">
<return type="RID" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="to_point" type="Vector3" />
<description>
Returns the owner region RID for the point returned by [method map_get_closest_point].
</description>
</method>
<method name="map_get_closest_point_to_segment" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="start" type="Vector3" />
<argument index="2" name="end" type="Vector3" />
<argument index="3" name="use_collision" type="bool" default="false" />
<description>
Returns the closest point between the navigation surface and the segment.
</description>
</method>
<method name="map_get_edge_connection_margin" qualifiers="const">
<return type="float" />
<argument index="0" name="map" type="RID" />
<description>
Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions.
</description>
</method>
<method name="map_get_link_connection_radius" qualifiers="const">
<return type="float" />
<argument index="0" name="map" type="RID" />
<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.
</description>
</method>
<method name="map_get_links" qualifiers="const">
<return type="Array" />
<argument index="0" name="map" type="RID" />
<description>
Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description>
</method>
<method name="map_get_obstacles" qualifiers="const">
<return type="Array" />
<argument index="0" name="map" type="RID" />
<description>
Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description>
</method>
<method name="map_get_path" qualifiers="const">
<return type="PoolVector3Array" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="origin" type="Vector3" />
<argument index="2" name="destination" type="Vector3" />
<argument index="3" name="optimize" type="bool" />
<argument index="4" name="navigation_layers" type="int" default="1" />
<description>
Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region layers that are allowed to be in the path.
</description>
</method>
<method name="map_get_regions" qualifiers="const">
<return type="Array" />
<argument index="0" name="map" type="RID" />
<description>
Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description>
</method>
<method name="map_get_up" qualifiers="const">
<return type="Vector3" />
<argument index="0" name="map" type="RID" />
<description>
Returns the map's up direction.
</description>
</method>
<method name="map_get_use_edge_connections" qualifiers="const">
<return type="bool" />
<argument index="0" name="map" type="RID" />
<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.
</description>
</method>
<method name="map_is_active" qualifiers="const">
<return type="bool" />
<argument index="0" name="map" type="RID" />
<description>
Returns [code]true[/code] if the map is active.
</description>
</method>
<method name="map_set_active">
<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_height">
<return type="void" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="cell_height" type="float" />
<description>
Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes.
</description>
</method>
<method name="map_set_cell_size">
<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">
<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="map_set_link_connection_radius">
<return type="void" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="radius" type="float" />
<description>
Set the map's link connection radius used to connect links to navigation polygons.
</description>
</method>
<method name="map_set_up">
<return type="void" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="up" type="Vector3" />
<description>
Sets the map up direction.
</description>
</method>
<method name="map_set_use_edge_connections">
<return type="void" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
Set the navigation [param map] edge connection use. If [param enabled] the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.
</description>
</method>
<method name="obstacle_create">
<return type="RID" />
<description>
Creates a new obstacle.
</description>
</method>
<method name="obstacle_get_avoidance_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the provided [param obstacle] has avoidance enabled.
</description>
</method>
<method name="obstacle_get_map" qualifiers="const">
<return type="RID" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns the navigation map [RID] the requested [param obstacle] is currently assigned to.
</description>
</method>
<method name="obstacle_get_paused" qualifiers="const">
<return type="bool" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the specified [param obstacle] is paused.
</description>
</method>
<method name="obstacle_get_use_3d_avoidance" qualifiers="const">
<return type="bool" />
<argument index="0" name="obstacle" type="RID" />
<description>
Returns [code]true[/code] if the provided [param obstacle] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z).
</description>
</method>
<method name="obstacle_set_avoidance_enabled">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] the provided [param obstacle] affects avoidance using agents.
</description>
</method>
<method name="obstacle_set_avoidance_layers">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="layers" type="int" />
<description>
Set the obstacles's [code]avoidance_layers[/code] bitmask.
</description>
</method>
<method name="obstacle_set_height">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="height" type="float" />
<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.
</description>
</method>
<method name="obstacle_set_map">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="map" type="RID" />
<description>
Assigns the [param obstacle] to a navigation map.
</description>
</method>
<method name="obstacle_set_paused">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="paused" type="bool" />
<description>
If [param paused] is true the specified [param obstacle] will not be processed, e.g. affect avoidance velocities.
</description>
</method>
<method name="obstacle_set_position">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="position" type="Vector3" />
<description>
Updates the [param position] in world space for the [param obstacle].
</description>
</method>
<method name="obstacle_set_radius">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="radius" type="float" />
<description>
Sets the radius of the dynamic obstacle.
</description>
</method>
<method name="obstacle_set_use_3d_avoidance">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
Sets if the [param obstacle] uses the 2D avoidance or the 3D avoidance while avoidance is enabled.
</description>
</method>
<method name="obstacle_set_velocity">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="velocity" type="Vector3" />
<description>
Sets [param velocity] of the dynamic [param obstacle]. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle.
</description>
</method>
<method name="obstacle_set_vertices">
<return type="void" />
<argument index="0" name="obstacle" type="RID" />
<argument index="1" name="vertices" type="PoolVector3Array" />
<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.
</description>
</method>
<method name="query_path" qualifiers="const">
<return type="void" />
<argument index="0" name="parameters" type="NavigationPathQueryParameters3D" />
<argument index="1" name="result" type="NavigationPathQueryResult3D" />
<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.
</description>
</method>
<method name="region_create">
<return type="RID" />
<description>
Creates a new region.
</description>
</method>
<method name="region_get_connection_pathway_end" qualifiers="const">
<return type="Vector3" />
<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="Vector3" />
<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" />
<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_enabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="region" type="RID" />
<description>
Returns [code]true[/code] if the specified [param region] is enabled.
</description>
</method>
<method name="region_get_enter_cost" qualifiers="const">
<return type="float" />
<argument index="0" name="region" type="RID" />
<description>
Returns the [code]enter_cost[/code] of this [code]region[/code].
</description>
</method>
<method name="region_get_map" qualifiers="const">
<return type="RID" />
<argument index="0" name="region" type="RID" />
<description>
Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
</description>
</method>
<method name="region_get_navigation_layers" qualifiers="const">
<return type="int" />
<argument index="0" name="region" type="RID" />
<description>
Returns the region's navigation layers.
</description>
</method>
<method name="region_get_owner_id" qualifiers="const">
<return type="int" />
<argument index="0" name="region" type="RID" />
<description>
Returns the [code]ObjectID[/code] of the object which manages this region.
</description>
</method>
<method name="region_get_travel_cost" qualifiers="const">
<return type="float" />
<argument index="0" name="region" type="RID" />
<description>
Returns the [code]travel_cost[/code] of this [code]region[/code].
</description>
</method>
<method name="region_get_use_edge_connections" qualifiers="const">
<return type="bool" />
<argument index="0" name="region" type="RID" />
<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.
</description>
</method>
<method name="region_owns_point" qualifiers="const">
<return type="bool" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="point" type="Vector3" />
<description>
Returns [code]true[/code] if the provided [code]point[/code] in world space is currently owned by the provided navigation [code]region[/code]. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region.
If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer.
[b]Note:[/b] If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.
</description>
</method>
<method name="region_set_enabled">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="enabled" type="bool" />
<description>
If [param enabled] is [code]true[/code] the specified [param region] will contribute to its current navigation map.
</description>
</method>
<method name="region_set_enter_cost">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="enter_cost" type="float" />
<description>
Sets the [code]enter_cost[/code] for this [code]region[/code].
</description>
</method>
<method name="region_set_map">
<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_navigation_layers">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="navigation_layers" type="int" />
<description>
Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer.map_get_path]).
</description>
</method>
<method name="region_set_navigation_mesh">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="navigation_mesh" type="NavigationMesh" />
<description>
Sets the navigation mesh for the region.
</description>
</method>
<method name="region_set_owner_id">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="owner_id" type="int" />
<description>
Set the [code]ObjectID[/code] of the object which manages this region.
</description>
</method>
<method name="region_set_transform">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="transform" type="Transform" />
<description>
Sets the global transformation for the region.
</description>
</method>
<method name="region_set_travel_cost">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="travel_cost" type="float" />
<description>
Sets the [code]travel_cost[/code] for this [code]region[/code].
</description>
</method>
<method name="region_set_use_edge_connections">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="enabled" type="bool" />
<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.
</description>
</method>
<method name="set_active">
<return type="void" />
<argument index="0" name="active" type="bool" />
<description>
Control activation of this server.
</description>
</method>
<method name="set_debug_enabled">
<return type="void" />
<argument index="0" name="enabled" type="bool" />
<description>
If [code]true[/code] enables debug mode on the NavigationServer.
</description>
</method>
</methods>
<signals>
<signal name="avoidance_debug_changed">
<description>
Emitted when avoidance debug settings are changed. Only available in debug builds.
</description>
</signal>
<signal name="map_changed">
<argument index="0" name="map" type="RID" />
<description>
Emitted when a navigation map is updated, when a region moves or is modified.
</description>
</signal>
<signal name="navigation_debug_changed">
<description>
Emitted when navigation debug settings are changed. Only available in debug builds.
</description>
</signal>
</signals>
<constants>
<constant name="INFO_ACTIVE_MAPS" value="0" enum="ProcessInfo">
Constant to get the number of active navigation maps.
</constant>
<constant name="INFO_REGION_COUNT" value="1" enum="ProcessInfo">
Constant to get the number of active navigation regions.
</constant>
<constant name="INFO_AGENT_COUNT" value="2" enum="ProcessInfo">
Constant to get the number of active navigation agents processing avoidance.
</constant>
<constant name="INFO_LINK_COUNT" value="3" enum="ProcessInfo">
Constant to get the number of active navigation links.
</constant>
<constant name="INFO_POLYGON_COUNT" value="4" enum="ProcessInfo">
Constant to get the number of navigation mesh polygons.
</constant>
<constant name="INFO_EDGE_COUNT" value="5" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges.
</constant>
<constant name="INFO_EDGE_MERGE_COUNT" value="6" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges that were merged due to edge key overlap.
</constant>
<constant name="INFO_EDGE_CONNECTION_COUNT" value="7" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges that are considered connected by edge proximity.
</constant>
<constant name="INFO_EDGE_FREE_COUNT" value="8" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges that could not be merged but may be still connected by edge proximity or with links.
</constant>
</constants>
</class>
Reference in New Issue View Git Blame Copy Permalink