diff options
author | Yuri Sizov <yuris@humnom.net> | 2022-08-15 17:31:23 +0300 |
---|---|---|
committer | Yuri Sizov <yuris@humnom.net> | 2022-08-15 21:38:14 +0300 |
commit | fff0e7b8e204bf13c7e8c1cd9e61eded9ccc0891 (patch) | |
tree | 69c9614a6e9ccc3279f91ea4a506bb1e6d615109 /doc/classes/Curve2D.xml | |
parent | 4426049c64d90e07b23e36e02ad3db2ac5540ac4 (diff) |
Clarify the Line2D, Curve2D/3D documentation and fix parameter names
Diffstat (limited to 'doc/classes/Curve2D.xml')
-rw-r--r-- | doc/classes/Curve2D.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 01a011021f..f15c0d74ca 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -15,10 +15,10 @@ <param index="0" name="position" type="Vector2" /> <param index="1" name="in" type="Vector2" default="Vector2(0, 0)" /> <param index="2" name="out" type="Vector2" default="Vector2(0, 0)" /> - <param index="3" name="at_position" type="int" default="-1" /> + <param index="3" name="index" type="int" default="-1" /> <description> - Adds a point to a curve at [param position] relative to the [Curve2D]'s position, with control points [param in] and [param out]. - If [param at_position] is given, the point is inserted before the point number [param at_position], moving that point (and every point after) after the inserted point. If [param at_position] 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 [param position] relative to the curve's own position, with control points [param in] and [param out]. Appends the new point at the end of the point list. + If [param index] is given, the new point is inserted before the existing point identified by index [param index]. Every existing point starting from [param index] 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 [member point_count]. </description> </method> <method name="clear_points"> |