Options
All
• Public
• Public/Protected
• All

# Class Vector

## Constructors

• Vector constructor, creating an instance with the given coordinates

#### Parameters

• ##### xOrCoords: number | ICoordinates

X coordinate or the whole ICoordinates object

• ##### Optional y: number

Y coordinate

## Properties

x: number

X coordinate of the vector

y: number

Y coordinate of the vector

## Accessors

• get angle(): number
• set angle(angle: number): void
• Returns the current vector angle, based on x,y values

#### Returns number

• Sets the x,y values using an angle, length must be greater than 0

#### Parameters

• ##### angle: number

the angle to set

#### Returns void

• get length(): number
• set length(length: number): void
• Returns the current vector length, based on x,y values

#### Returns number

• Sets the x,y values using the length

#### Parameters

• ##### length: number

the length to set

## Methods

• Adds the current and the given vector together, without modifying them

#### Parameters

• ##### v: Vector

the vector used for the sum operation

#### Returns Vector

the sum vector

• Adds the given vector to the current one, modifying it

#### Parameters

• ##### v: Vector

the vector to add to the current one

#### Returns void

• Copies the current vector, cloning it

#### Returns Vector

the cloned current vector

• Calculates the distance between the current vector and the given one

#### Parameters

• ##### v: Vector

the vector used for calculating the distance from the current one

#### Returns number

the distance between the vectors

• distanceToSq(v: Vector): number
• Get the distance squared between two vectors

#### Parameters

• ##### v: Vector

the vector used for calculating the distance from the current one

#### Returns number

the distance squared between the vectors

• Divides the given scalar and the current vector together, without modifying it

#### Parameters

• ##### n: number

the scalar value to divide from the current vector

#### Returns Vector

• divTo(n: number): void
• Divides the given scalar from the current vector, modifying it

#### Parameters

• ##### n: number

the scalar value to divide from the current vector

#### Returns void

• getLengthSq(): number
• manhattanDistanceTo(v: Vector): number
• Returns the Manhattan distance between all vectors

#### Parameters

• ##### v: Vector

the vector used for calculating the distance from the current one

#### Returns number

the Manhattan distance between the vectors

• Multiplies the given scalar and the current vector together, without modifying it

#### Parameters

• ##### n: number

the scalar value to multiply to the vector

#### Returns Vector

the multiplied vector

• multTo(n: number): void
• Multiplies the given scalar to the current vector, modifying it

#### Parameters

• ##### n: number

the scalar value to multiply to the vector

#### Returns void

• Creates a new vector, rotating the current one, without modifying it

#### Parameters

• ##### angle: number

the rotation angle

#### Returns Vector

• Set the vector to the specified velocity

#### Parameters

• ##### v: ICoordinates

the Vector used to set the current vector

#### Returns void

• Subtracts the current and the given vector together, without modifying them

#### Parameters

• ##### v: Vector

the vector used for the subtract operation

#### Returns Vector

the subtracted vector

• Subtracts the given vector from the current one, modifying it

#### Parameters

• ##### v: Vector

the vector to subtract from the current one

#### Returns void

• updateFromAngle(angle: number, length: number): void
• Updates the current vector, using angle and length values, instead of x and y

#### Parameters

• ##### angle: number

the new angle

• ##### length: number

the new length

#### Returns void

• Clones the given vector

#### Parameters

• ##### source: Vector

the vector to clone

#### Returns Vector

a new vector instance, created from the given one

• Creates a new vector instance

#### Parameters

• ##### x: number | ICoordinates

X coordinate

• ##### Optional y: number

Y coordinate

#### Returns Vector

the new vector created