summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-03-11 19:50:36 +0100
committerGitHub <noreply@github.com>2022-03-11 19:50:36 +0100
commitf94ada39b35bfc2c313528bed23112b74cf4c97a (patch)
tree2e58a30472467cd50f660020c138f53985ee8739 /doc/classes
parentef347d03d17b2446b4da4d480af0e6ec96d30c13 (diff)
parent35c8d332b539b034cb325394e2a5c70623403916 (diff)
Merge pull request #59036 from Calinou/doc-curve-add-point
Clarify the position of points in `Curve{2D,3D}.add_point()`
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Curve2D.xml2
-rw-r--r--doc/classes/Curve3D.xml2
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml
index f040d292e9..94e52912a1 100644
--- a/doc/classes/Curve2D.xml
+++ b/doc/classes/Curve2D.xml
@@ -17,7 +17,7 @@
<argument index="2" name="out" type="Vector2" default="Vector2(0, 0)" />
<argument index="3" name="at_position" type="int" default="-1" />
<description>
- Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
+ 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 &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
</description>
</method>
diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml
index 27856f2564..ed642e0ddc 100644
--- a/doc/classes/Curve3D.xml
+++ b/doc/classes/Curve3D.xml
@@ -17,7 +17,7 @@
<argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)" />
<argument index="3" name="at_position" type="int" default="-1" />
<description>
- Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
+ 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 &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
</description>
</method>