Category: Built-In Types
Vector used for 2D math.
|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 )|
|float||distance_squared_to ( Vector2 to )|
|float||distance_to ( Vector2 to )|
|float||dot ( Vector2 with )|
|Vector2||floor ( )|
|bool||is_normalized ( )|
|float||length ( )|
|float||length_squared ( )|
|Vector2||linear_interpolate ( Vector2 b, float t )|
|Vector2||normalized ( )|
|Vector2||reflect ( Vector2 n )|
|Vector2||rotated ( float phi )|
|Vector2||round ( )|
|Vector2||slerp ( Vector2 b, float t )|
|Vector2||slide ( Vector2 n )|
|Vector2||snapped ( Vector2 by )|
|Vector2||tangent ( )|
2-element structure that can be used to represent positions in 2d space or any other pair of numeric values.
Member Function Description¶
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).
- float 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:
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.
- float aspect ( )
Returns the ratio of x to y.
Returns the vector “bounced off” from a plane defined by the given normal.
- Vector2 ceil ( )
Returns the vector with a maximum length.
Returns the 2 dimensional analog of the cross product with the given vector.
Cubicly interpolates between this vector and
post_b as handles, and returns the result at position
t is in the range of
0.0 - 1.0, or a percentage of how far along the interpolation is.
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
Returns the dot product with vector
- Vector2 floor ( )
Remove the fractional part of x and y.
- bool is_normalized ( )
true if the vector is normalized.
- float length ( )
Returns the vector’s length.
- float length_squared ( )
Returns the vector’s length squared. Prefer this function 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 is in the range of
0.0 - 1.0, a percentage of how far along the interpolation is.
- Vector2 normalized ( )
Returns the vector scaled to unit length. Equivalent to
v / v.length().
Returns the vector reflected from a plane defined by the given normal.
Returns the vector rotated by
- Vector2 round ( )
Returns the result of SLERP between this vector and “b”, by amount “t”. “t” should be a float of 0.0-1.0, a percentage of how far along the interpolation is.
Both vectors need to 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.
- Vector2 tangent ( )
Returns a perpendicular vector.