Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)).
Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)).
Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector.
Equivalent to the result of atan2 when called with the vector's x and y as parameters: [code]atan2(x, y)[/code].
</description>
</method>
<methodname="angle_to">
...
...
@@ -60,7 +60,7 @@
<returntype="float">
</return>
<description>
Returns the ratio of X to Y.
Returns the ratio of x to y.
</description>
</method>
<methodname="bounce">
...
...
@@ -69,7 +69,7 @@
<argumentindex="0"name="n"type="Vector2">
</argument>
<description>
Bounce returns the vector "bounced off" from the given plane, specified by its normal vector.
Returns the vector "bounced off" from a plane defined by the given normal.
</description>
</method>
<methodname="ceil">
...
...
@@ -93,7 +93,7 @@
<argumentindex="0"name="with"type="Vector2">
</argument>
<description>
Returns the 2-dimensional analog of the cross product with the given Vector2.
Returns the 2 dimensional analog of the cross product with the given vector.
</description>
</method>
<methodname="cubic_interpolate">
...
...
@@ -108,7 +108,7 @@
<argumentindex="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". "t" should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
Cubicly interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], or a percentage of how far along the interpolation is.
</description>
</method>
<methodname="distance_squared_to">
...
...
@@ -117,7 +117,7 @@
<argumentindex="0"name="to"type="Vector2">
</argument>
<description>
Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula.
Returns the squared distance to vector [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula.
</description>
</method>
<methodname="distance_to">
...
...
@@ -126,7 +126,7 @@
<argumentindex="0"name="to"type="Vector2">
</argument>
<description>
Returns the distance to vector "b".
Returns the distance to vector [code]b[/code].
</description>
</method>
<methodname="dot">
...
...
@@ -135,7 +135,7 @@
<argumentindex="0"name="with"type="Vector2">
</argument>
<description>
Returns the dot product with vector "b".
Returns the dot product with vector [code]b[/code].
</description>
</method>
<methodname="floor">
...
...
@@ -149,21 +149,21 @@
<returntype="bool">
</return>
<description>
Returns whether the vector is normalized or not.
Returns [code]true[/code] if the vector is normalized.
</description>
</method>
<methodname="length">
<returntype="float">
</return>
<description>
Returns the length of the vector.
Returns the vector's length.
</description>
</method>
<methodname="length_squared">
<returntype="float">
</return>
<description>
Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula.
Returns the vector's length squared. Prefer this function over [member length] if you need to sort vectors or need the squared length for some formula.
</description>
</method>
<methodname="linear_interpolate">
...
...
@@ -174,14 +174,14 @@
<argumentindex="1"name="t"type="float">
</argument>
<description>
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.
Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is.
</description>
</method>
<methodname="normalized">
<returntype="Vector2">
</return>
<description>
Returns a normalized vector to unit length.
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
</description>
</method>
<methodname="reflect">
...
...
@@ -190,7 +190,7 @@
<argumentindex="0"name="n"type="Vector2">
</argument>
<description>
Reflects the vector along the given plane, specified by its normal vector.
Returns the vector reflected from a plane defined by the given normal.
</description>
</method>
<methodname="rotated">
...
...
@@ -199,7 +199,7 @@
<argumentindex="0"name="phi"type="float">
</argument>
<description>
Rotates the vector by "phi" radians.
Returns the vector rotated by [code]phi[/code] radians.
</description>
</method>
<methodname="round">
...
...
@@ -214,7 +214,7 @@
<argumentindex="0"name="n"type="Vector2">
</argument>
<description>
Slide returns the component of the vector along the given plane, specified by its normal vector.
Returns the component of the vector along a plane defined by the given normal.
</description>
</method>
<methodname="snapped">
...
...
@@ -223,7 +223,7 @@
<argumentindex="0"name="by"type="Vector2">
</argument>
<description>
Snaps the vector to a grid with the given size.
Returns the vector snapped to a grid with the given size.
Returns the vector's minimum angle to the vector [code]to[/code].
Returns the minimum angle to the given vector.
</description>
</method>
<methodname="bounce">
...
...
@@ -47,7 +47,7 @@
<argumentindex="0"name="n"type="Vector3">
</argument>
<description>
Bounce returns the vector "bounced off" from the given plane, specified by its normal vector.
Returns the vector "bounced off" from a plane defined by the given normal.
</description>
</method>
<methodname="ceil">
...
...
@@ -87,7 +87,7 @@
<argumentindex="0"name="b"type="Vector3">
</argument>
<description>
Returns the squared distance to [code]b[/code]. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.
Returns the squared distance to [code]b[/code]. Prefer this function over [method distance_to] if you need to sort vectors or need the squared distance for some formula.
</description>
</method>
<methodname="distance_to">
...
...
@@ -96,7 +96,7 @@
<argumentindex="0"name="b"type="Vector3">
</argument>
<description>
Returns the distance to b.
Returns the distance to [code]b[/code].
</description>
</method>
<methodname="dot">
...
...
@@ -105,7 +105,7 @@
<argumentindex="0"name="b"type="Vector3">
</argument>
<description>
Returns the dot product with b.
Returns the dot product with [code]b[/code].
</description>
</method>
<methodname="floor">
...
...
@@ -119,28 +119,28 @@
<returntype="Vector3">
</return>
<description>
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 [code]Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )[/code].
</description>
</method>
<methodname="is_normalized">
<returntype="bool">
</return>
<description>
Returns whether the vector is normalized or not.
Returns [code]true[/code] if the vector is normalized.
</description>
</method>
<methodname="length">
<returntype="float">
</return>
<description>
Returns the length of the vector.
Returns the vector's length.
</description>
</method>
<methodname="length_squared">
<returntype="float">
</return>
<description>
Returns 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.
Returns the vector's length squared. Prefer this function over [method length] if you need to sort vectors or need the squared length for some formula.
</description>
</method>
<methodname="linear_interpolate">
...
...
@@ -151,28 +151,28 @@
<argumentindex="1"name="t"type="float">
</argument>
<description>
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.
Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is in the range of [code]0.0 - 1.0[/code], a percentage of how far along the interpolation is.
</description>
</method>
<methodname="max_axis">
<returntype="int">
</return>
<description>
Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest.
Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants.
</description>
</method>
<methodname="min_axis">
<returntype="int">
</return>
<description>
Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest.
Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants.
</description>
</method>
<methodname="normalized">
<returntype="Vector3">
</return>
<description>
Returns a copy of the normalized vector to unit length. This is the same as v / v.length().
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
</description>
</method>
<methodname="outer">
...
...
@@ -181,7 +181,7 @@
<argumentindex="0"name="b"type="Vector3">
</argument>
<description>
Returns the outer product with b.
Returns the outer product with [code]b[/code].
</description>
</method>
<methodname="reflect">
...
...
@@ -190,7 +190,7 @@
<argumentindex="0"name="n"type="Vector3">
</argument>
<description>
Reflects the vector along the given plane, specified by its normal vector.
Returns the vector reflected from a plane defined by the given normal.
</description>
</method>
<methodname="rotated">
...
...
@@ -201,7 +201,7 @@
<argumentindex="1"name="phi"type="float">
</argument>
<description>
Rotates the vector around some axis by phi radians. The axis must be a normalized vector.
Rotates the vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector.
</description>
</method>
<methodname="round">
...
...
@@ -216,7 +216,7 @@
<argumentindex="0"name="n"type="Vector3">
</argument>
<description>
Slide returns the component of the vector along the given plane, specified by its normal vector.
Returns the component of the vector along a plane defined by the given normal.
</description>
</method>
<methodname="snapped">
...
...
@@ -238,18 +238,18 @@
</methods>
<members>
<membername="x"type="float"setter=""getter="">
X component of the vector.
The vector's x component.
</member>
<membername="y"type="float"setter=""getter="">
Y component of the vector.
The vector's y component.
</member>
<membername="z"type="float"setter=""getter="">
Z component of the vector.
The vector's z component.
</member>
</members>
<constants>
<constantname="AXIS_X"value="0">
Enumerated value for the X axis. Returned by functions like max_axis or min_axis.
Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis].