2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-06-14 17:37:51 +02:00
<class name= "Vector2" category= "Built-In Types" version= "3.0.4" >
2017-09-12 22:42:36 +02:00
<brief_description >
2018-05-13 02:58:45 +02:00
Vector used for 2D math.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2018-05-13 02:58:45 +02:00
2-element structure that can be used to represent positions in 2d space or any other pair of numeric values.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2018-01-25 09:03:59 +01:00
http://docs.godotengine.org/en/3.0/tutorials/math/index.html
2017-09-12 22:42:36 +02:00
</tutorials>
<demos >
</demos>
<methods >
<method name= "Vector2" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "x" type= "float" >
</argument>
<argument index= "1" name= "y" type= "float" >
</argument>
<description >
Constructs a new Vector2 from the given x and y.
</description>
</method>
<method name= "abs" >
<return type= "Vector2" >
</return>
<description >
Returns a new vector with all components in absolute values (i.e. positive).
</description>
</method>
<method name= "angle" >
<return type= "float" >
</return>
<description >
2018-06-01 18:19:33 +02:00
Returns the vector's angle in radians with respect to the x-axis, or [code](1, 0)[/code] vector.
2018-05-13 02:58:45 +02:00
Equivalent to the result of atan2 when called with the vector's x and y as parameters: [code]atan2(x, y)[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "angle_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
Returns the angle in radians between the two vectors.
</description>
</method>
<method name= "angle_to_point" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
Returns the angle in radians between the line connecting the two points and the x coordinate.
</description>
</method>
<method name= "aspect" >
<return type= "float" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the ratio of x to y.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "bounce" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "n" type= "Vector2" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector "bounced off" from a plane defined by the given normal.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-06-01 18:19:33 +02:00
<method name= "ceil" >
<return type= "Vector2" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "clamped" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "length" type= "float" >
</argument>
<description >
Returns the vector with a maximum length.
</description>
</method>
<method name= "cubic_interpolate" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "b" type= "Vector2" >
</argument>
<argument index= "1" name= "pre_a" type= "Vector2" >
</argument>
<argument index= "2" name= "post_b" type= "Vector2" >
</argument>
<argument index= "3" name= "t" type= "float" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "distance_squared_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "distance_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the distance to vector [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "dot" >
<return type= "float" >
</return>
<argument index= "0" name= "with" type= "Vector2" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the dot product with vector [code]b[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "floor" >
<return type= "Vector2" >
</return>
<description >
Remove the fractional part of x and y.
</description>
</method>
<method name= "is_normalized" >
<return type= "bool" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns [code]true[/code] if the vector is normalized.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "length" >
<return type= "float" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector's length.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "length_squared" >
<return type= "float" >
</return>
<description >
2018-05-13 02:58:45 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "linear_interpolate" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "b" type= "Vector2" >
</argument>
<argument index= "1" name= "t" type= "float" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "normalized" >
<return type= "Vector2" >
</return>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "reflect" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "n" type= "Vector2" >
</argument>
<description >
2018-06-01 18:19:33 +02:00
Returns the vector reflected from a plane defined by the given normal.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "rotated" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "phi" type= "float" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector rotated by [code]phi[/code] radians.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-06-01 18:19:33 +02:00
<method name= "round" >
<return type= "Vector2" >
</return>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "slide" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "n" type= "Vector2" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the component of the vector along a plane defined by the given normal.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "snapped" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "by" type= "Vector2" >
</argument>
<description >
2018-05-13 02:58:45 +02:00
Returns the vector snapped to a grid with the given size.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "tangent" >
<return type= "Vector2" >
</return>
<description >
Returns a perpendicular vector.
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "x" type= "float" setter= "" getter= "" >
2018-05-13 02:58:45 +02:00
The vector's x component.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "y" type= "float" setter= "" getter= "" >
2018-05-13 02:58:45 +02:00
The vector's y component.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>