Vector2 Manual     Reference     Scripting  
Scripting > Runtime Classes > Vector2
Vector2 Struct

Representation of 2D vectors and points.

This structure is used in some places to represent 2D positions and vectors (e.g. texture coordinates in a Mesh or texture offsets in Material). In the majority of other cases a Vector3 is used.

Variables
x

X component of the vector.

y

Y component of the vector.

this [int index]

Access the x or y component using [0] or [1] respectively.

normalized

Returns this vector with a magnitude of 1 (Read Only).

magnitude

Returns the length of this vector (Read Only).

sqrMagnitude

Returns the squared length of this vector (Read Only).

Constructors
Vector2

Constructs a new vector with given x, y components.

Functions
Scale

Multiplies every component of this vector by the same component of scale.

Normalize

Makes this vector have a magnitude of 1.

ToString

Returns a nicely formatted string for this vector.

Class Variables
zero

Shorthand for writing Vector2(0, 0)

one

Shorthand for writing Vector2(1, 1)

up

Shorthand for writing Vector2(0, 1)

right

Shorthand for writing Vector2(1, 0)

Class Functions
Lerp

Linearly interpolates between two vectors.

MoveTowards

Moves a point current towards target.

Scale

Multiplies two vectors component-wise.

Dot

Dot Product of two vectors.

Angle

Returns the angle in degrees between from and to.

Distance

Returns the distance between a and b.

ClampMagnitude

Returns a copy of vector with its magnitude clamped to maxLength.

Min

Returns a vector that is made from the smallest components of two vectors.

Max

Returns a vector that is made from the largest components of two vectors.

operator +

Adds two vectors.

operator -

Subtracts one vector from another.

operator *

Multiplies a vector by a number.

operator /

Divides a vector by a number.

operator ==

Returns true if the vectors are equal.

operator !=

Returns true if vectors different.

operator Vector2

Converts a Vector3 to a Vector2.

operator Vector3

Converts a Vector2 to a Vector3.