@minecraft/math 1.0.0

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.38.3"
+    }
+  ]
+}

package/lib/types/math-beta.d.ts

@@ -0,0 +1,327 @@
+import type { Vector2 } from '@minecraft/server';
+import type { Vector3 } from '@minecraft/server';
+
+/**
+ * Clamps the passed in number to the passed in min and max values.
+ *
+ * @public
+ */
+export declare function clampNumber(val: number, min: number, max: number): number;
+
+/**
+ * Vector2 wrapper class which can be used as a Vector2 for APIs on \@minecraft/server which require a Vector2.
+ * @public
+ */
+export declare class Vector2Builder implements Vector2 {
+    x: number;
+    y: number;
+    constructor(vec: Vector2, arg?: never);
+    constructor(x: number, y: number);
+    toString(options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+}
+
+/**
+ * Utilities operating on Vector2 objects. All methods are static and do not modify the input objects.
+ *
+ * @public
+ */
+export declare class Vector2Utils {
+    /**
+     * toString
+     *
+     * Create a string representation of a vector2
+     */
+    static toString(v: Vector2, options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+}
+
+/**
+ * back
+ *
+ * A unit vector representing the world BACK direction (0,0,-1)
+ *
+ * @public
+ */
+export declare const VECTOR3_BACK: Vector3;
+
+/**
+ * down
+ *
+ * A unit vector representing the world DOWN direction (0,-1,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_DOWN: Vector3;
+
+/**
+ * east
+ *
+ * A unit vector representing the world EAST direction (-1,0,0)
+ *   (same as RIGHT)
+ *
+ * @public
+ */
+export declare const VECTOR3_EAST: Vector3;
+
+/**
+ * forward
+ *
+ * A unit vector representing the world FORWARD direction (0,0,1)
+ *
+ * @public
+ */
+export declare const VECTOR3_FORWARD: Vector3;
+
+/**
+ * left
+ *
+ * A unit vector representing the world LEFT direction (-1,0,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_LEFT: Vector3;
+
+/**
+ * north
+ *
+ * A unit vector representing the world NORTH direction (-1,0,0)
+ *   (same as FORWARD)
+ *
+ * @public
+ */
+export declare const VECTOR3_NORTH: Vector3;
+
+/**
+ * one
+ *
+ * A unit vector representing the value of 1 in all directions (1,1,1)
+ *
+ * @public
+ */
+export declare const VECTOR3_ONE: Vector3;
+
+/**
+ * right
+ *
+ * A unit vector representing the world RIGHT direction (1,0,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_RIGHT: Vector3;
+
+/**
+ * south
+ *
+ * A unit vector representing the world SOUTH direction (-1,0,0)
+ *   (same as BACK)
+ *
+ * @public
+ */
+export declare const VECTOR3_SOUTH: Vector3;
+
+/**
+ * up
+ *
+ * A unit vector representing the world UP direction (0,1,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_UP: Vector3;
+
+/**
+ * west
+ *
+ * A unit vector representing the world WEST direction (-1,0,0)
+ *   (same as LEFT)
+ *
+ * @public
+ */
+export declare const VECTOR3_WEST: Vector3;
+
+/**
+ * zero
+ *
+ * A unit vector representing the value of 0 in all directions (0,0,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_ZERO: Vector3;
+
+/**
+ * Vector3 wrapper class which can be used as a Vector3 for APIs on \@minecraft/server which require a Vector,
+ * but also contain additional helper methods. This is an alternative to using the core Vector 3 utility
+ * methods directly, for those who prefer a more object-oriented approach. This version of the class is mutable
+ * and changes state inline.
+ *
+ * For an immutable version of the build, use ImmutableVector3Builder.
+ *
+ * @public
+ */
+export declare class Vector3Builder implements Vector3 {
+    x: number;
+    y: number;
+    z: number;
+    constructor(vec: Vector3, arg?: never, arg2?: never);
+    constructor(x: number, y: number, z: number);
+    /**
+     * Assigns the values of the passed in vector to this vector. Returns itself.
+     */
+    assign(vec: Vector3): this;
+    /**
+     * equals
+     *
+     * Check the equality of two vectors
+     */
+    equals(v: Vector3): boolean;
+    /**
+     * add
+     *
+     * Adds the vector v to this, returning itself.
+     */
+    add(v: Vector3): this;
+    /**
+     * subtract
+     *
+     * Subtracts the vector v from this, returning itself.
+     */
+    subtract(v: Vector3): this;
+    /** scale
+     *
+     * Scales this by the passed in value, returning itself.
+     */
+    scale(val: number): this;
+    /**
+     * dot
+     *
+     * Computes the dot product of this and the passed in vector.
+     */
+    dot(vec: Vector3): number;
+    /**
+     * cross
+     *
+     * Computes the cross product of this and the passed in vector, returning itself.
+     */
+    cross(vec: Vector3): this;
+    /**
+     * magnitude
+     *
+     * The magnitude of the vector
+     */
+    magnitude(): number;
+    /**
+     * normalize
+     *
+     * Normalizes this vector, returning itself.
+     */
+    normalize(): this;
+    /**
+     * floor
+     *
+     * Floor the components of a vector to produce a new vector
+     */
+    floor(): this;
+    /**
+     * toString
+     *
+     * Create a string representation of a vector
+     */
+    toString(options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+    /**
+     * clamp
+     *
+     * Clamps the components of a vector to limits to produce a new vector
+     */
+    clamp(limits: {
+        min?: Partial<Vector3>;
+        max?: Partial<Vector3>;
+    }): this;
+}
+
+/**
+ * Utilities operating on Vector3 objects. All methods are static and do not modify the input objects.
+ *
+ * @public
+ */
+export declare class Vector3Utils {
+    /**
+     * equals
+     *
+     * Check the equality of two vectors
+     */
+    static equals(v1: Vector3, v2: Vector3): boolean;
+    /**
+     * add
+     *
+     * Add two vectors to produce a new vector
+     */
+    static add(v1: Vector3, v2: Vector3): Vector3;
+    /**
+     * subtract
+     *
+     * Subtract two vectors to produce a new vector (v1-v2)
+     */
+    static subtract(v1: Vector3, v2: Vector3): Vector3;
+    /** scale
+     *
+     * Multiple all entries in a vector by a single scalar value producing a new vector
+     */
+    static scale(v1: Vector3, scale: number): Vector3;
+    /**
+     * dot
+     *
+     * Calculate the dot product of two vectors
+     */
+    static dot(a: Vector3, b: Vector3): number;
+    /**
+     * cross
+     *
+     * Calculate the cross product of two vectors. Returns a new vector.
+     */
+    static cross(a: Vector3, b: Vector3): Vector3;
+    /**
+     * magnitude
+     *
+     * The magnitude of a vector
+     */
+    static magnitude(v: Vector3): number;
+    /**
+     * normalize
+     *
+     * Takes a vector 3 and normalizes it to a unit vector
+     */
+    static normalize(v: Vector3): Vector3;
+    /**
+     * floor
+     *
+     * Floor the components of a vector to produce a new vector
+     */
+    static floor(v: Vector3): Vector3;
+    /**
+     * toString
+     *
+     * Create a string representation of a vector3
+     */
+    static toString(v: Vector3, options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+    /**
+     * clamp
+     *
+     * Clamps the components of a vector to limits to produce a new vector
+     */
+    static clamp(v: Vector3, limits?: {
+        min?: Partial<Vector3>;
+        max?: Partial<Vector3>;
+    }): Vector3;
+}
+
+export { }

package/lib/types/math-public.d.ts

@@ -0,0 +1,327 @@
+import type { Vector2 } from '@minecraft/server';
+import type { Vector3 } from '@minecraft/server';
+
+/**
+ * Clamps the passed in number to the passed in min and max values.
+ *
+ * @public
+ */
+export declare function clampNumber(val: number, min: number, max: number): number;
+
+/**
+ * Vector2 wrapper class which can be used as a Vector2 for APIs on \@minecraft/server which require a Vector2.
+ * @public
+ */
+export declare class Vector2Builder implements Vector2 {
+    x: number;
+    y: number;
+    constructor(vec: Vector2, arg?: never);
+    constructor(x: number, y: number);
+    toString(options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+}
+
+/**
+ * Utilities operating on Vector2 objects. All methods are static and do not modify the input objects.
+ *
+ * @public
+ */
+export declare class Vector2Utils {
+    /**
+     * toString
+     *
+     * Create a string representation of a vector2
+     */
+    static toString(v: Vector2, options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+}
+
+/**
+ * back
+ *
+ * A unit vector representing the world BACK direction (0,0,-1)
+ *
+ * @public
+ */
+export declare const VECTOR3_BACK: Vector3;
+
+/**
+ * down
+ *
+ * A unit vector representing the world DOWN direction (0,-1,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_DOWN: Vector3;
+
+/**
+ * east
+ *
+ * A unit vector representing the world EAST direction (-1,0,0)
+ *   (same as RIGHT)
+ *
+ * @public
+ */
+export declare const VECTOR3_EAST: Vector3;
+
+/**
+ * forward
+ *
+ * A unit vector representing the world FORWARD direction (0,0,1)
+ *
+ * @public
+ */
+export declare const VECTOR3_FORWARD: Vector3;
+
+/**
+ * left
+ *
+ * A unit vector representing the world LEFT direction (-1,0,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_LEFT: Vector3;
+
+/**
+ * north
+ *
+ * A unit vector representing the world NORTH direction (-1,0,0)
+ *   (same as FORWARD)
+ *
+ * @public
+ */
+export declare const VECTOR3_NORTH: Vector3;
+
+/**
+ * one
+ *
+ * A unit vector representing the value of 1 in all directions (1,1,1)
+ *
+ * @public
+ */
+export declare const VECTOR3_ONE: Vector3;
+
+/**
+ * right
+ *
+ * A unit vector representing the world RIGHT direction (1,0,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_RIGHT: Vector3;
+
+/**
+ * south
+ *
+ * A unit vector representing the world SOUTH direction (-1,0,0)
+ *   (same as BACK)
+ *
+ * @public
+ */
+export declare const VECTOR3_SOUTH: Vector3;
+
+/**
+ * up
+ *
+ * A unit vector representing the world UP direction (0,1,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_UP: Vector3;
+
+/**
+ * west
+ *
+ * A unit vector representing the world WEST direction (-1,0,0)
+ *   (same as LEFT)
+ *
+ * @public
+ */
+export declare const VECTOR3_WEST: Vector3;
+
+/**
+ * zero
+ *
+ * A unit vector representing the value of 0 in all directions (0,0,0)
+ *
+ * @public
+ */
+export declare const VECTOR3_ZERO: Vector3;
+
+/**
+ * Vector3 wrapper class which can be used as a Vector3 for APIs on \@minecraft/server which require a Vector,
+ * but also contain additional helper methods. This is an alternative to using the core Vector 3 utility
+ * methods directly, for those who prefer a more object-oriented approach. This version of the class is mutable
+ * and changes state inline.
+ *
+ * For an immutable version of the build, use ImmutableVector3Builder.
+ *
+ * @public
+ */
+export declare class Vector3Builder implements Vector3 {
+    x: number;
+    y: number;
+    z: number;
+    constructor(vec: Vector3, arg?: never, arg2?: never);
+    constructor(x: number, y: number, z: number);
+    /**
+     * Assigns the values of the passed in vector to this vector. Returns itself.
+     */
+    assign(vec: Vector3): this;
+    /**
+     * equals
+     *
+     * Check the equality of two vectors
+     */
+    equals(v: Vector3): boolean;
+    /**
+     * add
+     *
+     * Adds the vector v to this, returning itself.
+     */
+    add(v: Vector3): this;
+    /**
+     * subtract
+     *
+     * Subtracts the vector v from this, returning itself.
+     */
+    subtract(v: Vector3): this;
+    /** scale
+     *
+     * Scales this by the passed in value, returning itself.
+     */
+    scale(val: number): this;
+    /**
+     * dot
+     *
+     * Computes the dot product of this and the passed in vector.
+     */
+    dot(vec: Vector3): number;
+    /**
+     * cross
+     *
+     * Computes the cross product of this and the passed in vector, returning itself.
+     */
+    cross(vec: Vector3): this;
+    /**
+     * magnitude
+     *
+     * The magnitude of the vector
+     */
+    magnitude(): number;
+    /**
+     * normalize
+     *
+     * Normalizes this vector, returning itself.
+     */
+    normalize(): this;
+    /**
+     * floor
+     *
+     * Floor the components of a vector to produce a new vector
+     */
+    floor(): this;
+    /**
+     * toString
+     *
+     * Create a string representation of a vector
+     */
+    toString(options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+    /**
+     * clamp
+     *
+     * Clamps the components of a vector to limits to produce a new vector
+     */
+    clamp(limits: {
+        min?: Partial<Vector3>;
+        max?: Partial<Vector3>;
+    }): this;
+}
+
+/**
+ * Utilities operating on Vector3 objects. All methods are static and do not modify the input objects.
+ *
+ * @public
+ */
+export declare class Vector3Utils {
+    /**
+     * equals
+     *
+     * Check the equality of two vectors
+     */
+    static equals(v1: Vector3, v2: Vector3): boolean;
+    /**
+     * add
+     *
+     * Add two vectors to produce a new vector
+     */
+    static add(v1: Vector3, v2: Vector3): Vector3;
+    /**
+     * subtract
+     *
+     * Subtract two vectors to produce a new vector (v1-v2)
+     */
+    static subtract(v1: Vector3, v2: Vector3): Vector3;
+    /** scale
+     *
+     * Multiple all entries in a vector by a single scalar value producing a new vector
+     */
+    static scale(v1: Vector3, scale: number): Vector3;
+    /**
+     * dot
+     *
+     * Calculate the dot product of two vectors
+     */
+    static dot(a: Vector3, b: Vector3): number;
+    /**
+     * cross
+     *
+     * Calculate the cross product of two vectors. Returns a new vector.
+     */
+    static cross(a: Vector3, b: Vector3): Vector3;
+    /**
+     * magnitude
+     *
+     * The magnitude of a vector
+     */
+    static magnitude(v: Vector3): number;
+    /**
+     * normalize
+     *
+     * Takes a vector 3 and normalizes it to a unit vector
+     */
+    static normalize(v: Vector3): Vector3;
+    /**
+     * floor
+     *
+     * Floor the components of a vector to produce a new vector
+     */
+    static floor(v: Vector3): Vector3;
+    /**
+     * toString
+     *
+     * Create a string representation of a vector3
+     */
+    static toString(v: Vector3, options?: {
+        decimals?: number;
+        delimiter?: string;
+    }): string;
+    /**
+     * clamp
+     *
+     * Clamps the components of a vector to limits to produce a new vector
+     */
+    static clamp(v: Vector3, limits?: {
+        min?: Partial<Vector3>;
+        max?: Partial<Vector3>;
+    }): Vector3;
+}
+
+export { }