@minecraft/math 1.0.0

package/README.md

@@ -0,0 +1,55 @@
+# Minecraft Math
+
+A set of utilities and functions for common math operations. Major pieces are covered below.
+
+## Vector3
+
+A set of utility functions and a wrapper class for common vector3 operations. Two distinct patterns are supported, a more pure computational approach operating on the Vector3 interface with no mutation, and a separate wrapper object oriented approach following a "builder" pattern. It is mostly preference whether you prefer the more "mutation" heavy pattern or the functional pattern, it depends on the structure of your code. Under the covers, the same helpers are used.
+
+### Pure Functional Style
+
+```ts
+import { Vector3, world } from '@minecraft/server';
+import { MinecraftDimensionTypes } from '@minecraft/vanilla-data';
+import { Vector3Utils } from '@minecraft/math';
+
+const vectorA: Vector3 = {x: 1, y: 2, z:3};
+const vectorB: Vector3 = {x: 4, y: 5, z:6};
+
+const resultAdd = Vector3Utils.add(vectorA, vectorB); // {x:5, y:7, z:9}
+const resultSubtract = Vector3Utils.subtract(vectorA, vectorB); // {x:-3, y:-3, z:-3}
+const resultAdd = Vector3Utils.cross(vectorA, vectorB); // {x:-3, y:6, z:-3}
+
+console.log(toString(vectorA)); // Prints out "1, 2, 3"
+
+// Use your vectors with any @minecraft/server API
+const = dimension = world.getDimension(MinecraftDimensionTypes.Overworld);
+dimension.spawnParticle("minecraft:colored_flame_particle", resultAdd);
+```
+
+### Builder Style
+
+```ts
+import { Vector3, world } from '@minecraft/server';
+import { Vector3Builder } from '@minecraft/math';
+import { MinecraftDimensionTypes } from '@minecraft/vanilla-data';
+
+const vectorA: Vector3Builder = new Vector3Builder({x: 1, y: 2, z:3});
+const vectorB: Vector3 = {x: 4, y: 5, z:6};
+const vectorC: Vector3 = {x: 1, y: 3, z:5};
+
+// Mutates vectorA directly each time
+vectorA.add(vectorB).subtract(vectorC).cross(vectorB); // Final result {x:4, y:-8, z:4}
+
+console.log(vectorA.toString()); // Prints out "4, -8, 4"
+
+// Vector3Builder type can directly be used in APIs that accept Vector3
+const dimension = world.getDimension(MinecraftDimensionTypes.Overworld);
+dimension.spawnParticle("minecraft:colored_flame_particle", vectorA);
+```
+
+## How to use @minecraft/math in your project
+
+@minecraft/math is published to NPM and follows standard semver semantics. To use it in your project,
+
+- Download `@minecraft/math` from NPM by doing `npm install @minecraft/math` within your scripts pack. By using `@minecraft/math`, you will need to do some sort of bundling to merge the library into your packs code. We recommend using [esbuild](https://esbuild.github.io/getting-started/#your-first-bundle) for simplicity.

package/api-report/math.api.md

@@ -0,0 +1,125 @@
+## API Report File for "@minecraft/math"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Vector2 } from '@minecraft/server';
+import type { Vector3 } from '@minecraft/server';
+
+// @public
+export function clampNumber(val: number, min: number, max: number): number;
+
+// @public
+export class Vector2Builder implements Vector2 {
+    constructor(vec: Vector2, arg?: never);
+    constructor(x: number, y: number);
+    // (undocumented)
+    toString(options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+    // (undocumented)
+    x: number;
+    // (undocumented)
+    y: number;
+}
+
+// @public
+export class Vector2Utils {
+    static toString(v: Vector2, options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+}
+
+// @public
+export const VECTOR3_BACK: Vector3;
+
+// @public
+export const VECTOR3_DOWN: Vector3;
+
+// @public
+export const VECTOR3_EAST: Vector3;
+
+// @public
+export const VECTOR3_FORWARD: Vector3;
+
+// @public
+export const VECTOR3_LEFT: Vector3;
+
+// @public
+export const VECTOR3_NORTH: Vector3;
+
+// @public
+export const VECTOR3_ONE: Vector3;
+
+// @public
+export const VECTOR3_RIGHT: Vector3;
+
+// @public
+export const VECTOR3_SOUTH: Vector3;
+
+// @public
+export const VECTOR3_UP: Vector3;
+
+// @public
+export const VECTOR3_WEST: Vector3;
+
+// @public
+export const VECTOR3_ZERO: Vector3;
+
+// @public
+export class Vector3Builder implements Vector3 {
+    constructor(vec: Vector3, arg?: never, arg2?: never);
+    constructor(x: number, y: number, z: number);
+    add(v: Vector3): this;
+    assign(vec: Vector3): this;
+    clamp(limits: {
+        min?: Partial<Vector3>;
+        max?: Partial<Vector3>;
+    }): this;
+    cross(vec: Vector3): this;
+    dot(vec: Vector3): number;
+    equals(v: Vector3): boolean;
+    floor(): this;
+    magnitude(): number;
+    normalize(): this;
+    scale(val: number): this;
+    subtract(v: Vector3): this;
+    toString(options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+    // (undocumented)
+    x: number;
+    // (undocumented)
+    y: number;
+    // (undocumented)
+    z: number;
+}
+
+// @public
+export class Vector3Utils {
+    static add(v1: Vector3, v2: Vector3): Vector3;
+    static clamp(v: Vector3, limits?: {
+        min?: Partial<Vector3>;
+        max?: Partial<Vector3>;
+    }): Vector3;
+    static cross(a: Vector3, b: Vector3): Vector3;
+    static dot(a: Vector3, b: Vector3): number;
+    static equals(v1: Vector3, v2: Vector3): boolean;
+    static floor(v: Vector3): Vector3;
+    static magnitude(v: Vector3): number;
+    static normalize(v: Vector3): Vector3;
+    static scale(v1: Vector3, scale: number): Vector3;
+    static subtract(v1: Vector3, v2: Vector3): Vector3;
+    static toString(v: Vector3, options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/minecraft-math.js

@@ -0,0 +1,378 @@
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+
+// lib/general/clamp.js
+var require_clamp = __commonJS({
+  "lib/general/clamp.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.clampNumber = void 0;
+    function clampNumber(val, min, max) {
+      return Math.min(Math.max(val, min), max);
+    }
+    exports.clampNumber = clampNumber;
+  }
+});
+
+// lib/vector3/coreHelpers.js
+var require_coreHelpers = __commonJS({
+  "lib/vector3/coreHelpers.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.VECTOR3_SOUTH = exports.VECTOR3_NORTH = exports.VECTOR3_EAST = exports.VECTOR3_WEST = exports.VECTOR3_ZERO = exports.VECTOR3_ONE = exports.VECTOR3_BACK = exports.VECTOR3_FORWARD = exports.VECTOR3_RIGHT = exports.VECTOR3_LEFT = exports.VECTOR3_DOWN = exports.VECTOR3_UP = exports.Vector2Utils = exports.Vector3Utils = void 0;
+    var clamp_1 = require_clamp();
+    var Vector3Utils = class _Vector3Utils {
+      /**
+       * equals
+       *
+       * Check the equality of two vectors
+       */
+      static equals(v1, v2) {
+        return v1.x === v2.x && v1.y === v2.y && v1.z === v2.z;
+      }
+      /**
+       * add
+       *
+       * Add two vectors to produce a new vector
+       */
+      static add(v1, v2) {
+        return { x: v1.x + v2.x, y: v1.y + v2.y, z: v1.z + v2.z };
+      }
+      /**
+       * subtract
+       *
+       * Subtract two vectors to produce a new vector (v1-v2)
+       */
+      static subtract(v1, v2) {
+        return { x: v1.x - v2.x, y: v1.y - v2.y, z: v1.z - v2.z };
+      }
+      /** scale
+       *
+       * Multiple all entries in a vector by a single scalar value producing a new vector
+       */
+      static scale(v1, scale) {
+        return { x: v1.x * scale, y: v1.y * scale, z: v1.z * scale };
+      }
+      /**
+       * dot
+       *
+       * Calculate the dot product of two vectors
+       */
+      static dot(a, b) {
+        return a.x * b.x + a.y * b.y + a.z * b.z;
+      }
+      /**
+       * cross
+       *
+       * Calculate the cross product of two vectors. Returns a new vector.
+       */
+      static cross(a, b) {
+        return {
+          x: a.y * b.z - a.z * b.y,
+          y: a.z * b.x - a.x * b.z,
+          z: a.x * b.y - a.y * b.x
+        };
+      }
+      /**
+       * magnitude
+       *
+       * The magnitude of a vector
+       */
+      static magnitude(v) {
+        return Math.sqrt(v.x ** 2 + v.y ** 2 + v.z ** 2);
+      }
+      /**
+       * normalize
+       *
+       * Takes a vector 3 and normalizes it to a unit vector
+       */
+      static normalize(v) {
+        const mag = _Vector3Utils.magnitude(v);
+        return { x: v.x / mag, y: v.y / mag, z: v.z / mag };
+      }
+      /**
+       * floor
+       *
+       * Floor the components of a vector to produce a new vector
+       */
+      static floor(v) {
+        return { x: Math.floor(v.x), y: Math.floor(v.y), z: Math.floor(v.z) };
+      }
+      /**
+       * toString
+       *
+       * Create a string representation of a vector3
+       */
+      static toString(v, options) {
+        const decimals = options?.decimals ?? 2;
+        const str = [v.x.toFixed(decimals), v.y.toFixed(decimals), v.z.toFixed(decimals)];
+        return str.join(options?.delimiter ?? ", ");
+      }
+      /**
+       * clamp
+       *
+       * Clamps the components of a vector to limits to produce a new vector
+       */
+      static clamp(v, limits) {
+        return {
+          x: (0, clamp_1.clampNumber)(v.x, limits?.min?.x ?? Number.MIN_SAFE_INTEGER, limits?.max?.x ?? Number.MAX_SAFE_INTEGER),
+          y: (0, clamp_1.clampNumber)(v.y, limits?.min?.y ?? Number.MIN_SAFE_INTEGER, limits?.max?.y ?? Number.MAX_SAFE_INTEGER),
+          z: (0, clamp_1.clampNumber)(v.z, limits?.min?.z ?? Number.MIN_SAFE_INTEGER, limits?.max?.z ?? Number.MAX_SAFE_INTEGER)
+        };
+      }
+    };
+    exports.Vector3Utils = Vector3Utils;
+    var Vector2Utils = class {
+      /**
+       * toString
+       *
+       * Create a string representation of a vector2
+       */
+      static toString(v, options) {
+        const decimals = options?.decimals ?? 2;
+        const str = [v.x.toFixed(decimals), v.y.toFixed(decimals)];
+        return str.join(options?.delimiter ?? ", ");
+      }
+    };
+    exports.Vector2Utils = Vector2Utils;
+    exports.VECTOR3_UP = { x: 0, y: 1, z: 0 };
+    exports.VECTOR3_DOWN = { x: 0, y: -1, z: 0 };
+    exports.VECTOR3_LEFT = { x: -1, y: 0, z: 0 };
+    exports.VECTOR3_RIGHT = { x: 1, y: 0, z: 0 };
+    exports.VECTOR3_FORWARD = { x: 0, y: 0, z: 1 };
+    exports.VECTOR3_BACK = { x: 0, y: 0, z: -1 };
+    exports.VECTOR3_ONE = { x: 1, y: 1, z: 1 };
+    exports.VECTOR3_ZERO = { x: 0, y: 0, z: 0 };
+    exports.VECTOR3_WEST = { x: -1, y: 0, z: 0 };
+    exports.VECTOR3_EAST = { x: 1, y: 0, z: 0 };
+    exports.VECTOR3_NORTH = { x: 0, y: 0, z: 1 };
+    exports.VECTOR3_SOUTH = { x: 0, y: 0, z: -1 };
+  }
+});
+
+// lib/vector3/vectorWrapper.js
+var require_vectorWrapper = __commonJS({
+  "lib/vector3/vectorWrapper.js"(exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Vector2Builder = exports.Vector3Builder = void 0;
+    var coreHelpers_1 = require_coreHelpers();
+    var Vector3Builder = class {
+      constructor(first, y, z) {
+        if (typeof first === "object") {
+          this.x = first.x;
+          this.y = first.y;
+          this.z = first.z;
+        } else {
+          this.x = first;
+          this.y = y ?? 0;
+          this.z = z ?? 0;
+        }
+      }
+      /**
+       * Assigns the values of the passed in vector to this vector. Returns itself.
+       */
+      assign(vec) {
+        this.x = vec.x;
+        this.y = vec.y;
+        this.z = vec.z;
+        return this;
+      }
+      /**
+       * equals
+       *
+       * Check the equality of two vectors
+       */
+      equals(v) {
+        return coreHelpers_1.Vector3Utils.equals(this, v);
+      }
+      /**
+       * add
+       *
+       * Adds the vector v to this, returning itself.
+       */
+      add(v) {
+        return this.assign(coreHelpers_1.Vector3Utils.add(this, v));
+      }
+      /**
+       * subtract
+       *
+       * Subtracts the vector v from this, returning itself.
+       */
+      subtract(v) {
+        return this.assign(coreHelpers_1.Vector3Utils.subtract(this, v));
+      }
+      /** scale
+       *
+       * Scales this by the passed in value, returning itself.
+       */
+      scale(val) {
+        return this.assign(coreHelpers_1.Vector3Utils.scale(this, val));
+      }
+      /**
+       * dot
+       *
+       * Computes the dot product of this and the passed in vector.
+       */
+      dot(vec) {
+        return coreHelpers_1.Vector3Utils.dot(this, vec);
+      }
+      /**
+       * cross
+       *
+       * Computes the cross product of this and the passed in vector, returning itself.
+       */
+      cross(vec) {
+        return this.assign(coreHelpers_1.Vector3Utils.cross(this, vec));
+      }
+      /**
+       * magnitude
+       *
+       * The magnitude of the vector
+       */
+      magnitude() {
+        return coreHelpers_1.Vector3Utils.magnitude(this);
+      }
+      /**
+       * normalize
+       *
+       * Normalizes this vector, returning itself.
+       */
+      normalize() {
+        return this.assign(coreHelpers_1.Vector3Utils.normalize(this));
+      }
+      /**
+       * floor
+       *
+       * Floor the components of a vector to produce a new vector
+       */
+      floor() {
+        return this.assign(coreHelpers_1.Vector3Utils.floor(this));
+      }
+      /**
+       * toString
+       *
+       * Create a string representation of a vector
+       */
+      toString(options) {
+        return coreHelpers_1.Vector3Utils.toString(this, options);
+      }
+      /**
+       * clamp
+       *
+       * Clamps the components of a vector to limits to produce a new vector
+       */
+      clamp(limits) {
+        return this.assign(coreHelpers_1.Vector3Utils.clamp(this, limits));
+      }
+    };
+    exports.Vector3Builder = Vector3Builder;
+    var Vector2Builder = class {
+      constructor(first, y) {
+        if (typeof first === "object") {
+          this.x = first.x;
+          this.y = first.y;
+        } else {
+          this.x = first;
+          this.y = y ?? 0;
+        }
+      }
+      toString(options) {
+        return coreHelpers_1.Vector2Utils.toString(this, options);
+      }
+    };
+    exports.Vector2Builder = Vector2Builder;
+  }
+});
+
+// lib/vector3/index.js
+var require_vector3 = __commonJS({
+  "lib/vector3/index.js"(exports) {
+    "use strict";
+    var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function() {
+          return m[k];
+        } };
+      }
+      Object.defineProperty(o, k2, desc);
+    } : function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      o[k2] = m[k];
+    });
+    var __exportStar = exports && exports.__exportStar || function(m, exports2) {
+      for (var p in m)
+        if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p))
+          __createBinding(exports2, m, p);
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
+    __exportStar(require_coreHelpers(), exports);
+    __exportStar(require_vectorWrapper(), exports);
+  }
+});
+
+// lib/general/index.js
+var require_general = __commonJS({
+  "lib/general/index.js"(exports) {
+    "use strict";
+    var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function() {
+          return m[k];
+        } };
+      }
+      Object.defineProperty(o, k2, desc);
+    } : function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      o[k2] = m[k];
+    });
+    var __exportStar = exports && exports.__exportStar || function(m, exports2) {
+      for (var p in m)
+        if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p))
+          __createBinding(exports2, m, p);
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
+    __exportStar(require_clamp(), exports);
+  }
+});
+
+// lib/index.js
+var require_lib = __commonJS({
+  "lib/index.js"(exports) {
+    var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      var desc = Object.getOwnPropertyDescriptor(m, k);
+      if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+        desc = { enumerable: true, get: function() {
+          return m[k];
+        } };
+      }
+      Object.defineProperty(o, k2, desc);
+    } : function(o, m, k, k2) {
+      if (k2 === void 0)
+        k2 = k;
+      o[k2] = m[k];
+    });
+    var __exportStar = exports && exports.__exportStar || function(m, exports2) {
+      for (var p in m)
+        if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p))
+          __createBinding(exports2, m, p);
+    };
+    Object.defineProperty(exports, "__esModule", { value: true });
+    __exportStar(require_vector3(), exports);
+    __exportStar(require_general(), exports);
+  }
+});
+export default require_lib();
+//# sourceMappingURL=minecraft-math.js.map

package/dist/minecraft-math.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/general/clamp.ts", "../src/vector3/coreHelpers.ts", "../src/vector3/vectorWrapper.ts", "../src/vector3/index.ts", "../src/general/index.ts", "../src/index.ts"],
+  "sourcesContent": ["// Copyright (c) Mojang AB.  All rights reserved.\n\n/**\n * Clamps the passed in number to the passed in min and max values.\n *\n * @public\n */\nexport function clampNumber(val: number, min: number, max: number): number {\n    return Math.min(Math.max(val, min), max);\n}\n", "// Copyright (c) Mojang AB.  All rights reserved.\n\nimport type { Vector2, Vector3 } from '@minecraft/server';\nimport { clampNumber } from '../general/clamp';\n\n/**\n * Utilities operating on Vector3 objects. All methods are static and do not modify the input objects.\n *\n * @public\n */\nexport class Vector3Utils {\n    /**\n     * equals\n     *\n     * Check the equality of two vectors\n     */\n    static equals(v1: Vector3, v2: Vector3): boolean {\n        return v1.x === v2.x && v1.y === v2.y && v1.z === v2.z;\n    }\n\n    /**\n     * add\n     *\n     * Add two vectors to produce a new vector\n     */\n    static add(v1: Vector3, v2: Vector3): Vector3 {\n        return { x: v1.x + v2.x, y: v1.y + v2.y, z: v1.z + v2.z };\n    }\n\n    /**\n     * subtract\n     *\n     * Subtract two vectors to produce a new vector (v1-v2)\n     */\n    static subtract(v1: Vector3, v2: Vector3): Vector3 {\n        return { x: v1.x - v2.x, y: v1.y - v2.y, z: v1.z - v2.z };\n    }\n\n    /** scale\n     *\n     * Multiple all entries in a vector by a single scalar value producing a new vector\n     */\n    static scale(v1: Vector3, scale: number): Vector3 {\n        return { x: v1.x * scale, y: v1.y * scale, z: v1.z * scale };\n    }\n\n    /**\n     * dot\n     *\n     * Calculate the dot product of two vectors\n     */\n    static dot(a: Vector3, b: Vector3): number {\n        return a.x * b.x + a.y * b.y + a.z * b.z;\n    }\n\n    /**\n     * cross\n     *\n     * Calculate the cross product of two vectors. Returns a new vector.\n     */\n    static cross(a: Vector3, b: Vector3): Vector3 {\n        return {\n            x: a.y * b.z - a.z * b.y,\n            y: a.z * b.x - a.x * b.z,\n            z: a.x * b.y - a.y * b.x,\n        };\n    }\n\n    /**\n     * magnitude\n     *\n     * The magnitude of a vector\n     */\n    static magnitude(v: Vector3): number {\n        return Math.sqrt(v.x ** 2 + v.y ** 2 + v.z ** 2);\n    }\n\n    /**\n     * normalize\n     *\n     * Takes a vector 3 and normalizes it to a unit vector\n     */\n    static normalize(v: Vector3): Vector3 {\n        const mag = Vector3Utils.magnitude(v);\n        return { x: v.x / mag, y: v.y / mag, z: v.z / mag };\n    }\n\n    /**\n     * floor\n     *\n     * Floor the components of a vector to produce a new vector\n     */\n    static floor(v: Vector3): Vector3 {\n        return { x: Math.floor(v.x), y: Math.floor(v.y), z: Math.floor(v.z) };\n    }\n\n    /**\n     * toString\n     *\n     * Create a string representation of a vector3\n     */\n    static toString(v: Vector3, options?: { decimals?: number; delimiter?: string }): string {\n        const decimals = options?.decimals ?? 2;\n        const str: string[] = [v.x.toFixed(decimals), v.y.toFixed(decimals), v.z.toFixed(decimals)];\n        return str.join(options?.delimiter ?? ', ');\n    }\n\n    /**\n     * clamp\n     *\n     * Clamps the components of a vector to limits to produce a new vector\n     */\n    static clamp(\n        v: Vector3,\n        limits?: {\n            min?: Partial<Vector3>;\n            max?: Partial<Vector3>;\n        },\n    ): Vector3 {\n        return {\n            x: clampNumber(v.x, limits?.min?.x ?? Number.MIN_SAFE_INTEGER, limits?.max?.x ?? Number.MAX_SAFE_INTEGER),\n            y: clampNumber(v.y, limits?.min?.y ?? Number.MIN_SAFE_INTEGER, limits?.max?.y ?? Number.MAX_SAFE_INTEGER),\n            z: clampNumber(v.z, limits?.min?.z ?? Number.MIN_SAFE_INTEGER, limits?.max?.z ?? Number.MAX_SAFE_INTEGER),\n        };\n    }\n}\n\n/**\n * Utilities operating on Vector2 objects. All methods are static and do not modify the input objects.\n *\n * @public\n */\nexport class Vector2Utils {\n    /**\n     * toString\n     *\n     * Create a string representation of a vector2\n     */\n    static toString(v: Vector2, options?: { decimals?: number; delimiter?: string }): string {\n        const decimals = options?.decimals ?? 2;\n        const str: string[] = [v.x.toFixed(decimals), v.y.toFixed(decimals)];\n        return str.join(options?.delimiter ?? ', ');\n    }\n}\n\n/**\n * up\n *\n * A unit vector representing the world UP direction (0,1,0)\n *\n * @public\n */\nexport const VECTOR3_UP: Vector3 = { x: 0, y: 1, z: 0 };\n/**\n * down\n *\n * A unit vector representing the world DOWN direction (0,-1,0)\n *\n * @public\n */\nexport const VECTOR3_DOWN: Vector3 = { x: 0, y: -1, z: 0 };\n/**\n * left\n *\n * A unit vector representing the world LEFT direction (-1,0,0)\n *\n * @public\n */\nexport const VECTOR3_LEFT: Vector3 = { x: -1, y: 0, z: 0 };\n/**\n * right\n *\n * A unit vector representing the world RIGHT direction (1,0,0)\n *\n * @public\n */\nexport const VECTOR3_RIGHT: Vector3 = { x: 1, y: 0, z: 0 };\n/**\n * forward\n *\n * A unit vector representing the world FORWARD direction (0,0,1)\n *\n * @public\n */\nexport const VECTOR3_FORWARD: Vector3 = { x: 0, y: 0, z: 1 };\n/**\n * back\n *\n * A unit vector representing the world BACK direction (0,0,-1)\n *\n * @public\n */\nexport const VECTOR3_BACK: Vector3 = { x: 0, y: 0, z: -1 };\n/**\n * one\n *\n * A unit vector representing the value of 1 in all directions (1,1,1)\n *\n * @public\n */\nexport const VECTOR3_ONE: Vector3 = { x: 1, y: 1, z: 1 };\n/**\n * zero\n *\n * A unit vector representing the value of 0 in all directions (0,0,0)\n *\n * @public\n */\nexport const VECTOR3_ZERO: Vector3 = { x: 0, y: 0, z: 0 };\n/**\n * west\n *\n * A unit vector representing the world WEST direction (-1,0,0)\n *   (same as LEFT)\n *\n * @public\n */\nexport const VECTOR3_WEST: Vector3 = { x: -1, y: 0, z: 0 };\n/**\n * east\n *\n * A unit vector representing the world EAST direction (-1,0,0)\n *   (same as RIGHT)\n *\n * @public\n */\nexport const VECTOR3_EAST: Vector3 = { x: 1, y: 0, z: 0 };\n/**\n * north\n *\n * A unit vector representing the world NORTH direction (-1,0,0)\n *   (same as FORWARD)\n *\n * @public\n */\nexport const VECTOR3_NORTH: Vector3 = { x: 0, y: 0, z: 1 };\n/**\n * south\n *\n * A unit vector representing the world SOUTH direction (-1,0,0)\n *   (same as BACK)\n *\n * @public\n */\nexport const VECTOR3_SOUTH: Vector3 = { x: 0, y: 0, z: -1 };\n", "// Copyright (c) Mojang AB.  All rights reserved.\n\nimport type { Vector2, Vector3 } from '@minecraft/server';\nimport { Vector2Utils, Vector3Utils } from './coreHelpers';\n\n/**\n * Vector3 wrapper class which can be used as a Vector3 for APIs on \\@minecraft/server which require a Vector,\n * but also contain additional helper methods. This is an alternative to using the core Vector 3 utility\n * methods directly, for those who prefer a more object-oriented approach. This version of the class is mutable\n * and changes state inline.\n *\n * For an immutable version of the build, use ImmutableVector3Builder.\n *\n * @public\n */\nexport class Vector3Builder implements Vector3 {\n    x: number;\n    y: number;\n    z: number;\n\n    constructor(vec: Vector3, arg?: never, arg2?: never);\n    constructor(x: number, y: number, z: number);\n    constructor(first: number | Vector3, y?: number, z?: number) {\n        if (typeof first === 'object') {\n            this.x = first.x;\n            this.y = first.y;\n            this.z = first.z;\n        } else {\n            this.x = first;\n            this.y = y ?? 0;\n            this.z = z ?? 0;\n        }\n    }\n\n    /**\n     * Assigns the values of the passed in vector to this vector. Returns itself.\n     */\n    assign(vec: Vector3): this {\n        this.x = vec.x;\n        this.y = vec.y;\n        this.z = vec.z;\n        return this;\n    }\n\n    /**\n     * equals\n     *\n     * Check the equality of two vectors\n     */\n    equals(v: Vector3): boolean {\n        return Vector3Utils.equals(this, v);\n    }\n\n    /**\n     * add\n     *\n     * Adds the vector v to this, returning itself.\n     */\n    add(v: Vector3): this {\n        return this.assign(Vector3Utils.add(this, v));\n    }\n\n    /**\n     * subtract\n     *\n     * Subtracts the vector v from this, returning itself.\n     */\n    subtract(v: Vector3): this {\n        return this.assign(Vector3Utils.subtract(this, v));\n    }\n\n    /** scale\n     *\n     * Scales this by the passed in value, returning itself.\n     */\n    scale(val: number): this {\n        return this.assign(Vector3Utils.scale(this, val));\n    }\n\n    /**\n     * dot\n     *\n     * Computes the dot product of this and the passed in vector.\n     */\n    dot(vec: Vector3): number {\n        return Vector3Utils.dot(this, vec);\n    }\n\n    /**\n     * cross\n     *\n     * Computes the cross product of this and the passed in vector, returning itself.\n     */\n    cross(vec: Vector3): this {\n        return this.assign(Vector3Utils.cross(this, vec));\n    }\n\n    /**\n     * magnitude\n     *\n     * The magnitude of the vector\n     */\n    magnitude(): number {\n        return Vector3Utils.magnitude(this);\n    }\n\n    /**\n     * normalize\n     *\n     * Normalizes this vector, returning itself.\n     */\n    normalize(): this {\n        return this.assign(Vector3Utils.normalize(this));\n    }\n\n    /**\n     * floor\n     *\n     * Floor the components of a vector to produce a new vector\n     */\n    floor(): this {\n        return this.assign(Vector3Utils.floor(this));\n    }\n\n    /**\n     * toString\n     *\n     * Create a string representation of a vector\n     */\n    toString(options?: { decimals?: number; delimiter?: string }): string {\n        return Vector3Utils.toString(this, options);\n    }\n\n    /**\n     * clamp\n     *\n     * Clamps the components of a vector to limits to produce a new vector\n     */\n    clamp(limits: { min?: Partial<Vector3>; max?: Partial<Vector3> }): this {\n        return this.assign(Vector3Utils.clamp(this, limits));\n    }\n}\n\n/**\n * Vector2 wrapper class which can be used as a Vector2 for APIs on \\@minecraft/server which require a Vector2.\n * @public\n */\nexport class Vector2Builder implements Vector2 {\n    x: number;\n    y: number;\n\n    constructor(vec: Vector2, arg?: never);\n    constructor(x: number, y: number);\n    constructor(first: number | Vector2, y?: number) {\n        if (typeof first === 'object') {\n            this.x = first.x;\n            this.y = first.y;\n        } else {\n            this.x = first;\n            this.y = y ?? 0;\n        }\n    }\n\n    toString(options?: { decimals?: number; delimiter?: string }): string {\n        return Vector2Utils.toString(this, options);\n    }\n}\n", "// Copyright (c) Mojang AB.  All rights reserved.\n\nexport * from './coreHelpers';\nexport * from './vectorWrapper';\n", "// Copyright (c) Mojang AB.  All rights reserved.\n\nexport * from './clamp';\n", "// Copyright (c) Mojang AB.  All rights reserved.\n\nexport * from './vector3';\nexport * from './general';\n"],
+  "mappings": ";;;;;;;;;;;AAOA,aAAgB,YAAY,KAAa,KAAa,KAAW;AAC7D,aAAO,KAAK,IAAI,KAAK,IAAI,KAAK,GAAG,GAAG,GAAG;IAC3C;AAFA,YAAA,cAAA;;;;;;;;;;ACJA,QAAA,UAAA;AAOA,QAAa,eAAb,MAAa,cAAY;;;;;;MAMrB,OAAO,OAAO,IAAa,IAAW;AAClC,eAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG;MACzD;;;;;;MAOA,OAAO,IAAI,IAAa,IAAW;AAC/B,eAAO,EAAE,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,EAAC;MAC3D;;;;;;MAOA,OAAO,SAAS,IAAa,IAAW;AACpC,eAAO,EAAE,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,EAAC;MAC3D;;;;;MAMA,OAAO,MAAM,IAAa,OAAa;AACnC,eAAO,EAAE,GAAG,GAAG,IAAI,OAAO,GAAG,GAAG,IAAI,OAAO,GAAG,GAAG,IAAI,MAAK;MAC9D;;;;;;MAOA,OAAO,IAAI,GAAY,GAAU;AAC7B,eAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;MAC3C;;;;;;MAOA,OAAO,MAAM,GAAY,GAAU;AAC/B,eAAO;UACH,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;UACvB,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;UACvB,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE;;MAE/B;;;;;;MAOA,OAAO,UAAU,GAAU;AACvB,eAAO,KAAK,KAAK,EAAE,KAAK,IAAI,EAAE,KAAK,IAAI,EAAE,KAAK,CAAC;MACnD;;;;;;MAOA,OAAO,UAAU,GAAU;AACvB,cAAM,MAAM,cAAa,UAAU,CAAC;AACpC,eAAO,EAAE,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,EAAE,IAAI,IAAG;MACrD;;;;;;MAOA,OAAO,MAAM,GAAU;AACnB,eAAO,EAAE,GAAG,KAAK,MAAM,EAAE,CAAC,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC,EAAC;MACvE;;;;;;MAOA,OAAO,SAAS,GAAY,SAAmD;AAC3E,cAAM,WAAW,SAAS,YAAY;AACtC,cAAM,MAAgB,CAAC,EAAE,EAAE,QAAQ,QAAQ,GAAG,EAAE,EAAE,QAAQ,QAAQ,GAAG,EAAE,EAAE,QAAQ,QAAQ,CAAC;AAC1F,eAAO,IAAI,KAAK,SAAS,aAAa,IAAI;MAC9C;;;;;;MAOA,OAAO,MACH,GACA,QAGC;AAED,eAAO;UACH,IAAG,GAAA,QAAA,aAAY,EAAE,GAAG,QAAQ,KAAK,KAAK,OAAO,kBAAkB,QAAQ,KAAK,KAAK,OAAO,gBAAgB;UACxG,IAAG,GAAA,QAAA,aAAY,EAAE,GAAG,QAAQ,KAAK,KAAK,OAAO,kBAAkB,QAAQ,KAAK,KAAK,OAAO,gBAAgB;UACxG,IAAG,GAAA,QAAA,aAAY,EAAE,GAAG,QAAQ,KAAK,KAAK,OAAO,kBAAkB,QAAQ,KAAK,KAAK,OAAO,gBAAgB;;MAEhH;;AAlHJ,YAAA,eAAA;AA0HA,QAAa,eAAb,MAAyB;;;;;;MAMrB,OAAO,SAAS,GAAY,SAAmD;AAC3E,cAAM,WAAW,SAAS,YAAY;AACtC,cAAM,MAAgB,CAAC,EAAE,EAAE,QAAQ,QAAQ,GAAG,EAAE,EAAE,QAAQ,QAAQ,CAAC;AACnE,eAAO,IAAI,KAAK,SAAS,aAAa,IAAI;MAC9C;;AAVJ,YAAA,eAAA;AAoBa,YAAA,aAAsB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAQxC,YAAA,eAAwB,EAAE,GAAG,GAAG,GAAG,IAAI,GAAG,EAAC;AAQ3C,YAAA,eAAwB,EAAE,GAAG,IAAI,GAAG,GAAG,GAAG,EAAC;AAQ3C,YAAA,gBAAyB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAQ3C,YAAA,kBAA2B,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAQ7C,YAAA,eAAwB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAE;AAQ3C,YAAA,cAAuB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAQzC,YAAA,eAAwB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAS1C,YAAA,eAAwB,EAAE,GAAG,IAAI,GAAG,GAAG,GAAG,EAAC;AAS3C,YAAA,eAAwB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAS1C,YAAA,gBAAyB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAC;AAS3C,YAAA,gBAAyB,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAE;;;;;;;;;;ACjPzD,QAAA,gBAAA;AAYA,QAAa,iBAAb,MAA2B;MAOvB,YAAY,OAAyB,GAAY,GAAU;AACvD,YAAI,OAAO,UAAU,UAAU;AAC3B,eAAK,IAAI,MAAM;AACf,eAAK,IAAI,MAAM;AACf,eAAK,IAAI,MAAM;eACZ;AACH,eAAK,IAAI;AACT,eAAK,IAAI,KAAK;AACd,eAAK,IAAI,KAAK;;MAEtB;;;;MAKA,OAAO,KAAY;AACf,aAAK,IAAI,IAAI;AACb,aAAK,IAAI,IAAI;AACb,aAAK,IAAI,IAAI;AACb,eAAO;MACX;;;;;;MAOA,OAAO,GAAU;AACb,eAAO,cAAA,aAAa,OAAO,MAAM,CAAC;MACtC;;;;;;MAOA,IAAI,GAAU;AACV,eAAO,KAAK,OAAO,cAAA,aAAa,IAAI,MAAM,CAAC,CAAC;MAChD;;;;;;MAOA,SAAS,GAAU;AACf,eAAO,KAAK,OAAO,cAAA,aAAa,SAAS,MAAM,CAAC,CAAC;MACrD;;;;;MAMA,MAAM,KAAW;AACb,eAAO,KAAK,OAAO,cAAA,aAAa,MAAM,MAAM,GAAG,CAAC;MACpD;;;;;;MAOA,IAAI,KAAY;AACZ,eAAO,cAAA,aAAa,IAAI,MAAM,GAAG;MACrC;;;;;;MAOA,MAAM,KAAY;AACd,eAAO,KAAK,OAAO,cAAA,aAAa,MAAM,MAAM,GAAG,CAAC;MACpD;;;;;;MAOA,YAAS;AACL,eAAO,cAAA,aAAa,UAAU,IAAI;MACtC;;;;;;MAOA,YAAS;AACL,eAAO,KAAK,OAAO,cAAA,aAAa,UAAU,IAAI,CAAC;MACnD;;;;;;MAOA,QAAK;AACD,eAAO,KAAK,OAAO,cAAA,aAAa,MAAM,IAAI,CAAC;MAC/C;;;;;;MAOA,SAAS,SAAmD;AACxD,eAAO,cAAA,aAAa,SAAS,MAAM,OAAO;MAC9C;;;;;;MAOA,MAAM,QAA0D;AAC5D,eAAO,KAAK,OAAO,cAAA,aAAa,MAAM,MAAM,MAAM,CAAC;MACvD;;AA7HJ,YAAA,iBAAA;AAoIA,QAAa,iBAAb,MAA2B;MAMvB,YAAY,OAAyB,GAAU;AAC3C,YAAI,OAAO,UAAU,UAAU;AAC3B,eAAK,IAAI,MAAM;AACf,eAAK,IAAI,MAAM;eACZ;AACH,eAAK,IAAI;AACT,eAAK,IAAI,KAAK;;MAEtB;MAEA,SAAS,SAAmD;AACxD,eAAO,cAAA,aAAa,SAAS,MAAM,OAAO;MAC9C;;AAlBJ,YAAA,iBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACjJA,iBAAA,uBAAA,OAAA;AACA,iBAAA,yBAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACDA,iBAAA,iBAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACAA,iBAAA,mBAAA,OAAA;AACA,iBAAA,mBAAA,OAAA;;;",
+  "names": []
+}

package/lib/general/clamp.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright (c) Mojang AB.  All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clampNumber = void 0;
+/**
+ * Clamps the passed in number to the passed in min and max values.
+ *
+ * @public
+ */
+function clampNumber(val, min, max) {
+    return Math.min(Math.max(val, min), max);
+}
+exports.clampNumber = clampNumber;
+//# sourceMappingURL=clamp.js.map

package/lib/general/clamp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clamp.js","sourceRoot":"","sources":["../../src/general/clamp.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;AAEjD;;;;GAIG;AACH,SAAgB,WAAW,CAAC,GAAW,EAAE,GAAW,EAAE,GAAW;IAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC;AAFD,kCAEC"}

package/lib/general/index.js

@@ -0,0 +1,19 @@
+"use strict";
+// Copyright (c) Mojang AB.  All rights reserved.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./clamp"), exports);
+//# sourceMappingURL=index.js.map

package/lib/general/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/general/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;;;;;;;;;;;;;;AAEjD,0CAAwB"}

package/lib/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// Copyright (c) Mojang AB.  All rights reserved.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./vector3"), exports);
+__exportStar(require("./general"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;;;;;;;;;;;;;;;;AAEjD,4CAA0B;AAC1B,4CAA0B"}

package/lib/index.test.js

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright (c) Mojang AB.  All rights reserved.
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)('Test', () => {
+    (0, vitest_1.it)('should pass', () => {
+        (0, vitest_1.expect)(true).toBe(true);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/lib/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";AAAA,iDAAiD;;AAEjD,mCAA8C;AAE9C,IAAA,iBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE;IAClB,IAAA,WAAE,EAAC,aAAa,EAAE,GAAG,EAAE;QACnB,IAAA,eAAM,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}