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

Properties

g length lengthSquared r x y

Methods

add angleTo clampLength distance distanceSquared div dot equal moveTowards mult normalize project projectOnPlane reflect scale sub toString uniformScale

Constructors

constructor

  • new vec2(x, y): 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

  • Returns the vector plus vec.

    Parameters

    Returns vec2

angleTo

  • angleTo(vec): number

  • Returns the angle between the vector and vec.

    Parameters

    Returns number

clampLength

  • clampLength(length): vec2

  • Returns a copy of the vector with its length clamped to length.

    Parameters

    • length: number

    Returns vec2

distance

  • distance(vec): number

  • Returns the distance between the vector and the vector vec.

    Parameters

    Returns number

distanceSquared

  • distanceSquared(vec): number

  • Like distance(), but returns the squared distance between vectors.

    Parameters

    Returns number

div

  • div(vec): vec2

  • Returns the division of the vector by the vector vec.

    Parameters

    Returns vec2

dot

  • dot(vec): number

  • Returns the dot product of the vector and vec.

    Parameters

    Returns number

equal

  • equal(vec): boolean

  • Returns whether this is equal to vec.

    Parameters

    Returns boolean

moveTowards

  • moveTowards(point, magnitude): vec2

  • Returns a copy of the vector moved towards the point point by the amount magnitude.

    Parameters

    • point: vec2
    • magnitude: number

    Returns vec2

mult

  • mult(vec): vec2

  • Returns the component-wise multiplication product of the vector and vec.

    Parameters

    Returns vec2

normalize

  • normalize(): vec2

  • Returns a copy of the vector with its length scaled to 1.

    Returns vec2

project

  • project(vec): vec2

  • Returns a copy of the vector projected onto the vector vec.

    Parameters

    Returns vec2

projectOnPlane

  • projectOnPlane(normal): vec2

  • Projects the vector onto the plane represented by the normal normal.

    Parameters

    Returns vec2

reflect

  • reflect(vec): vec2

  • Returns a copy of the vector reflected across the plane defined by the normal vec.

    Parameters

    Returns vec2

scale

  • scale(vec): vec2

  • Returns the component-wise multiplication product of the vector and vec.

    Parameters

    Returns vec2

sub

  • sub(vec): vec2

  • Returns the vector minus vec.

    Parameters

    Returns vec2

toString

  • toString(): string

  • Returns a string representation of the vector.

    Returns string

uniformScale

  • uniformScale(scale): vec2

  • Multiplies the components by the number scale.

    Parameters

    • scale: number

    Returns vec2

Settings

Member Visibility

On This Page

Constructors
Properties
Methods