diff options
| author | Gilles Roudière <gilles.roudiere@gmail.com> | 2021-03-15 12:45:28 +0100 |
|---|---|---|
| committer | Gilles Roudière <gilles.roudiere@gmail.com> | 2021-03-15 15:58:59 +0100 |
| commit | ac7073f58655094d08daf59e3b1b36946c5ee02b (patch) | |
| tree | f536b050c4b026fb4aa87c1ddce5f66bc26a2ce0 /doc | |
| parent | 6eef187a81cbdd3cd314776de372e753f79f9831 (diff) | |
Allow Navigation to be more flexible
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/NavigationServer2D.xml | 40 | ||||
| -rw-r--r-- | doc/classes/NavigationServer3D.xml | 40 |
2 files changed, 80 insertions, 0 deletions
diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 4f34a8a424..b811607bad 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -267,6 +267,37 @@ Creates a new region. </description> </method> + <method name="region_get_connection_pathway_end" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connection_pathway_start" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connections_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <description> + Returns how many connections this [code]region[/code] has with other regions in the map. + </description> + </method> <method name="region_get_layers" qualifiers="const"> <return type="int"> </return> @@ -321,6 +352,15 @@ </description> </method> </methods> + <signals> + <signal name="map_changed"> + <argument index="0" name="map" type="RID"> + </argument> + <description> + Emitted when a navigation map is updated, when a region moves or is modified. + </description> + </signal> + </signals> <constants> </constants> </class> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 0653c0d27d..6d56428933 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -335,6 +335,37 @@ Creates a new region. </description> </method> + <method name="region_get_connection_pathway_end" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connection_pathway_start" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <argument index="1" name="connection" type="int"> + </argument> + <description> + Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count]. + </description> + </method> + <method name="region_get_connections_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="region" type="RID"> + </argument> + <description> + Returns how many connections this [code]region[/code] has with other regions in the map. + </description> + </method> <method name="region_get_layers" qualifiers="const"> <return type="int"> </return> @@ -398,6 +429,15 @@ </description> </method> </methods> + <signals> + <signal name="map_changed"> + <argument index="0" name="map" type="RID"> + </argument> + <description> + Emitted when a navigation map is updated, when a region moves or is modified. + </description> + </signal> + </signals> <constants> </constants> </class> |