2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "Vector2" version= "4.0" >
2017-09-12 20:42:36 +00:00
<brief_description >
2020-02-24 16:00:40 +00:00
Vector used for 2D math using floating point coordinates.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2019-08-01 20:13:59 +00:00
2-element structure that can be used to represent positions in 2D space or any other pair of numeric values.
2020-06-21 15:16:10 +00:00
It uses floating-point coordinates. See [Vector2i] for its integer counterpart.
[b]Note:[/b] In a boolean context, a Vector2 will evaluate to [code]false[/code] if it's equal to [code]Vector2(0, 0)[/code]. Otherwise, a Vector2 will always evaluate to [code]true[/code].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2020-08-05 12:43:40 +00:00
<link title= "Math tutorial index" > https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
2020-10-01 08:34:47 +00:00
<link title= "Vector math" > https://docs.godotengine.org/en/latest/tutorials/math/vector_math.html</link>
<link title= "Advanced vector math" > https://docs.godotengine.org/en/latest/tutorials/math/vectors_advanced.html</link>
<link title= "3Blue1Brown Essence of Linear Algebra" > https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab</link>
<link title= "Matrix Transform Demo" > https://godotengine.org/asset-library/asset/584</link>
<link title= "All 2D Demos" > https://github.com/godotengine/godot-demo-projects/tree/master/2d</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
2020-11-10 13:16:20 +00:00
<method name= "Vector2" qualifiers= "constructor" >
2020-11-09 16:46:03 +00:00
<return type= "Vector2" >
</return>
<description >
Constructs a default-initialized [Vector2] with all components set to [code]0[/code].
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "Vector2" qualifiers= "constructor" >
2020-11-09 16:46:03 +00:00
<return type= "Vector2" >
</return>
<argument index= "0" name= "from" type= "Vector2" >
</argument>
<description >
Constructs a [Vector2] as a copy of the given [Vector2].
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "Vector2" qualifiers= "constructor" >
2020-02-24 16:00:40 +00:00
<return type= "Vector2" >
</return>
<argument index= "0" name= "from" type= "Vector2i" >
</argument>
<description >
Constructs a new [Vector2] from [Vector2i].
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "Vector2" qualifiers= "constructor" >
2017-09-12 20:42:36 +00:00
<return type= "Vector2" >
</return>
<argument index= "0" name= "x" type= "float" >
</argument>
<argument index= "1" name= "y" type= "float" >
</argument>
<description >
2020-02-24 16:00:40 +00:00
Constructs a new [Vector2] from the given [code]x[/code] and [code]y[/code].
2017-09-12 20:42:36 +00:00
</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 >
2020-08-03 20:55:25 +00:00
Returns this vector's angle with respect to the positive X axis, or [code](1, 0)[/code] vector, in radians.
For example, [code]Vector2.RIGHT.angle()[/code] will return zero, [code]Vector2.DOWN.angle()[/code] will return [code]PI / 2[/code] (a quarter turn, or 90 degrees), and [code]Vector2(1, -1).angle()[/code] will return [code]-PI / 4[/code] (a negative eighth turn, or -45 degrees).
2020-07-03 02:52:37 +00:00
Equivalent to the result of [method @GDScript.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "angle_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the angle to the given vector, in radians.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "angle_to_point" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the angle between the line connecting the two points and the X axis, in radians.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "aspect" >
<return type= "float" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the aspect ratio of this vector, the ratio of [member x] to [member y].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "bounce" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "n" type= "Vector2" >
</argument>
<description >
2018-05-13 00:58:45 +00:00
Returns the vector "bounced off" from a plane defined by the given normal.
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-12 07:38:00 +00:00
<method name= "ceil" >
<return type= "Vector2" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the vector with all components rounded up (towards positive infinity).
2018-05-12 07:38:00 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "clamped" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "length" type= "float" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the vector with a maximum length by limiting its length to [code]length[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-02-08 07:48:14 +00:00
<method name= "cross" >
<return type= "float" >
</return>
2018-04-10 08:12:42 +00:00
<argument index= "0" name= "with" type= "Vector2" >
2018-02-08 07:48:14 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the cross product of this vector and [code]with[/code].
2018-02-08 07:48:14 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<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>
2020-12-07 08:16:31 +00:00
<argument index= "3" name= "weight" type= "float" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-12-07 08:16:31 +00:00
Cubically 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]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-03-27 10:51:05 +00:00
<method name= "direction_to" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "b" type= "Vector2" >
</argument>
<description >
2020-12-15 19:28:05 +00:00
Returns the normalized vector pointing from this vector to [code]b[/code]. This is equivalent to using [code](b - a).normalized()[/code].
2019-03-27 10:51:05 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "distance_squared_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the squared distance between this vector and [code]b[/code].
This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "distance_to" >
<return type= "float" >
</return>
<argument index= "0" name= "to" type= "Vector2" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the distance between this vector and [code]to[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "dot" >
<return type= "float" >
</return>
<argument index= "0" name= "with" type= "Vector2" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.
2020-07-17 22:46:23 +00:00
The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.
When using unit (normalized) vectors, the result will always be between [code]-1.0[/code] (180 degree angle) when the vectors are facing opposite directions, and [code]1.0[/code] (0 degree angle) when the vectors are aligned.
[b]Note:[/b] [code]a.dot(b)[/code] is equivalent to [code]b.dot(a)[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "floor" >
<return type= "Vector2" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the vector with all components rounded down (towards negative infinity).
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-11-08 07:33:48 +00:00
<method name= "is_equal_approx" >
<return type= "bool" >
</return>
2020-11-04 14:38:26 +00:00
<argument index= "0" name= "to" type= "Vector2" >
2019-11-08 07:33:48 +00:00
</argument>
<description >
2019-11-30 20:08:50 +00:00
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component.
2019-11-08 07:33:48 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "is_normalized" >
<return type= "bool" >
</return>
<description >
2020-09-24 16:00:22 +00:00
Returns [code]true[/code] if the vector is normalized, [code]false[/code] otherwise.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "length" >
<return type= "float" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the length (magnitude) of this vector.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "length_squared" >
<return type= "float" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the squared length (squared magnitude) of this vector.
This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-03-16 09:07:33 +00:00
<method name= "lerp" >
2017-09-12 20:42:36 +00:00
<return type= "Vector2" >
</return>
2020-12-07 08:16:31 +00:00
<argument index= "0" name= "to" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
2020-12-07 08:16:31 +00:00
<argument index= "1" name= "weight" type= "float" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the result of the linear interpolation between this vector and [code]b[/code] by amount [code]t[/code]. [code]t[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation.
2017-09-12 20:42:36 +00:00
</description>
</method>
2019-04-07 21:40:56 +00:00
<method name= "move_toward" >
<return type= "Vector2" >
</return>
2019-06-01 10:34:29 +00:00
<argument index= "0" name= "to" type= "Vector2" >
2019-04-07 21:40:56 +00:00
</argument>
2019-06-01 10:34:29 +00:00
<argument index= "1" name= "delta" type= "float" >
2019-04-07 21:40:56 +00:00
</argument>
<description >
Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount.
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "normalized" >
<return type= "Vector2" >
</return>
<description >
2018-05-13 00:58:45 +00:00
Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-11-10 13:16:20 +00:00
<method name= "operator !=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator *" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator *" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "Transform2D" >
</argument>
<description >
</description>
</method>
<method name= "operator *" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "float" >
</argument>
<description >
</description>
</method>
<method name= "operator *" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "operator +" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<description >
</description>
</method>
<method name= "operator +" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator -" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<description >
</description>
</method>
<method name= "operator -" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator /" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator /" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "float" >
</argument>
<description >
</description>
</method>
<method name= "operator /" qualifiers= "operator" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "right" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "operator <" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator <=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator ==" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator >" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator >=" qualifiers= "operator" >
<return type= "bool" >
</return>
<argument index= "0" name= "right" type= "Vector2" >
</argument>
<description >
</description>
</method>
<method name= "operator []" qualifiers= "operator" >
<return type= "float" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
</description>
</method>
2019-08-05 01:50:28 +00:00
<method name= "posmod" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "mod" type= "float" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]mod[/code].
2019-08-05 01:50:28 +00:00
</description>
</method>
<method name= "posmodv" >
<return type= "Vector2" >
</return>
2019-08-29 13:33:52 +00:00
<argument index= "0" name= "modv" type= "Vector2" >
2019-08-05 01:50:28 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]modv[/code]'s components.
2019-08-05 01:50:28 +00:00
</description>
</method>
2018-08-20 22:35:30 +00:00
<method name= "project" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "b" type= "Vector2" >
</argument>
<description >
Returns the vector projected onto the vector [code]b[/code].
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "reflect" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "n" type= "Vector2" >
</argument>
<description >
2018-05-28 12:53:15 +00:00
Returns the vector reflected from a plane defined by the given normal.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "rotated" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "phi" type= "float" >
</argument>
<description >
2019-04-30 20:32:02 +00:00
Returns the vector rotated by [code]phi[/code] radians. See also [method @GDScript.deg2rad].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-05-12 07:38:00 +00:00
<method name= "round" >
<return type= "Vector2" >
</return>
<description >
2018-06-26 22:02:24 +00:00
Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.
2018-05-12 07:38:00 +00:00
</description>
</method>
2019-08-05 01:50:28 +00:00
<method name= "sign" >
<return type= "Vector2" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns the vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling [method @GDScript.sign] on each component.
2019-08-05 01:50:28 +00:00
</description>
</method>
2018-05-12 00:14:39 +00:00
<method name= "slerp" >
<return type= "Vector2" >
</return>
2020-12-07 08:16:31 +00:00
<argument index= "0" name= "to" type= "Vector2" >
2018-05-12 00:14:39 +00:00
</argument>
2020-12-07 08:16:31 +00:00
<argument index= "1" name= "weight" type= "float" >
2018-05-12 00:14:39 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns the result of spherical linear interpolation between this vector and [code]b[/code], by amount [code]t[/code]. [code]t[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation.
2019-06-21 23:04:47 +00:00
[b]Note:[/b] Both vectors must be normalized.
2018-05-12 00:14:39 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "slide" >
<return type= "Vector2" >
</return>
<argument index= "0" name= "n" type= "Vector2" >
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns this vector slid along a plane defined by the given normal.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "snapped" >
<return type= "Vector2" >
</return>
2020-12-21 18:02:57 +00:00
<argument index= "0" name= "step" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
2020-07-21 18:07:00 +00:00
Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals.
2017-09-12 20:42:36 +00:00
</description>
</method>
2020-12-06 18:16:06 +00:00
<method name= "orthogonal" >
2017-09-12 20:42:36 +00:00
<return type= "Vector2" >
</return>
<description >
2020-07-21 18:07:00 +00:00
Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "x" type= "float" setter= "" getter= "" default= "0.0" >
2019-06-21 23:04:47 +00:00
The vector's X component. Also accessible by using the index position [code][0][/code].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "y" type= "float" setter= "" getter= "" default= "0.0" >
2019-06-21 23:04:47 +00:00
The vector's Y component. Also accessible by using the index position [code][1][/code].
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
2019-08-05 01:50:28 +00:00
<constant name= "AXIS_X" value= "0" >
2019-08-29 13:33:52 +00:00
Enumerated value for the X axis.
2019-08-05 01:50:28 +00:00
</constant>
<constant name= "AXIS_Y" value= "1" >
Enumerated value for the Y axis.
</constant>
2018-08-20 22:35:30 +00:00
<constant name= "ZERO" value= "Vector2( 0, 0 )" >
2020-07-21 18:07:00 +00:00
Zero vector, a vector with all components set to [code]0[/code].
2018-10-06 18:13:41 +00:00
</constant>
<constant name= "ONE" value= "Vector2( 1, 1 )" >
2020-07-21 18:07:00 +00:00
One vector, a vector with all components set to [code]1[/code].
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "INF" value= "Vector2( inf, inf )" >
2020-07-21 18:07:00 +00:00
Infinity vector, a vector with all components set to [constant @GDScript.INF].
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "LEFT" value= "Vector2( -1, 0 )" >
2020-07-21 18:07:00 +00:00
Left unit vector. Represents the direction of left.
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "RIGHT" value= "Vector2( 1, 0 )" >
2020-07-21 18:07:00 +00:00
Right unit vector. Represents the direction of right.
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "UP" value= "Vector2( 0, -1 )" >
2020-07-21 18:07:00 +00:00
Up unit vector. Y is down in 2D, so this vector points -Y.
2018-08-20 22:35:30 +00:00
</constant>
<constant name= "DOWN" value= "Vector2( 0, 1 )" >
2020-07-21 18:07:00 +00:00
Down unit vector. Y is down in 2D, so this vector points +Y.
2018-08-20 22:35:30 +00:00
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>
