Class vec2

A two dimensional vector. Vectors can only store finite numbers in the range Number.MIN_VALUE to Number.MAX_VALUE.

Example

// Set the scale of a sprite using vec2 methods
//@input Component.SpriteAligner spriteAligner
//@input float spriteScale

script.spriteAligner.size = vec2.one().uniformScale(script.spriteScale);

Constructors

constructor

new vec2(x: number, y: number): vec2
Creates a new instance of a vec2.
Parameters
- x: number
- y: number
Returns vec2

Properties

g

g: number

Alternate name for the y component.

length

length: number

Returns the length of the vector.

lengthSquared

lengthSquared: number

Returns the squared length of the vector.

r

r: number

Alternate name for the x component.

x

x: number

x component of the vec2.

y

y: number

y component of the vec2.

Methods

add

add(vec: vec2): vec2
Returns the vector plus vec.
Parameters
- vec: vec2
Returns vec2

addInPlace

addInPlace(vec: vec2): void
Adds vec to this vector in place.
Parameters
- vec: vec2
Returns void

angleTo

angleTo(vec: vec2): number
Returns the angle between the vector and vec.
Parameters
- vec: vec2
Returns number

clampLength

clampLength(length: number): vec2
Returns a copy of the vector with its length clamped to length.
Parameters
- length: number
Returns vec2

clampLengthInPlace

clampLengthInPlace(length: number): void
Clamps this vector's length to length in place.
Parameters
- length: number
Returns void

clone

clone(): vec2
Returns a copy of this vector.

Returns vec2

copyFrom

copyFrom(source: vec4 | vec3 | vec2): void
Copies matching components from the source vector, ignoring extra source components. For example, copying a vec3 into a vec2 will update x and y but ignore z.
Parameters
- source: vec4 | vec3 | vec2
Returns void

distance

distance(vec: vec2): number
Returns the distance between the vector and the vector vec.
Parameters
- vec: vec2
Returns number

distanceSquared

distanceSquared(vec: vec2): number
Like distance(), but returns the squared distance between vectors.
Parameters
- vec: vec2
Returns number

div

div(vec: vec2): vec2
Returns the division of the vector by the vector vec.
Parameters
- vec: vec2
Returns vec2

divInPlace

divInPlace(vec: vec2): void
Divides this vector by vec component-wise in place.
Parameters
- vec: vec2
Returns void

dot

dot(vec: vec2): number
Returns the dot product of the vector and vec.
Parameters
- vec: vec2
Returns number

`Static`down

down(): vec2
Returns the vector (0, -1).

Returns vec2

equal

equal(vec: vec2): boolean
Returns whether this is equal to vec.
Parameters
- vec: vec2
Returns boolean

fill

fill(scalar: number): void
Sets the x and y components of this vector to scalar.
Parameters
- scalar: number
Returns void

`Static`left

left(): vec2
Returns the vector (-1, 0).

Returns vec2

`Static`lerp

lerp(vecA: vec2, vecB: vec2, t: number): vec2
Linearly interpolates between the two vectors from and to by the factor t.
Parameters
- vecA: vec2
- vecB: vec2
- t: number
Returns vec2

lerpInPlace

lerpInPlace(target: vec2, t: number): void
Linearly interpolates this vector towards target by factor t in place.
Parameters
- target: vec2
- t: number
Returns void

`Static`max

max(vecA: vec2, vecB: vec2): vec2
Returns a new vector containing the largest value of each component in the two vectors.
Parameters
- vecA: vec2
- vecB: vec2
Returns vec2

`Static`min

min(vecA: vec2, vecB: vec2): vec2
Returns a new vector containing the smallest value of each component in the two vectors.
Parameters
- vecA: vec2
- vecB: vec2
Returns vec2

moveTowards

moveTowards(point: vec2, magnitude: number): vec2
Returns a copy of the vector moved towards the point point by the amount magnitude.
Parameters
- point: vec2
- magnitude: number
Returns vec2

moveTowardsInPlace

moveTowardsInPlace(point: vec2, magnitude: number): void
Moves this vector towards point by magnitude in place.
Parameters
- point: vec2
- magnitude: number
Returns void

mult

mult(vec: vec2): vec2
Returns the component-wise multiplication product of the vector and vec.
Parameters
- vec: vec2
Returns vec2

multInPlace

multInPlace(vec: vec2): void
Multiplies this vector by vec component-wise in place.
Parameters
- vec: vec2
Returns void

normalize

normalize(): vec2
Returns a copy of the vector with its length scaled to 1.

Returns vec2

normalizeInPlace

normalizeInPlace(): void
Scales this vector's length to 1 in place.

Returns void

`Static`one

one(): vec2
Returns the vector (1, 1).

Returns vec2

project

project(vec: vec2): vec2
Returns a copy of the vector projected onto the vector onto.
Parameters
- vec: vec2
Returns vec2

projectInPlace

projectInPlace(onto: vec2): void
Projects this vector onto the vector onto in place.
Parameters
- onto: vec2
Returns void

projectOnPlane

projectOnPlane(planeNormal: vec2): vec2
Projects the vector onto the plane defined by planeNormal.
Parameters
- planeNormal: vec2
Returns vec2

projectOnPlaneInPlace

projectOnPlaneInPlace(planeNormal: vec2): void
Projects this vector onto the plane defined by planeNormal in place.
Parameters
- planeNormal: vec2
Returns void

`Static`randomDirection

randomDirection(): vec2
Generates a random 2D unit vector. Equivalent to a random point on a unit-radius circle.

Returns vec2
Deprecated
Use Math.randomUnitVector or Math.setRandomUnitVector instead.

Deprecated

`Static`randomUnitVector

randomUnitVector(): vec2
Generates a random 2D unit vector. Equivalent to a random point on a unit-radius circle.

Returns vec2

reflect

reflect(vec: vec2): vec2
Returns a copy of the vector reflected across the plane defined by planeNormal.
Parameters
- vec: vec2
Returns vec2

reflectInPlace

reflectInPlace(planeNormal: vec2): void
Reflects this vector across the plane defined by planeNormal in place.
Parameters
- planeNormal: vec2
Returns void

`Static`right

right(): vec2
Returns the vector (1, 0).

Returns vec2

scale

scale(vec: vec2): vec2
Returns the component-wise multiplication product of the vector and vec.
Parameters
- vec: vec2
Returns vec2

scaleInPlace

scaleInPlace(vec: vec2): void
Multiplies this vector by vec component-wise in place.
Parameters
- vec: vec2
Returns void

sub

sub(vec: vec2): vec2
Returns the vector minus vec.
Parameters
- vec: vec2
Returns vec2

subInPlace

subInPlace(vec: vec2): void
Subtracts vec from this vector in place.
Parameters
- vec: vec2
Returns void

toString

toString(): string
Returns a string representation of the vector.

Returns string

uniformScale

uniformScale(scale: number): vec2
Multiplies the components of this vector by scale.
Parameters
- scale: number
Returns vec2

uniformScaleInPlace

uniformScaleInPlace(scale: number): void
Multiplies the components of this vector by scale in place.
Parameters
- scale: number
Returns void

`Static`up

up(): vec2
Returns the vector (0, 1).

Returns vec2

`Static`zero

zero(): vec2
Returns the vector (0, 0).

Returns vec2

Class vec2

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns vec2

Properties

g

length

lengthSquared

r

x

y

Methods

add

Parameters

Returns vec2

addInPlace

Parameters

Returns void

angleTo

Parameters

Returns number

clampLength

Parameters

Returns vec2

clampLengthInPlace

Parameters

Returns void

clone

Returns vec2

copyFrom

Parameters

Returns void

distance

Parameters

Returns number

distanceSquared

Parameters

Returns number

div

Parameters

Returns vec2

divInPlace

Parameters

Returns void

dot

Parameters

Returns number

Staticdown

Returns vec2

equal

Parameters

Returns boolean

fill

Parameters

Returns void

Staticleft

Returns vec2

Staticlerp

Parameters

Returns vec2

lerpInPlace

Parameters

Returns void

Staticmax

Parameters

Returns vec2

Staticmin

Parameters

Returns vec2

moveTowards

Parameters

Returns vec2

moveTowardsInPlace

Parameters

`Static`down

`Static`left

`Static`lerp

`Static`max

`Static`min

`Static`one

`Static`randomDirection

`Static`randomUnitVector

`Static`right

`Static`up

`Static`zero