Merge pull request #62187 from smix8/nav_nodes_depr_3.5

This commit is contained in:
Rémi Verschelde 2022-06-20 18:36:17 +02:00 committed by GitHub
commit 3c35617c50
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 18 additions and 0 deletions

View file

@ -4,6 +4,7 @@
Mesh-based navigation and pathfinding node. Mesh-based navigation and pathfinding node.
</brief_description> </brief_description>
<description> <description>
[i]Deprecated.[/i] [Navigation] node and [method get_simple_path] are deprecated and will be removed in a future version. Use [method NavigationServer.map_get_path] instead.
Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default, these will be automatically collected from child [NavigationMeshInstance] nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default, these will be automatically collected from child [NavigationMeshInstance] nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on.
</description> </description>
<tutorials> <tutorials>
@ -52,6 +53,7 @@
<argument index="1" name="end" type="Vector3" /> <argument index="1" name="end" type="Vector3" />
<argument index="2" name="optimize" type="bool" default="true" /> <argument index="2" name="optimize" type="bool" default="true" />
<description> <description>
[i]Deprecated.[/i] [Navigation] node and [method get_simple_path] are deprecated and will be removed in a future version. Use [method NavigationServer.map_get_path] instead.
Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored.
</description> </description>
</method> </method>

View file

@ -4,6 +4,7 @@
2D navigation and pathfinding node. 2D navigation and pathfinding node.
</brief_description> </brief_description>
<description> <description>
[i]Deprecated.[/i] [Navigation2D] node and [method get_simple_path] are deprecated and will be removed in a future version. Use [method Navigation2DServer.map_get_path] instead.
Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default, these are automatically collected from child [NavigationPolygonInstance] nodes. Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default, these are automatically collected from child [NavigationPolygonInstance] nodes.
</description> </description>
<tutorials> <tutorials>
@ -36,6 +37,7 @@
<argument index="1" name="end" type="Vector2" /> <argument index="1" name="end" type="Vector2" />
<argument index="2" name="optimize" type="bool" default="true" /> <argument index="2" name="optimize" type="bool" default="true" />
<description> <description>
[i]Deprecated.[/i] [Navigation2D] node and [method get_simple_path] are deprecated and will be removed in a future version. Use [method Navigation2DServer.map_get_path] instead.
Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible.
</description> </description>
</method> </method>

View file

@ -78,9 +78,14 @@ void Navigation2D::set_edge_connection_margin(float p_edge_connection_margin) {
} }
Vector<Vector2> Navigation2D::get_simple_path(const Vector2 &p_start, const Vector2 &p_end, bool p_optimize) const { Vector<Vector2> Navigation2D::get_simple_path(const Vector2 &p_start, const Vector2 &p_end, bool p_optimize) const {
WARN_DEPRECATED_MSG("'Navigation2D' node and 'Navigation2D.get_simple_path()' are deprecated and will be removed in a future version. Use 'Navigation2DServer.map_get_path()' instead.");
return Navigation2DServer::get_singleton()->map_get_path(map, p_start, p_end, p_optimize, navigation_layers); return Navigation2DServer::get_singleton()->map_get_path(map, p_start, p_end, p_optimize, navigation_layers);
} }
String Navigation2D::get_configuration_warning() const {
return TTR("'Navigation2D' node and 'Navigation2D.get_simple_path()' are deprecated and will be removed in a future version. Use 'Navigation2DServer.map_get_path()' instead.");
}
Vector2 Navigation2D::get_closest_point(const Vector2 &p_point) const { Vector2 Navigation2D::get_closest_point(const Vector2 &p_point) const {
return Navigation2DServer::get_singleton()->map_get_closest_point(map, p_point); return Navigation2DServer::get_singleton()->map_get_closest_point(map, p_point);
} }

View file

@ -68,6 +68,8 @@ public:
Vector2 get_closest_point(const Vector2 &p_point) const; Vector2 get_closest_point(const Vector2 &p_point) const;
RID get_closest_point_owner(const Vector2 &p_point) const; RID get_closest_point_owner(const Vector2 &p_point) const;
virtual String get_configuration_warning() const;
Navigation2D(); Navigation2D();
~Navigation2D(); ~Navigation2D();
}; };

View file

@ -33,9 +33,14 @@
#include "servers/navigation_server.h" #include "servers/navigation_server.h"
Vector<Vector3> Navigation::get_simple_path(const Vector3 &p_start, const Vector3 &p_end, bool p_optimize) const { Vector<Vector3> Navigation::get_simple_path(const Vector3 &p_start, const Vector3 &p_end, bool p_optimize) const {
WARN_DEPRECATED_MSG("'Navigation' node and 'Navigation.get_simple_path()' are deprecated and will be removed in a future version. Use 'NavigationServer.map_get_path()' instead.");
return NavigationServer::get_singleton()->map_get_path(map, p_start, p_end, p_optimize, navigation_layers); return NavigationServer::get_singleton()->map_get_path(map, p_start, p_end, p_optimize, navigation_layers);
} }
String Navigation::get_configuration_warning() const {
return TTR("'Navigation' node and 'Navigation.get_simple_path()' are deprecated and will be removed in a future version. Use 'NavigationServer.map_get_path()' instead.");
}
Vector3 Navigation::get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, bool p_use_collision) const { Vector3 Navigation::get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, bool p_use_collision) const {
return NavigationServer::get_singleton()->map_get_closest_point_to_segment(map, p_from, p_to, p_use_collision); return NavigationServer::get_singleton()->map_get_closest_point_to_segment(map, p_from, p_to, p_use_collision);
} }

View file

@ -82,6 +82,8 @@ public:
Vector3 get_closest_point_normal(const Vector3 &p_point) const; Vector3 get_closest_point_normal(const Vector3 &p_point) const;
RID get_closest_point_owner(const Vector3 &p_point) const; RID get_closest_point_owner(const Vector3 &p_point) const;
virtual String get_configuration_warning() const;
Navigation(); Navigation();
~Navigation(); ~Navigation();
}; };