diff options
| author | VolTer <mew.pur.pur@abv.bg> | 2023-04-28 22:59:03 +0200 |
|---|---|---|
| committer | VolTer <mew.pur.pur@abv.bg> | 2023-05-20 03:25:26 +0200 |
| commit | e3d0da404fd46bef48a816e27897c81140d46aa9 (patch) | |
| tree | 2dac4b85467d0b9f7ea9967736a7322a3c8e4647 /doc/classes/NavigationAgent3D.xml | |
| parent | c80a2b4fe99dcd0bba6fc24ed2748b1474b24448 (diff) | |
| download | redot-engine-e3d0da404fd46bef48a816e27897c81140d46aa9.tar.gz | |
Overhaul the top sections of the class reference (Physics classes)
Diffstat (limited to 'doc/classes/NavigationAgent3D.xml')
| -rw-r--r-- | doc/classes/NavigationAgent3D.xml | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index 00ef894378..6dc1b4ec36 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -1,11 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="NavigationAgent3D" inherits="Node" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - 3D Agent used in navigation for collision avoidance. + A 3D agent used to pathfind to a position while avoiding obstacles. </brief_description> <description> - 3D Agent that is used in navigation to reach a position while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO collision avoidance. The agent needs navigation data to work correctly. [NavigationAgent3D] is physics safe. - [b]Note:[/b] After [member target_position] is set, the [method get_next_path_position] function must be used once every physics frame to update the internal path logic of the NavigationAgent. The returned position from this function should be used as the next movement position for the agent's parent node. + A 3D agent used to pathfind to a position while avoiding static and dynamic obstacles. The calculation can be used by the parent node to dynamically move it along the path. Requires navigation data to work correctly. + Dynamic obstacles are avoided using RVO collision avoidance. Avoidance is computed before physics, so the pathfinding information can be used safely in the physics step. + [b]Note:[/b] After setting the [member target_position] property, the [method get_next_path_position] method must be used once every physics frame to update the internal path logic of the navigation agent. The vector position it returns should be used as the next movement position for the agent's parent node. </description> <tutorials> <link title="Using NavigationAgents">$DOCS_URL/tutorials/navigation/navigation_using_navigationagents.html</link> |