summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Roden-Corrent <ryan@rcorre.net>2021-02-28 07:18:34 -0500
committerRyan Roden-Corrent <ryan@rcorre.net>2021-02-28 07:18:34 -0500
commitef5042a70f9d9ef1ac8292fc2a00a1560eecd182 (patch)
treef96eab01e4f16933effe98f9ab28ee7bd5782a99
parent8faecd6a470aeef41084a32d74f4a131a5ef42b6 (diff)
Clarify Curve.get_closest_point uses baked points.
Based on the doc, I wasn't sure if get_closest_point would return the closest baked point or the closest "source" point. It seems to use baked: https://github.com/godotengine/godot/blob/8faecd6a470aeef41084a32d74f4a131a5ef42b6/scene/resources/curve.cpp#L809
-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 2d50d98a74..b33f3b4ffc 100644
--- a/doc/classes/Curve2D.xml
+++ b/doc/classes/Curve2D.xml
@@ -63,7 +63,7 @@
<argument index="0" name="to_point" type="Vector2">
</argument>
<description>
- Returns the closest point (in curve's local space) to [code]to_point[/code].
+ Returns the closest baked point (in curve's local space) to [code]to_point[/code].
[code]to_point[/code] must be in this curve's local space.
</description>
</method>
diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml
index bda04f010b..fcd150ad57 100644
--- a/doc/classes/Curve3D.xml
+++ b/doc/classes/Curve3D.xml
@@ -78,7 +78,7 @@
<argument index="0" name="to_point" type="Vector3">
</argument>
<description>
- Returns the closest point (in curve's local space) to [code]to_point[/code].
+ Returns the closest baked point (in curve's local space) to [code]to_point[/code].
[code]to_point[/code] must be in this curve's local space.
</description>
</method>