@casual-simulation/aux-common 3.0.9 → 3.0.11

package/math/Vector2.js

@@ -0,0 +1,287 @@
+/**
+ * Defines a class that represents a 2D point in space.
+ */
+export class Vector2 {
+    /**
+     * Constructs a new 2D vector with the given X and Y values.
+     * @param x The X value of the vector.
+     * @param y The Y value of the vector.
+     *
+     * @example Create a new Vector2 object with the position (2, 3).
+     * let myVector = new Vector2(2, 3);
+     *
+     * os.toast(`X: ${myVector.x}, Y: ${myVector.y}`);
+     *
+     * @example Move this bot to (10, 15) in the home dimension.
+     * tags.homePosition = new Vector2(10, 15);
+     */
+    constructor(x = 0, y = 0) {
+        this.x = x;
+        this.y = y;
+        Object.freeze(this);
+    }
+    /**
+     * Creates a 2D vector with the given X and Y values that is normalized immediately upon creation.
+     * @param x The X value of the vector.
+     * @param y The Y value of the vector.
+     *
+     * @example Create a normalized vector
+     * const vector = Vector2.createNormalized(1, 2);
+     */
+    static createNormalized(x, y) {
+        const length = Math.sqrt(x * x + y * y);
+        return new Vector2(x / length, y / length);
+    }
+    /**
+     * Calculates the angle between the two given vectors and returns the result in radians.
+     * @param first The first vector that should be used for comparision.
+     * @param second The second vector that should be used for comparision.
+     *
+     * @example Find the angle between two vectors.
+     * const first = new Vector2(
+     *     Math.cos(Math.PI / 3),
+     *     Math.sin(Math.PI / 3)
+     * ); // 60 degrees
+     * const second = new Vector2(
+     *     Math.cos(Math.PI / 2),
+     *     Math.sin(Math.PI / 2)
+     * ); // 90 degrees
+     *
+     * const angle = Vector2.angleBetween(first, second);
+     * os.toast(angle);
+     */
+    static angleBetween(first, second) {
+        const dot = first.dot(second);
+        const l1 = first.length();
+        const l2 = second.length();
+        return Math.acos(dot / (l1 * l2));
+    }
+    /**
+     * Calculates the distance between the two given vectors and returns the result.
+     * @param first The first vector that should be used for comparision.
+     * @param second The second vector that should be used for comparision.
+     *
+     * @example Find the distance between two vectors.
+     * const first = new Vector2(5, 10);
+     * const second = new Vector2(9, 2);
+     * const distance = Vector2.distanceBetween(first, second);
+     *
+     * os.toast(`Distance: ${distance}`);
+     */
+    static distanceBetween(first, second) {
+        const direction = second.subtract(first);
+        return direction.length();
+    }
+    /**
+     * Constructs a new vector that is the linear interpolation between the given start and end positions.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     * @param start The start position.
+     * @param finish The end position.
+     * @param amount The amount that the resulting position should be interpolated between the start and end positions.  Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     *
+     * @example Find the position that is halfway between two vectors.
+     * const start = new Vector2(5, 10);
+     * const finish = new Vector2(9, 2);
+     * const halfway = Vector2.interpolatePosition(start, finish, 0.5);
+     *
+     * os.toast(halfway);
+     *
+     * @example Find the position that is 1/4 between two vectors.
+     * const start = new Vector2(5, 10);
+     * const finish = new Vector2(9, 2);
+     * const halfway = Vector2.interpolatePosition(start, finish, 0.25);
+     *
+     * os.toast(halfway);
+     */
+    static interpolatePosition(start, finish, amount) {
+        const dir = finish.subtract(start);
+        const lerp = dir.multiplyScalar(amount);
+        return start.add(lerp);
+    }
+    /**
+     * Constructs a new vector that is the directional linear interpolation between the given start and end positions.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     *
+     * This function works similarly to interpolatePosition(), except the result is always a normalized vector.
+     *
+     * @param start The start position.
+     * @param finish The end position.
+     * @param amount The amount that the resulting position should be interpolated between the start and end positions.  Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     *
+     * @example Find the direction that points halfway between the two vectors.
+     * const start = new Vector2(5, 10);
+     * const finish = new Vector2(9, 2);
+     * const halfway = Vector2.interpolatePosition(start, finish, 0.5);
+     *
+     * os.toast(halfway);
+     */
+    static interpolateDirection(start, finish, amount) {
+        return Vector2.interpolatePosition(start, finish, amount).normalize();
+    }
+    /**
+     * Adds this vector with the other vector and returns the result.
+     * @param other The other vector to add with this vector.
+     *
+     * @example Add two vectors together.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const added = first.add(second);
+     *
+     * os.toast(added); // Prints (4, 6)
+     */
+    add(other) {
+        return new Vector2(this.x + other.x, this.y + other.y);
+    }
+    /**
+     * Subtracts the other vector from this vector and returns the result.
+     * @param other The other vector that should be subtracted from this vector.
+     *
+     * @example Subtract two vectors.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const subtracted = first.subtract(second);
+     * os.toast(subtracted);
+     *
+     * @example Find the direction from one vector to another.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     *
+     * const directionFromFirstToSecond = second.subtract(first);
+     * const directionFromSecondToFirst = first.subtract(second);
+     *
+     * os.toast(`first -> second = ${directionFromFirstToSecond}; second -> first = ${directionFromSecondToFirst}`);
+     */
+    subtract(other) {
+        return new Vector2(this.x - other.x, this.y - other.y);
+    }
+    /**
+     * Multiplies each component of this vector by the given value and returns the result.
+     * @param scale The scale that should be applied to this vector.
+     *
+     * @example Scale a vector by 10.
+     * const myVector = new Vector2(1, 1);
+     * const scaled = myVector.multiplyScalar(10);
+     * os.toast(scaled); // Prints (10, 10)
+     */
+    multiplyScalar(scale) {
+        return new Vector2(this.x * scale, this.y * scale);
+    }
+    /**
+     * Multiplies this vector by the given other vector and returns the result.
+     * @param other The other vector to multiply with this vector.
+     *
+     * @example Multiply two vectors together.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const multiplied = first.multiply(second);
+     *
+     * os.toast(multiplied); // Prints (3, 8)
+     */
+    multiply(other) {
+        return new Vector2(this.x * other.x, this.y * other.y);
+    }
+    /**
+     * Calculates the dot product of this vector compared to the given other vector.
+     * Returns a number that is positive if the vectors point in the same direction,
+     * negative if they point in opposite directions, and zero if they are perpendicular.
+     * For normalized vectors, this value is clamped to 1 and -1.
+     * @param other The other vector to calculate the dot product with.
+     *
+     * @example Determine how two vectors are pointing towards/away from the same direction.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     *
+     * const dot = first.dot(second);
+     * if (dot < 0) {
+     *     os.toast("Vectors are pointing away from each other!");
+     * } else if (dot === 0) {
+     *     os.toast("Vectors 90 degrees away from each other!");
+     * } else {
+     *     os.toast("Vectors are pointing towards from each other!");
+     * }
+     */
+    dot(other) {
+        return this.x * other.x + this.y * other.y;
+    }
+    /**
+     * Calculates the length of this vector and returns the result.
+     *
+     * @example Get the length of the vector.
+     * const myVector = new Vector2(1, 2);
+     * const length = myVector.length();
+     *
+     * os.toast(`Vector is ${length} units long`);
+     */
+    length() {
+        return Math.sqrt(this.x * this.x + this.y * this.y);
+    }
+    /**
+     * Calculates the square length of this vector and returns the result.
+     * This is equivalent to length^2, but it is faster to calculate than length because it doesn't require
+     * calculating a square root.
+     *
+     * @example Get the square length of the vector.
+     * const myVector = new Vector2(1, 2);
+     * const length = myVector.squareLength();
+     *
+     * os.toast(`Vector is ${length}^2 units long`);
+     */
+    squareLength() {
+        return this.x * this.x + this.y * this.y;
+    }
+    /**
+     * Calculates the normalized version of this vector and returns it.
+     * A normalized vector is a vector whose length equals 1.
+     *
+     * Normalizing a vector preserves its directionality while making the length (i.e. scale) of it 1.
+     *
+     * @example Normalize a vector.
+     * const myVector = new Vector2(1, 2);
+     * const normalized = myVector.normalize();
+     *
+     * os.toast(`Vector: ${myVector}, Normalized: ${normalized}`);
+     */
+    normalize() {
+        const length = this.length();
+        return new Vector2(this.x / length, this.y / length);
+    }
+    /**
+     * Negates each component of this vector and returns a new vector that contains the result.
+     *
+     * @example Negate a vector.
+     * const myVector = new Vector2(1, 2);
+     * const negated = myVector.negate();
+     *
+     * os.toast(`Vector: ${myVector}, Negated: ${negated}`);
+     */
+    negate() {
+        return new Vector2(-this.x, -this.y);
+    }
+    /**
+     * Converts this vector to a human-readable string representation.
+     *
+     * @example Get a string of a vector.
+     * const myVector = new Vector2(1, 2);
+     * const vectorString = myVector.toString();
+     *
+     * os.toast('My Vector: ' + vectorString);
+     */
+    toString() {
+        return `Vector2(${this.x}, ${this.y})`;
+    }
+    /**
+     * Determines if this vector equals the other vector.
+     * @param other The other vector.
+     *
+     * @example Determine if two vectors represent the same value.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const third = new Vector2(1, 2);
+     *
+     * os.toast(`first == second: ${first.equals(second)}; first == third: ${first.equals(third)}`)
+     */
+    equals(other) {
+        return this.x === other.x && this.y === other.y;
+    }
+}
+//# sourceMappingURL=Vector2.js.map

package/math/Vector2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vector2.js","sourceRoot":"","sources":["Vector2.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,OAAO;IAWhB;;;;;;;;;;;;OAYG;IACH,YAAY,IAAY,CAAC,EAAE,IAAY,CAAC;QACpC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,gBAAgB,CAAC,CAAS,EAAE,CAAS;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACxC,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,YAAY,CAAC,KAAc,EAAE,MAAe;QAC/C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAC1B,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,eAAe,CAAC,KAAc,EAAE,MAAe;QAClD,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,mBAAmB,CACtB,KAAc,EACd,MAAe,EACf,MAAc;QAEd,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACxC,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,oBAAoB,CACvB,KAAc,EACd,MAAe,EACf,MAAc;QAEd,OAAO,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAc;QACd,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,KAAc;QACnB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CAAC,KAAa;QACxB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAc;QACnB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,CAAC,KAAc;QACd,OAAO,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY;QACR,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS;QACL,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,MAAM,EAAE,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM;QACF,OAAO,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ;QACJ,OAAO,WAAW,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAc;QACjB,OAAO,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;IACpD,CAAC;CACJ"}

package/math/Vector3.d.ts

@@ -0,0 +1,318 @@
+import { Vector2 } from './Vector2';
+/**
+ * Defines a class that represents a 3D point in space.
+ */
+export declare class Vector3 {
+    /**
+     * The X value of this vector.
+     */
+    x: number;
+    /**
+     * The Y value of this vector.
+     */
+    y: number;
+    /**
+     * The Z value of this vector.
+     */
+    z: number;
+    /**
+     * Gets a new Vector2 that contains this vector's X and Y components.
+     */
+    get xy(): Vector2;
+    /**
+     * Gets a new Vector2 that contains this vector's X and Z components.
+     */
+    get xz(): Vector2;
+    /**
+     * Gets a new Vector2 that contains this vector's Y and Z components.
+     */
+    get yz(): Vector2;
+    /**
+     * Constructs a new 3D vector with the given X and Y values.
+     * @param x The X value of the vector.
+     * @param y The Y value of the vector.
+     * @param z The Z value of the vector.
+     *
+     * @example Create a new Vector3 object with the position (2, 3, 4).
+     * let myVector = new Vector3(2, 3, 4);
+     *
+     * os.toast(`X: ${myVector.x}, Y: ${myVector.y}, Z: ${myVector.z}`);
+     *
+     * @example Move this bot to (1, 2, 3) in the home dimension.
+     * tags.homePosition = new Vector3(1, 2, 3);
+     */
+    constructor(x?: number, y?: number, z?: number);
+    /**
+     * Creates a 3D vector with the given X and Y values that is normalized immediately upon creation.
+     * @param x The X value of the vector.
+     * @param y The Y value of the vector.
+     * @param z The Z value of the vector.
+     *
+     * @example Create a normalized vector
+     * const vector = Vector3.createNormalized(1, 2, 3);
+     */
+    static createNormalized(x: number, y: number, z: number): Vector3;
+    /**
+     * Calculates the angle between the two given vectors and returns the result in radians.
+     * @param first The first vector that should be used for comparision.
+     * @param second The second vector that should be used for comparision.
+     *
+     * @example Find the angle between two vectors.
+     * const first = new Vector3(
+     *     Math.cos(Math.PI / 3),
+     *     Math.sin(Math.PI / 3),
+     *     0,
+     * ); // 60 degrees
+     * const second = new Vector3(
+     *     Math.cos(Math.PI / 2),
+     *     Math.sin(Math.PI / 2),
+     *     0
+     * ); // 90 degrees
+     *
+     * const angle = Vector3.angleBetween(first, second);
+     * os.toast(angle);
+     */
+    static angleBetween(first: Vector3, second: Vector3): number;
+    /**
+     * Calculates the distance between the two given vectors and returns the result.
+     * @param first The first vector that should be used for comparision.
+     * @param second The second vector that should be used for comparision.
+     *
+     * @example Find the distance between two vectors.
+     * const first = new Vector3(5, 10, 3);
+     * const second = new Vector3(9, 2, 6);
+     * const distance = Vector3.distanceBetween(first, second);
+     *
+     * os.toast(`Distance: ${distance}`);
+     */
+    static distanceBetween(first: Vector3, second: Vector3): number;
+    /**
+     * Constructs a new vector that is the linear interpolation between the given start and end positions.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     * @param start The start position.
+     * @param finish The end position.
+     * @param amount The amount that the resulting position should be interpolated between the start and end positions.  Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     *
+     * @example Find the position that is halfway between two vectors.
+     * const start = new Vector3(5, 10, 15);
+     * const finish = new Vector3(9, 2, 6);
+     * const halfway = Vector3.interpolatePosition(start, finish, 0.5);
+     *
+     * os.toast(halfway);
+     *
+     * @example Find the position that is 1/4 between two vectors.
+     * const start = new Vector3(5, 10, 15);
+     * const finish = new Vector3(9, 2, 6);
+     * const halfway = Vector3.interpolatePosition(start, finish, 0.25);
+     *
+     * os.toast(halfway);
+     */
+    static interpolatePosition(start: Vector3, finish: Vector3, amount: number): Vector3;
+    /**
+     * Constructs a new vector that is the directional linear interpolation between the given start and end positions.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     *
+     * This function works similarly to interpolatePosition(), except the result is always a normalized vector.
+     *
+     * @param start The start position.
+     * @param finish The end position.
+     * @param amount The amount that the resulting position should be interpolated between the start and end positions.  Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     *
+     * @example Find the direction that points halfway between the two vectors.
+     * const start = new Vector3(5, 10, 16);
+     * const finish = new Vector3(9, 2, 6);
+     * const halfway = Vector3.interpolatePosition(start, finish, 0.5);
+     *
+     * os.toast(halfway);
+     */
+    static interpolateDirection(start: Vector3, finish: Vector3, amount: number): Vector3;
+    /**
+     * Adds this vector with the other vector and returns the result.
+     * @param other The other vector to add with this vector.
+     *
+     * @example Add two vectors together.
+     * const first = new Vector3(1, 2, 3);
+     * const second = new Vector3(3, 4, 5);
+     * const added = first.add(second);
+     *
+     * os.toast(added); // Prints (4, 6, 8)
+     */
+    add(other: Vector3): Vector3;
+    /**
+     * Subtracts the other vector from this vector and returns the result.
+     * @param other The other vector that should be subtracted from this vector.
+     *
+     * @example Subtract two vectors.
+     * const first = new Vector3(1, 2, 3);
+     * const second = new Vector3(3, 4, 5);
+     * const subtracted = first.subtract(second);
+     * os.toast(subtracted);
+     *
+     * @example Find the direction from one vector to another.
+     * const first = new Vector3(1, 2, 3);
+     * const second = new Vector3(3, 4, 5);
+     *
+     * const directionFromFirstToSecond = second.subtract(first);
+     * const directionFromSecondToFirst = first.subtract(second);
+     *
+     * os.toast(`first -> second = ${directionFromFirstToSecond}; second -> first = ${directionFromSecondToFirst}`);
+     */
+    subtract(other: Vector3): Vector3;
+    /**
+     * Multiplies each component of this vector by the given value and returns the result.
+     * @param scale The scale that should be applied to this vector.
+     *
+     * @example Scale a vector by 10.
+     * const myVector = new Vector3(1, 1, 1);
+     * const scaled = myVector.multiplyScalar(10);
+     * os.toast(scaled); // Prints (10, 10, 10)
+     */
+    multiplyScalar(scale: number): Vector3;
+    /**
+     * Multiplies this vector by the given other vector and returns the result.
+     * @param other The other vector to multiply with this vector.
+     *
+     * @example Multiply two vectors together.
+     * const first = new Vector3(1, 2, 3);
+     * const second = new Vector3(3, 4, 5);
+     * const multiplied = first.multiply(second);
+     *
+     * os.toast(multiplied); // Prints (3, 8, 15)
+     */
+    multiply(other: Vector3): Vector3;
+    /**
+     * Calculates the dot product of this vector compared to the given other vector.
+     * Returns a number that is positive if the vectors point in the same direction,
+     * negative if they point in opposite directions, and zero if they are perpendicular.
+     * For normalized vectors, this value is clamped to 1 and -1.
+     * @param other The other vector to calculate the dot product with.
+     *
+     * @example Determine how two vectors are pointing towards/away from the same direction.
+     * const first = new Vector3(1, 2, 3);
+     * const second = new Vector3(3, 4, 5);
+     *
+     * const dot = first.dot(second);
+     * if (dot < 0) {
+     *     os.toast("Vectors are pointing away from each other!");
+     * } else if (dot === 0) {
+     *     os.toast("Vectors 90 degrees away from each other!");
+     * } else {
+     *     os.toast("Vectors are pointing towards from each other!");
+     * }
+     */
+    dot(other: Vector3): number;
+    /**
+     * Calculates the cross product of this vector with the given other vector.
+     * Returns a new vector that is perpendicular to both vectors.
+     * Note that the order of the vectors greatly matters. For example, (1, 0, 0).cross(0, 1, 0) === (0, 0, 1) but (0, 1, 0).cross(1, 0, 0) === (0, 0, -1).
+     * @param other The other vector to calculate the cross product with.
+     *
+     * @example Calculate a vector that is perpendicular to two vectors.
+     * const first = new Vector3(1, 0, 0);
+     * const second = new Vector3(0, 1, 0);
+     *
+     * const result = first.cross(second);
+     * os.toast(`Result: ${result}`); // Prints (0, 0, 1)
+     */
+    cross(other: Vector3): Vector3;
+    /**
+     * Calculates the length of this vector and returns the result.
+     *
+     * @example Get the length of the vector.
+     * const myVector = new Vector3(1, 2, 3);
+     * const length = myVector.length();
+     *
+     * os.toast(`Vector is ${length} units long`);
+     */
+    length(): number;
+    /**
+     * Calculates the square length of this vector and returns the result.
+     * This is equivalent to length^2, but it is faster to calculate than length because it doesn't require
+     * calculating a square root.
+     *
+     * @example Get the square length of the vector.
+     * const myVector = new Vector3(1, 2, 3);
+     * const length = myVector.squareLength();
+     *
+     * os.toast(`Vector is ${length}^2 units long`);
+     */
+    squareLength(): number;
+    /**
+     * Calculates the normalized version of this vector and returns it.
+     * A normalized vector is a vector whose length equals 1.
+     *
+     * Normalizing a vector preserves its directionality while making the length (i.e. scale) of it 1.
+     *
+     * @example Normalize a vector.
+     * const myVector = new Vector3(1, 2, 3);
+     * const normalized = myVector.normalize();
+     *
+     * os.toast(`Vector: ${myVector}, Normalized: ${normalized}`);
+     */
+    normalize(): Vector3;
+    /**
+     * Negates each component of this vector and returns a new vector that contains the result.
+     *
+     * @example Negate a vector.
+     * const myVector = new Vector3(1, 2, 3);
+     * const negated = myVector.negate();
+     *
+     * os.toast(`Vector: ${myVector}, Negated: ${negated}`);
+     */
+    negate(): Vector3;
+    /**
+     * Converts this vector to a human-readable string representation.
+     *
+     * @example Get a string of a vector.
+     * const myVector = new Vector3(1, 2, 3);
+     * const vectorString = myVector.toString();
+     *
+     * os.toast('My Vector: ' + vectorString);
+     */
+    toString(): string;
+    /**
+     * Determines if this vector equals the other vector.
+     * @param other The other value to compare to.
+     *
+     * @example Determine if two vectors represent the same value.
+     * const first = new Vector3(1, 2, 3);
+     * const second = new Vector3(3, 4, 5);
+     * const third = new Vector3(1, 2, 3);
+     *
+     * os.toast(`first == second: ${first.equals(second)}; first == third: ${first.equals(third)}`)
+     */
+    equals(other: Vector3): boolean;
+}
+/**
+ * A 3D vector that contains (0, 0, 0).
+ */
+export declare const ZERO: Vector3;
+/**
+ * A 3D vector that contains (1, 1, 1).
+ */
+export declare const ONE: Vector3;
+/**
+ * A 3D vector that contains (0, 1, 0).
+ */
+export declare const FORWARD: Vector3;
+/**
+ * A 3D vector that contains (0, -1, 0).
+ */
+export declare const BACK: Vector3;
+/**
+ * A 3D vector that contains (1, 0, 0).
+ */
+export declare const RIGHT: Vector3;
+/**
+ * A 3D vector that contains (-1, 0, 0).
+ */
+export declare const LEFT: Vector3;
+/**
+ * A 3D vector that contains (0, 0, 1).
+ */
+export declare const UP: Vector3;
+/**
+ * A 3D vector that contains (0, 0, -1).
+ */
+export declare const DOWN: Vector3;
+//# sourceMappingURL=Vector3.d.ts.map