Vector2

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

Note: In a boolean context, a Vector2 will evaluate to if it’s equal to Vector2(0, 0). Otherwise, a Vector2 will always evaluate to true.

Tutorials

• Vector math
• https://www.youtube.com/playlist?list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab
• https://github.com/godotengine/godot-demo-projects/tree/master/2d

Methods

• AXIS_X = 0 —- Enumerated value for the X axis.
• AXIS_Y = 1 —- Enumerated value for the Y axis.
• ZERO = Vector2( 0, 0 ) —- Zero vector, a vector with all components set to 0.
• ONE = Vector2( 1, 1 ) —- One vector, a vector with all components set to 1.
• INF = Vector2( inf, inf ) —- Infinity vector, a vector with all components set to .
• RIGHT = Vector2( 1, 0 ) —- Right unit vector. Represents the direction of right.
• UP = Vector2( 0, -1 ) —- Up unit vector. Y is down in 2D, so this vector points -Y.
• DOWN = Vector2( 0, 1 ) —- Down unit vector. Y is down in 2D, so this vector points +Y.

Property Descriptions

• float x

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

• y

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

• Vector2 Vector2 ( x, float y )

Constructs a new Vector2 from the given x and y.

• abs ( )

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

• float angle ( )

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

For example, Vector2.RIGHT.angle() will return zero, Vector2.DOWN.angle() will return PI / 2 (a quarter turn, or 90 degrees), and Vector2(1, -1).angle() will return (a negative eighth turn, or -45 degrees).

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

• float angle_to ( to )

Returns the angle to the given vector, in radians.

• float angle_to_point ( to )

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

• float aspect ( )

Returns the aspect ratio of this vector, the ratio of to y.

• bounce ( Vector2 n )

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

• ceil ( )

Returns the vector with all components rounded up (towards positive infinity).

• Vector2 clamped ( length )

• float cross ( with )

Returns the cross product of this vector and with.

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

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

• direction_to ( Vector2 b )

Returns the normalized vector pointing from this vector to b. This is equivalent to using (b - a).normalized().

• distance_squared_to ( Vector2 to )

Returns the squared distance between this vector and b.

This method runs faster than , so prefer it if you need to compare vectors or need the squared distance for some formula.

Returns the distance between this vector and to.

• float dot ( with )

Returns the dot product of this vector and with. 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.

The dot product will be 0 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 -1.0 (180 degree angle) when the vectors are facing opposite directions, and 1.0 (0 degree angle) when the vectors are aligned.

Note: a.dot(b) is equivalent to .

• Vector2 floor ( )

Returns the vector with all components rounded down (towards negative infinity).

• is_equal_approx ( Vector2 v )

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

• bool is_normalized ( )

Returns true if the vector is normalized, false otherwise.

• length ( )

Returns the length (magnitude) of this vector.

• float length_squared ( )

This method runs faster than , so prefer it if you need to compare vectors or need the squared distance for some formula.

• Vector2 linear_interpolate ( b, float t )

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

• move_toward ( Vector2 to, delta )

Moves the vector toward to by the fixed delta amount.

• Vector2 normalized ( )

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

• posmod ( float mod )

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

• Vector2 posmodv ( modv )

Returns a vector composed of the @GDScript.fposmod of this vector’s components and modv‘s components.

• project ( Vector2 b )

Returns the vector projected onto the vector b.

• reflect ( Vector2 n )

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

• rotated ( float phi )

Returns the vector rotated by phi radians. See also .

• Vector2 round ( )

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

• sign ( )

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 @GDScript.sign on each component.

• slerp ( Vector2 b, t )

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

Note: Both vectors must be normalized.

• Vector2 slide ( n )

Returns this vector slid along a plane defined by the given normal.

• Vector2 tangent ( )

Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length.