diff options
| author | smix8 <52464204+smix8@users.noreply.github.com> | 2023-02-13 13:18:13 +0100 |
|---|---|---|
| committer | smix8 <52464204+smix8@users.noreply.github.com> | 2023-02-14 21:56:58 +0100 |
| commit | d87f1247689ae82996aeac77b6e9870bbc88142d (patch) | |
| tree | 7eedfbb1198425a20a9fd311e80299f4b6389ed3 /doc/classes/NavigationLink2D.xml | |
| parent | b7723a01d957e6492a3f20bce8a47d3559afe5c5 (diff) | |
| download | redot-engine-d87f1247689ae82996aeac77b6e9870bbc88142d.tar.gz | |
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/NavigationLink2D.xml')
| -rw-r--r-- | doc/classes/NavigationLink2D.xml | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/classes/NavigationLink2D.xml b/doc/classes/NavigationLink2D.xml index b3f4367675..3f5b1fb184 100644 --- a/doc/classes/NavigationLink2D.xml +++ b/doc/classes/NavigationLink2D.xml @@ -10,6 +10,18 @@ <link title="Using NavigationLinks">$DOCS_URL/tutorials/navigation/navigation_using_navigationlinks.html</link> </tutorials> <methods> + <method name="get_global_end_position" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the [member end_position] that is relative to the link as a global position. + </description> + </method> + <method name="get_global_start_position" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the [member start_position] that is relative to the link as a global position. + </description> + </method> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> <param index="0" name="layer_number" type="int" /> @@ -17,6 +29,20 @@ Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [code]layer_number[/code] between 1 and 32. </description> </method> + <method name="set_global_end_position"> + <return type="void" /> + <param index="0" name="position" type="Vector2" /> + <description> + Sets the [member end_position] that is relative to the link from a global [param position]. + </description> + </method> + <method name="set_global_start_position"> + <return type="void" /> + <param index="0" name="position" type="Vector2" /> + <description> + Sets the [member start_position] that is relative to the link from a global [param position]. + </description> + </method> <method name="set_navigation_layer_value"> <return type="void" /> <param index="0" name="layer_number" type="int" /> |