godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/NavigationServer3D.xml

377 lines
12 KiB
XML
Raw Normal View History

Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 16:22:57 +00:00
<class name="NavigationServer3D" inherits="Object" version="4.0">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<brief_description>
Server interface for low-level 3D navigation access
</brief_description>
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 16:22:57 +00:00
NavigationServer3D is the server responsible for all 3D navigation. It creates the agents, maps, and regions for navigation to work as expected. This 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.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="3D Navmesh Demo">https://godotengine.org/asset-library/asset/124</link>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</tutorials>
<methods>
<method name="agent_create" qualifiers="const">
<return type="RID">
</return>
<description>
Creates the agent.
</description>
</method>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<method name="agent_is_map_changed" qualifiers="const">
<return type="bool">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</return>
<argument index="0" name="agent" type="RID">
</argument>
<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>
doc: Sync classref with StringName/Callable changes
2020-02-22 13:59:09 +00:00
<argument index="2" name="method" type="StringName">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>
<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>
<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>
<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>
<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>
<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="Vector3">
</argument>
<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>
<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="Vector3">
</argument>
<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>
<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="Vector3">
</argument>
<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>
<description>
Destroy the RID
</description>
</method>
<method name="map_create" qualifiers="const">
<return type="RID">
</return>
<description>
Create a new map.
</description>
</method>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<method name="map_get_cell_size" qualifiers="const">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<return type="float">
</return>
<argument index="0" name="map" type="RID">
</argument>
<description>
Returns the map cell size.
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_closest_point" qualifiers="const">
<return type="Vector3">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</return>
<argument index="0" name="map" type="RID">
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="1" name="to_point" type="Vector3">
</argument>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
Returns the point closest to the provided [code]point[/code] on the navigation mesh surface.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_closest_point_normal" qualifiers="const">
<return type="Vector3">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</return>
<argument index="0" name="map" type="RID">
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="1" name="to_point" type="Vector3">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<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">
</return>
<argument index="0" name="map" type="RID">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="1" name="to_point" type="Vector3">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</argument>
<description>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
Returns the owner region RID for the point returned by [method map_get_closest_point].
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
<method name="map_get_closest_point_to_segment" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="map" type="RID">
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="1" name="start" type="Vector3">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="2" name="end" type="Vector3">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</argument>
<argument index="3" name="use_collision" type="bool" default="false">
</argument>
<description>
Returns the closest point between the navigation surface and the segment.
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_edge_connection_margin" qualifiers="const">
<return type="float">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</return>
<argument index="0" name="map" type="RID">
</argument>
<description>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
Returns the edge connection margin of the map.
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_path" qualifiers="const">
<return type="PackedVector3Array">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</return>
<argument index="0" name="map" type="RID">
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="1" name="origin" type="Vector3">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="2" name="destination" type="Vector3">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</argument>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<argument index="3" name="optimize" type="bool">
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</argument>
<description>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
Returns the navigation path to reach the destination from the origin.
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</description>
</method>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<method name="map_get_up" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="map" type="RID">
</argument>
<description>
Returns the map's up direction.
</description>
</method>
<method name="map_is_active" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<argument index="0" name="nap" type="RID">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</argument>
<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>
<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>
<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>
<description>
Set the map edge connection margein used to weld the compatible region edges.
</description>
</method>
<method name="map_set_up" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="map" type="RID">
</argument>
<argument index="1" name="up" type="Vector3">
</argument>
<description>
Sets the map up direction.
</description>
</method>
doc: Sync classref with current source
2020-02-29 13:22:57 +00:00
<method name="process">
<return type="void">
</return>
<argument index="0" name="delta_time" type="float">
</argument>
<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.
Note: This function is not thread safe.
</description>
</method>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<method name="region_bake_navmesh" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="mesh" type="NavigationMesh">
</argument>
<argument index="1" name="node" type="Node">
</argument>
<description>
Bakes the navigation mesh.
</description>
</method>
<method name="region_create" qualifiers="const">
<return type="RID">
</return>
<description>
Creates a new region.
</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>
<description>
Sets the map for the region.
</description>
</method>
<method name="region_set_navmesh" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="region" type="RID">
</argument>
<argument index="1" name="nav_mesh" type="NavigationMesh">
</argument>
<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="Transform">
</argument>
<description>
Sets the global transformation for the region.
</description>
</method>
<method name="set_active" qualifiers="const">
<return type="void">
</return>
<argument index="0" name="active" type="bool">
</argument>
<description>
Control activation of this server.
</description>
</method>
</methods>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<constants>
</constants>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</class>