summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationAgent3D.xml
diff options
context:
space:
mode:
authorsmix8 <52464204+smix8@users.noreply.github.com>2023-02-13 13:18:13 +0100
committersmix8 <52464204+smix8@users.noreply.github.com>2023-02-14 21:56:58 +0100
commitd87f1247689ae82996aeac77b6e9870bbc88142d (patch)
tree7eedfbb1198425a20a9fd311e80299f4b6389ed3 /doc/classes/NavigationAgent3D.xml
parentb7723a01d957e6492a3f20bce8a47d3559afe5c5 (diff)
Add NavigationLink helper functions for global positions
Adds helper functions to set the links start and end position with global positions or get them as global positions. Adds global start and end position for the navigation link to the 'link_reached' signal of NavigationAgent. That signal gets emitted when a navigation link waypoint is reached. Requires that 'owner' meta data is enabled on the NavigationAgent.
Diffstat (limited to 'doc/classes/NavigationAgent3D.xml')
-rw-r--r--doc/classes/NavigationAgent3D.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml
index 0ed11bc477..294fe49408 100644
--- a/doc/classes/NavigationAgent3D.xml
+++ b/doc/classes/NavigationAgent3D.xml
@@ -174,6 +174,8 @@
- [code]type[/code]: Always [constant NavigationPathQueryResult3D.PATH_SEGMENT_TYPE_LINK].
- [code]rid[/code]: The [RID] of the link.
- [code]owner[/code]: The object which manages the link (usually [NavigationLink3D]).
+ - [code]link_entry_position[/code]: If [code]owner[/code] is available and the owner is a [NavigationLink2D], it will contain the global position of the link's point the agent is entering.
+ - [code]link_exit_position[/code]: If [code]owner[/code] is available and the owner is a [NavigationLink2D], it will contain the global position of the link's point which the agent is exiting.
</description>
</signal>
<signal name="navigation_finished">