From 39f46613bb9ac3f63ac740507a7e9c1d8981f2dd Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Fri, 19 Aug 2022 15:41:59 +0300 Subject: [PATCH] Backport fixes to documentation for paths, curves and navigation servers --- doc/classes/Curve2D.xml | 6 +++--- doc/classes/Curve3D.xml | 6 +++--- doc/classes/Line2D.xml | 20 ++++++++++---------- doc/classes/Navigation2DServer.xml | 2 +- doc/classes/NavigationServer.xml | 2 +- scene/2d/line_2d.cpp | 8 ++++---- scene/resources/curve.cpp | 4 ++-- servers/navigation_2d_server.cpp | 2 +- servers/navigation_server.cpp | 2 +- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 6c5911b5a27..9505025cc14 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -15,10 +15,10 @@ - + - Adds a point to a curve at [code]position[/code] relative to the [Curve2D]'s position, with control points [code]in[/code] and [code]out[/code]. - If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. + Adds a point with the specified [code]position[/code] relative to the curve's own position, with control points [code]in[/code] and [code]out[/code]. Appends the new point at the end of the point list. + If [code]index[/code] is given, the new point is inserted before the existing point identified by index [code]index[/code]. Every existing point starting from [code]index[/code] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [method get_point_count]. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index efbf3af5377..d4236c18942 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -15,10 +15,10 @@ - + - Adds a point to a curve at [code]position[/code] relative to the [Curve3D]'s position, with control points [code]in[/code] and [code]out[/code]. - If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. + Adds a point with the specified [code]position[/code] relative to the curve's own position, with control points [code]in[/code] and [code]out[/code]. Appends the new point at the end of the point list. + If [code]index[/code] is given, the new point is inserted before the existing point identified by index [code]index[/code]. Every existing point starting from [code]index[/code] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [method get_point_count]. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 669a248f125..cfa09d19f36 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -15,10 +15,10 @@ - + - Adds a point at the [code]position[/code]. Appends the point at the end of the line. - If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. + Adds a point with the specified [code]position[/code] relative to the line's own position. Appends the new point at the end of the point list. + If [code]index[/code] is given, the new point is inserted before the existing point identified by index [code]index[/code]. Every existing point starting from [code]index[/code] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [method get_point_count]. @@ -30,29 +30,29 @@ - Returns the Line2D's amount of points. + Returns the amount of points in the line. - + - Returns point [code]i[/code]'s position. + Returns the position of the point at index [code]index[/code]. - + - Removes the point at index [code]i[/code] from the line. + Removes the point at index [code]index[/code] from the line. - + - Overwrites the position in point [code]i[/code] with the supplied [code]position[/code]. + Overwrites the position of the point at index [code]index[/code] with the supplied [code]position[/code]. diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index 1b13e446a02..cbb60ee7a22 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -214,7 +214,7 @@ - + Returns [code]true[/code] if the map is active. diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index 62e2cb036a7..4637a33b536 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -238,7 +238,7 @@ - + Returns [code]true[/code] if the map is active. diff --git a/scene/2d/line_2d.cpp b/scene/2d/line_2d.cpp index 1535b679124..5985f70cb5f 100644 --- a/scene/2d/line_2d.cpp +++ b/scene/2d/line_2d.cpp @@ -355,13 +355,13 @@ void Line2D::_bind_methods() { ClassDB::bind_method(D_METHOD("set_points", "points"), &Line2D::set_points); ClassDB::bind_method(D_METHOD("get_points"), &Line2D::get_points); - ClassDB::bind_method(D_METHOD("set_point_position", "i", "position"), &Line2D::set_point_position); - ClassDB::bind_method(D_METHOD("get_point_position", "i"), &Line2D::get_point_position); + ClassDB::bind_method(D_METHOD("set_point_position", "index", "position"), &Line2D::set_point_position); + ClassDB::bind_method(D_METHOD("get_point_position", "index"), &Line2D::get_point_position); ClassDB::bind_method(D_METHOD("get_point_count"), &Line2D::get_point_count); - ClassDB::bind_method(D_METHOD("add_point", "position", "at_position"), &Line2D::add_point, DEFVAL(-1)); - ClassDB::bind_method(D_METHOD("remove_point", "i"), &Line2D::remove_point); + ClassDB::bind_method(D_METHOD("add_point", "position", "index"), &Line2D::add_point, DEFVAL(-1)); + ClassDB::bind_method(D_METHOD("remove_point", "index"), &Line2D::remove_point); ClassDB::bind_method(D_METHOD("clear_points"), &Line2D::clear_points); diff --git a/scene/resources/curve.cpp b/scene/resources/curve.cpp index e0c84d05d59..1c9de8b8b2f 100644 --- a/scene/resources/curve.cpp +++ b/scene/resources/curve.cpp @@ -962,7 +962,7 @@ PoolVector2Array Curve2D::tessellate(int p_max_stages, float p_tolerance) const void Curve2D::_bind_methods() { ClassDB::bind_method(D_METHOD("get_point_count"), &Curve2D::get_point_count); - ClassDB::bind_method(D_METHOD("add_point", "position", "in", "out", "at_position"), &Curve2D::add_point, DEFVAL(Vector2()), DEFVAL(Vector2()), DEFVAL(-1)); + ClassDB::bind_method(D_METHOD("add_point", "position", "in", "out", "index"), &Curve2D::add_point, DEFVAL(Vector2()), DEFVAL(Vector2()), DEFVAL(-1)); ClassDB::bind_method(D_METHOD("set_point_position", "idx", "position"), &Curve2D::set_point_position); ClassDB::bind_method(D_METHOD("get_point_position", "idx"), &Curve2D::get_point_position); ClassDB::bind_method(D_METHOD("set_point_in", "idx", "position"), &Curve2D::set_point_in); @@ -1626,7 +1626,7 @@ PoolVector3Array Curve3D::tessellate(int p_max_stages, float p_tolerance) const void Curve3D::_bind_methods() { ClassDB::bind_method(D_METHOD("get_point_count"), &Curve3D::get_point_count); - ClassDB::bind_method(D_METHOD("add_point", "position", "in", "out", "at_position"), &Curve3D::add_point, DEFVAL(Vector3()), DEFVAL(Vector3()), DEFVAL(-1)); + ClassDB::bind_method(D_METHOD("add_point", "position", "in", "out", "index"), &Curve3D::add_point, DEFVAL(Vector3()), DEFVAL(Vector3()), DEFVAL(-1)); ClassDB::bind_method(D_METHOD("set_point_position", "idx", "position"), &Curve3D::set_point_position); ClassDB::bind_method(D_METHOD("get_point_position", "idx"), &Curve3D::get_point_position); ClassDB::bind_method(D_METHOD("set_point_tilt", "idx", "tilt"), &Curve3D::set_point_tilt); diff --git a/servers/navigation_2d_server.cpp b/servers/navigation_2d_server.cpp index b35814f1959..074b92b46f0 100644 --- a/servers/navigation_2d_server.cpp +++ b/servers/navigation_2d_server.cpp @@ -175,7 +175,7 @@ void Navigation2DServer::_bind_methods() { ClassDB::bind_method(D_METHOD("map_create"), &Navigation2DServer::map_create); ClassDB::bind_method(D_METHOD("map_set_active", "map", "active"), &Navigation2DServer::map_set_active); - ClassDB::bind_method(D_METHOD("map_is_active", "nap"), &Navigation2DServer::map_is_active); + ClassDB::bind_method(D_METHOD("map_is_active", "map"), &Navigation2DServer::map_is_active); ClassDB::bind_method(D_METHOD("map_set_cell_size", "map", "cell_size"), &Navigation2DServer::map_set_cell_size); ClassDB::bind_method(D_METHOD("map_get_cell_size", "map"), &Navigation2DServer::map_get_cell_size); ClassDB::bind_method(D_METHOD("map_set_cell_height", "map", "cell_height"), &Navigation2DServer::map_set_cell_size); diff --git a/servers/navigation_server.cpp b/servers/navigation_server.cpp index 582fcb536b3..9a585450089 100644 --- a/servers/navigation_server.cpp +++ b/servers/navigation_server.cpp @@ -37,7 +37,7 @@ void NavigationServer::_bind_methods() { ClassDB::bind_method(D_METHOD("map_create"), &NavigationServer::map_create); ClassDB::bind_method(D_METHOD("map_set_active", "map", "active"), &NavigationServer::map_set_active); - ClassDB::bind_method(D_METHOD("map_is_active", "nap"), &NavigationServer::map_is_active); + ClassDB::bind_method(D_METHOD("map_is_active", "map"), &NavigationServer::map_is_active); ClassDB::bind_method(D_METHOD("map_set_up", "map", "up"), &NavigationServer::map_set_up); ClassDB::bind_method(D_METHOD("map_get_up", "map"), &NavigationServer::map_get_up); ClassDB::bind_method(D_METHOD("map_set_cell_size", "map", "cell_size"), &NavigationServer::map_set_cell_size);