Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-23 12:26:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Backported from godot4: Add detail to NavigationAgent signal descriptions

Browse Source 
Adds detail to NavigationAgent signal descriptions.
- smix8
99e70ab6ef
This commit is contained in:
Relintai 2023-09-04 17:55:11 +02:00
parent e3f2ee62ca
commit 493af67f7a
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/classes/NavigationAgent.xml
View File

@ -51,7 +51,7 @@
<method name="get_final_position"> <method name="get_final_position">
<return type="Vector3" /> <return type="Vector3" />
<description> <description>
Returns the reachable final position of the current navigation path in global coordinates. This position can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame. Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the [signal path_changed] signal.
</description> </description>
</method> </method>
<method name="get_navigation" qualifiers="const"> <method name="get_navigation" qualifiers="const">
@ -88,13 +88,14 @@
<method name="is_navigation_finished"> <method name="is_navigation_finished">
<return type="bool" /> <return type="bool" />
<description> <description>
Returns [code]true[/code] if the navigation path's final position has been reached. Returns [code]true[/code] if the end of the currently loaded navigation path has been reached.
[b]Note:[/b] While true prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
</description> </description>
</method> </method>
<method name="is_target_reachable"> <method name="is_target_reachable">
<return type="bool" /> <return type="bool" />
<description> <description>
Returns true if [member target_position] is reachable. The target position is set using [member target_position]. Returns [code]true[/code] if [method get_final_position] is within [member target_desired_distance] of the [member target_position].
</description> </description>
</method> </method>
<method name="is_target_reached" qualifiers="const"> <method name="is_target_reached" qualifiers="const">
@ -247,17 +248,20 @@
</signal> </signal>
<signal name="navigation_finished"> <signal name="navigation_finished">
<description> <description>
Notifies when the final position is reached. Emitted once per loaded path when the agent internal navigation path index reaches the last index of the loaded path array. The agent internal navigation path index can be received with [method get_current_navigation_path_index].
</description> </description>
</signal> </signal>
<signal name="path_changed"> <signal name="path_changed">
<description> <description>
Notifies when the navigation path changes. This can be triggered by the navigation system or by the user changing the path. Emitted when the agent had to update the loaded path:
- because path was previously empty.
- because navigation map has changed.
- because agent pushed further away from the current path segment than the [member path_max_distance].
</description> </description>
</signal> </signal>
<signal name="target_reached"> <signal name="target_reached">
<description> <description>
Notifies when the player-defined [member target_position] is reached. Emitted once per loaded path when the agent's global position is the first time within [member target_desired_distance] to the [member target_position].
</description> </description>
</signal> </signal>
<signal name="velocity_computed"> <signal name="velocity_computed">