Vector2
Phaser.Math.Vector2
A representation of a vector in 2D space, defined by an x and y component.
Vector2 is used throughout Phaser for positions, directions, velocities, and other quantities that have both magnitude and direction. It provides methods for common vector operations such as addition, subtraction, scaling, normalization, dot and cross products, linear interpolation, and rotation. Many Phaser APIs accept a Vector2Like object (any object with x and y number properties), making Vector2 easy to integrate across the framework.
Constructor
new Vector2([x], [y])
Parameters
| name | type | optional | default | description |
|---|---|---|---|---|
| x | number | Phaser.Types.Math.Vector2Like | Yes | 0 | The x component, or an object with x and y properties. |
| y | number | Yes | "x" | The y component. |
Scope: static
Source: src/math/Vector2.js#L13
Since: 3.0.0
Public Members
x
x: number
Description:
The x component of this Vector.
Source: src/math/Vector2.js#L38
Since: 3.0.0
y
y: number
Description:
The y component of this Vector.
Source: src/math/Vector2.js#L48
Since: 3.0.0
Public Methods
add
instanceadd(src)
Description:
Add a given Vector to this Vector. Addition is component-wise.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to add to this Vector. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L294
Since: 3.0.0
angle
instanceangle()
Description:
Calculate the angle between this Vector and the positive x-axis, in radians.
Returns: number - The angle between this Vector, and the positive x-axis, given in radians.
Source: src/math/Vector2.js#L257
Since: 3.0.0
ceil
instanceceil()
Description:
Runs the x and y components of this Vector2 through Math.ceil and then sets them.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L158
Since: 4.0.0
clone
instanceclone()
Description:
Make a clone of this Vector2.
Returns: Phaser.Math.Vector2 - A clone of this Vector2.
Source: src/math/Vector2.js#L72
Since: 3.0.0
copy
instancecopy(src)
Description:
Copy the components of a given Vector into this Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to copy the components from. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L85
Since: 3.0.0
cross
instancecross(src)
Description:
Calculate the cross product of this Vector and the given Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector2 to cross with this Vector2. |
Returns: number - The cross product of this Vector and the given Vector.
Source: src/math/Vector2.js#L573
Since: 3.0.0
distance
instancedistance(src)
Description:
Calculate the distance between this Vector and the given Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to calculate the distance to. |
Returns: number - The distance from this Vector to the given Vector.
Source: src/math/Vector2.js#L412
Since: 3.0.0
distanceSq
instancedistanceSq(src)
Description:
Calculate the distance between this Vector and the given Vector, squared.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to calculate the distance to. |
Returns: number - The distance from this Vector to the given Vector, squared.
Source: src/math/Vector2.js#L430
Since: 3.0.0
divide
instancedivide(src)
Description:
Perform a component-wise division between this Vector and the given Vector.
Divides this Vector by the given Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to divide this Vector by. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L376
Since: 3.0.0
dot
instancedot(src)
Description:
Calculate the dot product of this Vector and the given Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector2 to dot product with this Vector2. |
Returns: number - The dot product of this Vector and the given Vector.
Source: src/math/Vector2.js#L558
Since: 3.0.0
equals
instanceequals(v)
Description:
Check whether this Vector is equal to a given Vector.
Performs a strict equality check against each Vector's components.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| v | Phaser.Types.Math.Vector2Like | No | The vector to compare with this Vector. |
Returns: boolean - Whether the given Vector is equal to this Vector.
Source: src/math/Vector2.js#L224
Since: 3.0.0
floor
instancefloor()
Description:
Runs the x and y components of this Vector2 through Math.floor and then sets them.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L174
Since: 4.0.0
fuzzyEquals
instancefuzzyEquals(v, [epsilon])
Description:
Check whether this Vector is approximately equal to a given Vector.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| v | Phaser.Types.Math.Vector2Like | No | The vector to compare with this Vector. | |
| epsilon | number | Yes | 0.0001 | The tolerance value. |
Returns: boolean - Whether both absolute differences of the x and y components are smaller than epsilon.
Source: src/math/Vector2.js#L241
Since: 3.23.0
invert
instanceinvert()
Description:
Swaps the x and y components of this Vector2.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L190
Since: 4.0.0
length
instancelength()
Description:
Calculate the length (or magnitude) of this Vector.
Returns: number - The length of this Vector.
Source: src/math/Vector2.js#L448
Since: 3.0.0
lengthSq
instancelengthSq()
Description:
Calculate the length of this Vector squared.
Returns: number - The length of this Vector, squared.
Source: src/math/Vector2.js#L479
Since: 3.0.0
lerp
instancelerp(src, [t])
Description:
Linearly interpolate between this Vector and the given Vector.
Interpolates this Vector towards the given Vector.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector2 to interpolate towards. | |
| t | number | Yes | 0 | The interpolation percentage, between 0 and 1. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L588
Since: 3.0.0
limit
instancelimit(max)
Description:
Limit the length (or magnitude) of this Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| max | number | No | The maximum length. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L674
Since: 3.23.0
mirror
instancemirror(axis)
Description:
Reflect this Vector across another.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| axis | Phaser.Math.Vector2 | No | A vector to reflect across. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L713
Since: 3.23.0
multiply
instancemultiply(src)
Description:
Perform a component-wise multiplication between this Vector and the given Vector.
Multiplies this Vector by the given Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to multiply this Vector by. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L330
Since: 3.0.0
negate
instancenegate()
Description:
Negate the x and y components of this Vector.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L396
Since: 3.0.0
normalize
instancenormalize()
Description:
Normalize this Vector.
Makes the vector a unit length vector (magnitude of 1) in the same direction.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L495
Since: 3.0.0
normalizeLeftHand
instancenormalizeLeftHand()
Description:
Rotate this Vector to its perpendicular, in the negative direction.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L540
Since: 3.23.0
normalizeRightHand
instancenormalizeRightHand()
Description:
Rotate this Vector to its perpendicular, in the positive direction.
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L522
Since: 3.0.0
project
instanceproject(src)
Description:
Project this Vector onto another.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Math.Vector2 | No | The vector to project onto. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L746
Since: 3.60.0
projectUnit
instanceprojectUnit(vecB, [out])
Description:
Calculates the vector projection of this Vector2 onto the non-zero vecB. This is the orthogonal projection of this vector onto a straight line parallel to vecB.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| vecB | Phaser.Math.Vector2 | No | The vector to project onto. |
| out | Phaser.Math.Vector2 | Yes | The Vector2 object to store the position in. If not given, a new Vector2 instance is created. |
Returns: Phaser.Math.Vector2 - The out Vector2 containing the projected values.
Source: src/math/Vector2.js#L763
Since: 4.0.0
reflect
instancereflect(normal)
Description:
Reflect this Vector off a line defined by a normal.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| normal | Phaser.Math.Vector2 | No | A vector perpendicular to the line. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L696
Since: 3.23.0
reset
instancereset()
Description:
Make this Vector the zero vector (0, 0).
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L658
Since: 3.0.0
rotate
instancerotate(delta)
Description:
Rotate this Vector by an angle amount.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| delta | number | No | The angle to rotate by, in radians. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L728
Since: 3.23.0
scale
instancescale(value)
Description:
Scale this Vector by the given value.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| value | number | No | The value to scale this Vector by. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L350
Since: 3.0.0
set
instanceset(x, [y])
Description:
Set the x and y components of this Vector to the given x and y values.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| x | number | No | The x value to set for this Vector. | |
| y | number | Yes | "x" | The y value to set for this Vector. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L121
Since: 3.0.0
setAngle
instancesetAngle(angle)
Description:
Set the angle of this Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| angle | number | No | The angle, in radians. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L279
Since: 3.23.0
setFromObject
instancesetFromObject(obj)
Description:
Set the component values of this Vector from a given Vector2Like object.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| obj | Phaser.Types.Math.Vector2Like | No | The object containing the component values to set for this Vector. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L103
Since: 3.0.0
setLength
instancesetLength(length)
Description:
Set the length (or magnitude) of this Vector.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| length | number | No | The new magnitude of this Vector. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L464
Since: 3.23.0
setTo
instancesetTo(x, [y])
Description:
This method is an alias for Vector2.set.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| x | number | No | The x value to set for this Vector. | |
| y | number | Yes | "x" | The y value to set for this Vector. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L142
Since: 3.4.0
setToPolar
instancesetToPolar(angle, [length])
Description:
Sets the x and y components of this Vector from the given angle and length.
Parameters:
| name | type | optional | default | description |
|---|---|---|---|---|
| angle | number | No | The angle from the positive x-axis, in radians. | |
| length | number | Yes | 1 | The distance from the origin. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L203
Since: 3.0.0
subtract
instancesubtract(src)
Description:
Subtract the given Vector from this Vector. Subtraction is component-wise.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| src | Phaser.Types.Math.Vector2Like | No | The Vector to subtract from this Vector. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L312
Since: 3.0.0
transformMat3
instancetransformMat3(mat)
Description:
Transform this Vector with the given Matrix3.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| mat | Phaser.Math.Matrix3 | No | The Matrix3 to transform this Vector2 with. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L614
Since: 3.0.0
transformMat4
instancetransformMat4(mat)
Description:
Transform this Vector with the given Matrix4.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| mat | Phaser.Math.Matrix4 | No | The Matrix4 to transform this Vector2 with. |
Returns: Phaser.Math.Vector2 - This Vector2.
Source: src/math/Vector2.js#L636
Since: 3.0.0
Constants:
Public Members
DOWN
DOWN: Phaser.Math.Vector2
Description:
A static down Vector2 for use by reference.
This constant is meant for comparison operations and should not be modified directly.
Source: src/math/Vector2.js#L840
Since: 3.16.0
LEFT
LEFT: Phaser.Math.Vector2
Description:
A static left Vector2 for use by reference.
This constant is meant for comparison operations and should not be modified directly.
Source: src/math/Vector2.js#L816
Since: 3.16.0
ONE
ONE: Phaser.Math.Vector2
Description:
A static one Vector2 for use by reference.
This constant is meant for comparison operations and should not be modified directly.
Source: src/math/Vector2.js#L852
Since: 3.16.0
RIGHT
RIGHT: Phaser.Math.Vector2
Description:
A static right Vector2 for use by reference.
This constant is meant for comparison operations and should not be modified directly.
Source: src/math/Vector2.js#L804
Since: 3.16.0
UP
UP: Phaser.Math.Vector2
Description:
A static up Vector2 for use by reference.
This constant is meant for comparison operations and should not be modified directly.
Source: src/math/Vector2.js#L828
Since: 3.16.0
ZERO
ZERO: Phaser.Math.Vector2
Description:
A static zero Vector2 for use by reference.
This constant is meant for comparison operations and should not be modified directly.
Source: src/math/Vector2.js#L792
Since: 3.1.0