From ca750fb7bca0211b02bdbf292d98c958ea00631e Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Mon, 23 Nov 2015 13:57:57 +0200 Subject: Update doc with -doctool. --- doc/base/classes.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 44a7cccfe5..2e7bde6549 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -4371,7 +4371,7 @@ Stop a given voice. - + -- cgit v1.2.3 From 4359a90ccab188675aa00f62dcf67411a6d1ff1e Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Mon, 23 Nov 2015 14:18:13 +0200 Subject: Document Vector3 and Vector3Array. Fix documentation of Vector2 and Vector2Array. --- doc/base/classes.xml | 46 +++++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 2e7bde6549..a26458a14f 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -37623,7 +37623,7 @@ This method controls whether the position between two cached points is interpola - Reflects/mirrors the vector around another vector. + Like "slide", but reflects the Vector instead of continuing along the wall. @@ -37687,10 +37687,10 @@ This method controls whether the position between two cached points is interpola - An Array of Vector2's. + An Array of Vector2. - An Array specifically designed to hold Vector2's. + An Array specifically designed to hold Vector2. @@ -37699,21 +37699,21 @@ This method controls whether the position between two cached points is interpola - Get the Vector2 at the given index. + Returns the Vector2 at the given index. - Insert a new Vector2. + Inserts a Vector2 at the end. - Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Sets the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -37722,7 +37722,7 @@ This method controls whether the position between two cached points is interpola - Set the Vector2 at the given index. + Changes the Vector2 at the given index. @@ -37757,12 +37757,14 @@ This method controls whether the position between two cached points is interpola + Returns a new vector with all components in absolute values (e.g. positive). + Returns a new vector with all components rounded up. @@ -37786,7 +37788,7 @@ This method controls whether the position between two cached points is interpola - Perform a cubic interpolation between vectors a,b,c,d (b is current), by the given amount (i). + Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). @@ -37795,7 +37797,7 @@ This method controls whether the position between two cached points is interpola - Return the squared distance (distance minus the last square root) to b. + Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. @@ -37820,13 +37822,14 @@ This method controls whether the position between two cached points is interpola + Returns a new vector with all components rounded down. - Returns the inverse of the vector. this is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) + Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) @@ -37840,7 +37843,7 @@ This method controls whether the position between two cached points is interpola - Return the length of the vector, squared. + Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. @@ -37851,26 +37854,28 @@ This method controls whether the position between two cached points is interpola - Linearly interpolates the vector to a given one (b), by the given amount (i). + Linearly interpolates the vector to a given one (b), by the given amount (t). + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. - Return a copy of the normalized vector to unit length. This is the same as v / v.length() + Return a copy of the normalized vector to unit length. This is the same as v / v.length(). @@ -37879,6 +37884,7 @@ This method controls whether the position between two cached points is interpola + Like "slide", but reflects the Vector instead of continuing along the wall. @@ -37889,6 +37895,7 @@ This method controls whether the position between two cached points is interpola + Rotates the vector around some axis by phi radians. @@ -37897,6 +37904,7 @@ This method controls whether the position between two cached points is interpola + Slides the vector along a wall. @@ -37918,6 +37926,7 @@ This method controls whether the position between two cached points is interpola + Returns a Vector3 with the given components. @@ -37931,17 +37940,22 @@ This method controls whether the position between two cached points is interpola + Enumerated value for the X axis. Returned by functions like max_axis or min_axis. + Enumerated value for the Y axis. + Enumerated value for the Z axis. + An Array of Vector3. + An Array specifically designed to hold Vector3. @@ -37950,18 +37964,21 @@ This method controls whether the position between two cached points is interpola + Returns the Vector3 at the given index. + Inserts a Vector3 at the end. + Sets the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. @@ -37970,12 +37987,14 @@ This method controls whether the position between two cached points is interpola + Changes the Vector3 at the given index. + Returns the size of the array. @@ -37984,6 +38003,7 @@ This method controls whether the position between two cached points is interpola + Constructs a new Vector3Array. Optionally, you can pass in an Array that will be converted. -- cgit v1.2.3