# Vector2¶

Vector used for 2D math using floating point coordinates.

## Description¶

2-element structure that can be used to represent positions in 2D space or any other pair of numeric values.

It uses floating point coordinates.

## Properties¶

 float x `0.0` float y `0.0`

## Methods¶

 Vector2 Vector2 ( Vector2i from ) Vector2 Vector2 ( float x, float y ) Vector2 abs ( ) float angle ( ) float angle_to ( Vector2 to ) float angle_to_point ( Vector2 to ) float aspect ( ) Vector2 bounce ( Vector2 n ) Vector2 ceil ( ) Vector2 clamped ( float length ) float cross ( Vector2 with ) Vector2 cubic_interpolate ( Vector2 b, Vector2 pre_a, Vector2 post_b, float t ) Vector2 direction_to ( Vector2 b ) float distance_squared_to ( Vector2 to ) float distance_to ( Vector2 to ) float dot ( Vector2 with ) Vector2 floor ( ) bool is_equal_approx ( Vector2 v ) bool is_normalized ( ) float length ( ) float length_squared ( ) Vector2 linear_interpolate ( Vector2 b, float t ) Vector2 move_toward ( Vector2 to, float delta ) Vector2 normalized ( ) Vector2 posmod ( float mod ) Vector2 posmodv ( Vector2 modv ) Vector2 project ( Vector2 b ) Vector2 reflect ( Vector2 n ) Vector2 rotated ( float phi ) Vector2 round ( ) Vector2 sign ( ) Vector2 slerp ( Vector2 b, float t ) Vector2 slide ( Vector2 n ) Vector2 snapped ( Vector2 by ) Vector2 tangent ( )

## Constants¶

• AXIS_X = 0 — Enumerated value for the X axis.
• AXIS_Y = 1 — Enumerated value for the Y axis.
• ZERO = Vector2( 0, 0 ) — Zero vector.
• ONE = Vector2( 1, 1 ) — One vector.
• INF = Vector2( inf, inf ) — Infinity vector.
• LEFT = Vector2( -1, 0 ) — Left unit vector.
• RIGHT = Vector2( 1, 0 ) — Right unit vector.
• UP = Vector2( 0, -1 ) — Up unit vector.
• DOWN = Vector2( 0, 1 ) — Down unit vector.

## Property Descriptions¶

 Default `0.0`

The vector’s X component. Also accessible by using the index position `[0]`.

 Default `0.0`

The vector’s Y component. Also accessible by using the index position `[1]`.

## Method Descriptions¶

Constructs a new `Vector2` from Vector2i.

Constructs a new `Vector2` from the given `x` and `y`.

Returns a new vector with all components in absolute values (i.e. positive).

Returns the vector’s angle in radians with respect to the X axis, or `(1, 0)` vector.

Equivalent to the result of @GDScript.atan2 when called with the vector’s x and y as parameters: `atan2(x, y)`.

Returns the angle in radians between the two vectors.

Returns the angle in radians between the line connecting the two points and the X coordinate.

Returns the ratio of x to y.

Returns the vector “bounced off” from a plane defined by the given normal.

Returns the vector with all components rounded up.

Returns the vector with a maximum length.

Returns the 2-dimensional analog of the cross product with the given vector.

Cubically interpolates between this vector and `b` using `pre_a` and `post_b` as handles, and returns the result at position `t`. `t` is in the range of `0.0 - 1.0`, representing the amount of interpolation.

Returns the normalized vector pointing from this vector to `b`.

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 distance to vector `b`.

Returns the dot product with vector `b`.

Returns the vector with all components rounded down.

Returns `true` if this vector and `v` are approximately equal, by running @GDScript.is_equal_approx on each component.

• bool is_normalized ( )

Returns `true` if the vector is normalized.

Returns the vector’s length.

• float length_squared ( )

Returns the vector’s length squared. Prefer this method over length if you need to sort vectors or need the squared length for some formula.

Returns the result of the linear interpolation between this vector and `b` by amount `t`. `t` is in the range of `0.0 - 1.0`, representing the amount of interpolation.

Moves the vector toward `to` by the fixed `delta` amount.

Returns the vector scaled to unit length. Equivalent to `v / v.length()`.

Returns a vector composed of the `fposmod` of this vector’s components and `mod`.

Returns a vector composed of the `fposmod` of this vector’s components and `modv`’s components.

Returns the vector projected onto the vector `b`.

Returns the vector reflected from a plane defined by the given normal.

Returns the vector rotated by `phi` radians. See also @GDScript.deg2rad.

Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.

Returns the vector with each component set to one or negative one, depending on the signs of the components.

Returns the result of spherical linear interpolation between this vector and `b`, by amount `t`. `t` is in the range of `0.0 - 1.0`, representing the amount of interpolation.

Note: Both vectors must be normalized.

Returns the component of the vector along a plane defined by the given normal.

Returns the vector snapped to a grid with the given size.

Returns a perpendicular vector.