pandemonium_engine/doc/classes/NavigationServer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NavigationServer" inherits="Object" version="3.5">
	<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.
		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://godotengine.org/asset-library/asset/124</link>
	</tutorials>
	<methods>
		<method name="agent_create" qualifiers="const">
			<return type="RID" />
			<description>
				Creates the agent.
			</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_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_callback" qualifiers="const">
			<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>
			</description>
		</method>
		<method name="agent_set_map" qualifiers="const">
			<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" />
			<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" />
			<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" />
			<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" />
			<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" qualifiers="const">
			<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" />
			<argument index="0" name="agent" type="RID" />
			<argument index="1" name="target_velocity" type="Vector3" />
			<description>
				Sets the new target velocity.
			</description>
		</method>
		<method name="agent_set_time_horizon" qualifiers="const">
			<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" />
			<argument index="0" name="agent" type="RID" />
			<argument index="1" name="velocity" type="Vector3" />
			<description>
				Sets the current velocity of the agent.
			</description>
		</method>
		<method name="free_rid" qualifiers="const">
			<return type="void" />
			<argument index="0" name="rid" type="RID" />
			<description>
				Destroys the given RID.
			</description>
		</method>
		<method name="map_create" qualifiers="const">
			<return type="RID" />
			<description>
				Create a new map.
			</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.
			</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.
			</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_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" />
			<description>
				Returns the navigation path to reach the destination from the origin.
			</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_is_active" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="nap" type="RID" />
			<description>
				Returns [code]true[/code] if the map is active.
			</description>
		</method>
		<method name="map_set_active" qualifiers="const">
			<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" qualifiers="const">
			<return type="void" />
			<argument index="0" name="map" type="RID" />
			<argument index="1" name="cell_height" type="float" />
			<description>
				Set the map cell height used to weld the navigation mesh polygons.
			</description>
		</method>
		<method name="map_set_cell_size" qualifiers="const">
			<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" />
			<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_up" qualifiers="const">
			<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="process">
			<return type="void" />
			<argument index="0" name="delta_time" type="float" />
			<description>
				Process the collision avoidance agents.
				The result of this process is needed by the physics server, so this must be called in the main thread.
				[b]Note:[/b] This function is not thread safe.
			</description>
		</method>
		<method name="region_bake_navmesh" qualifiers="const">
			<return type="void" />
			<argument index="0" name="mesh" type="NavigationMesh" />
			<argument index="1" name="node" type="Node" />
			<description>
				Bakes the navigation mesh.
			</description>
		</method>
		<method name="region_create" qualifiers="const">
			<return type="RID" />
			<description>
				Creates a new region.
			</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_set_map" qualifiers="const">
			<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_navmesh" qualifiers="const">
			<return type="void" />
			<argument index="0" name="region" type="RID" />
			<argument index="1" name="nav_mesh" type="NavigationMesh" />
			<description>
				Sets the navigation mesh for the region.
			</description>
		</method>
		<method name="region_set_transform" qualifiers="const">
			<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="set_active" qualifiers="const">
			<return type="void" />
			<argument index="0" name="active" type="bool" />
			<description>
				Control activation of this server.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>