Browse Source

Merge pull request #15423 from agmcleod/master

Documentation interpolation functions - Indicate what "t" means in interpolation docs
Rémi Verschelde 7 years ago
parent
commit
b5b2ca8143
2 changed files with 4 additions and 4 deletions
  1. 2 2
      doc/classes/Vector2.xml
  2. 2 2
      doc/classes/Vector3.xml

+ 2 - 2
doc/classes/Vector2.xml

@@ -92,7 +92,7 @@
 			<argument index="3" name="t" type="float">
 			</argument>
 			<description>
-				Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t".
+				Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
 			</description>
 		</method>
 		<method name="distance_squared_to">
@@ -158,7 +158,7 @@
 			<argument index="1" name="t" type="float">
 			</argument>
 			<description>
-				Returns the result of the linear interpolation between this vector and "b", by amount "t".
+				Returns the result of the linear interpolation between this vector and "b", by amount "t". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
 			</description>
 		</method>
 		<method name="normalized">

+ 2 - 2
doc/classes/Vector3.xml

@@ -77,7 +77,7 @@
 			<argument index="3" name="t" type="float">
 			</argument>
 			<description>
-				Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount (t).
+				Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
 			</description>
 		</method>
 		<method name="distance_squared_to">
@@ -150,7 +150,7 @@
 			<argument index="1" name="t" type="float">
 			</argument>
 			<description>
-				Linearly interpolates the vector to a given one (b), by the given amount (t).
+				Linearly interpolates the vector to a given one (b), by the given amount (t). (t) should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
 			</description>
 		</method>
 		<method name="max_axis">