Vector2

Vector used for 2D math.

Properties

	Vector2 ( x, float y )
	abs ( )
	angle ( )
	angle_to ( to )
float	( Vector2 to )
	aspect ( )
	bounce ( n )
Vector2	( )
Vector2	( float length )
	cross ( with )
Vector2	( Vector2 b, pre_a, Vector2 post_b, t )
Vector2	( Vector2 b )
	distance_squared_to ( to )
float	( Vector2 to )
	dot ( with )
Vector2	( )
bool	( )
float	( )
float	( )
Vector2	( Vector2 b, t )
Vector2	( )
Vector2	( Vector2 b )
	reflect ( n )
Vector2	( float phi )
	round ( )
	slerp ( b, float t )
	slide ( n )
Vector2	( Vector2 by )
	tangent ( )

Constants

ZERO = Vector2( 0, 0 ) — Zero vector.
ONE = Vector2( 1, 1 ) — One vector.
INF = Vector2( inf, inf ) — Infinite 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.

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

Tutorials

The vector’s x component. Also accessible by using the index position .

float y

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

Method Descriptions

Vector2 ( float x, y )

Constructs a new Vector2 from the given x and y.

Vector2 abs ( )

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

angle ( )

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

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

float angle_to ( to )

Returns the angle in radians between the two vectors.

float angle_to_point ( to )

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

float aspect ( )

Returns the ratio of x to y.

bounce ( Vector2 n )

ceil ( )

Returns the vector with all components rounded up.

Vector2 clamped ( length )

Returns the vector with a maximum length.

float cross ( with )

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

Vector2 cubic_interpolate ( b, Vector2 pre_a, post_b, float t )

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

direction_to ( Vector2 b )

Returns the normalized vector pointing from this vector to b.

distance_squared_to ( Vector2 to )

Returns the squared distance to vector b. Prefer this function over if you need to sort vectors or need the squared distance for some formula.

Returns the distance to vector b.

float dot ( with )

Returns the dot product with vector b.

Vector2 floor ( )

Returns the vector with all components rounded down.

is_normalized ( )

Returns true if the vector is normalized.

float length ( )

Returns the vector’s length.

length_squared ( )

Vector2 linear_interpolate ( b, float t )

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

normalized ( )

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

Vector2 project ( b )

Returns the vector projected onto the vector b.

Vector2 reflect ( n )

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

Vector2 rotated ( phi )

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

round ( )

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

Vector2 slerp ( b, float t )

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

Both vectors need to be normalized.

slide ( Vector2 n )

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

snapped ( Vector2 by )

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

tangent ( )

Returns a perpendicular vector.