@nativewrappers/common 0.0.48 → 0.0.50

package/package.json

@@ -4,7 +4,7 @@
   "author": "Remco Troost <d0p3t>",
   "license": "MIT",
   "type": "module",
-  "version": "0.0.48",
+  "version": "0.0.50",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/fivem.git"

package/utils/Vector.d.ts

@@ -1,5 +1,6 @@
 import type { MsgpackBuffer } from "../types";
 import { ClassTypes } from "./ClassTypes";
+declare const size: unique symbol;
 /**
  * Represents a 2-dimensional vector.
  */
@@ -49,22 +50,8 @@ type InferVector<T> = T extends Vec4 | VectorN<4> ? Vector4 : T extends Vec3 | V
 /**
  * A base vector class inherited by all vector classes.
  */
-export declare class Vector {
-    size: number;
-    x: number;
-    y: number;
-    z?: number | undefined;
-    w?: number | undefined;
-    type: ClassTypes;
-    protected static create(x: number, y?: number): Vector2;
-    protected static create(x: number, y?: number, z?: number): Vector3;
-    protected static create(x: number, y?: number, z?: number, w?: number): Vector4;
-    /**
-     * Creates a new vector based on the provided vector-like object.
-     * @param obj The object representing the vector.
-     * @returns A new vector instance.
-     */
-    protected static create<T extends VectorType, U extends VectorLike>(this: T, obj: U): InferVector<U>;
+declare class Vector {
+    protected static create(x: number | Vec, y?: number, z?: number, w?: number): Vector;
     /**
      * Creates a vector from binary data in a MsgpackBuffer.
      * @param msgpackBuffer The buffer containing binary data.
@@ -76,7 +63,7 @@ export declare class Vector {
      * @param obj The vector to clone.
      * @returns A new vector instance that is a copy of the provided vector.
      */
-    static clone<T extends VectorType, U extends VectorLike>(this: T, obj: U): InferVector<U>;
+    static clone<T extends VectorType, U extends VectorLike>(this: T, obj: U): InstanceType<T>;
     /**
      * Performs an operation between a vector and either another vector or scalar value.
      * @param a - The first vector.
@@ -98,28 +85,28 @@ export declare class Vector {
      * @param x - The value to add to the x-component.
      * @returns A new vector with the x-component incremented.
      */
-    static addX<T extends VectorType, U extends VectorLike>(this: T, obj: U, x: number): InferVector<U>;
+    static addX<U extends VectorLike>(obj: U, x: number): U;
     /**
      * Adds a scalar value to the y-component of a vector.
      * @param obj - The vector.
      * @param y - The value to add to the y-component.
      * @returns A new vector with the y-component incremented.
      */
-    static addY<T extends VectorType, U extends VectorLike>(this: T, obj: U, y: number): InferVector<U>;
+    static addY<T extends VectorType, U extends VectorLike>(this: T, obj: U, y: number): Vector;
     /**
      * Adds a scalar value to the z-component of a vector.
      * @param obj - The vector.
      * @param z - The value to add to the z-component.
      * @returns A new vector with the z-component incremented.
      */
-    static addZ<T extends VectorType, U extends Vec3 | Vec4>(this: T, obj: U, z: number): InferVector<U>;
+    static addZ<T extends VectorType, U extends Vec3 | Vec4>(this: T, obj: U, z: number): Vector;
     /**
      * Adds a scalar value to the w-component of a vector.
      * @param obj - The vector.
      * @param w - The value to add to the w-component.
      * @returns A new vector with the w-component incremented.
      */
-    static addW<T extends VectorType, U extends Vec4>(this: T, obj: U, w: number): InferVector<U>;
+    static addW<T extends VectorType, U extends Vec4>(this: T, obj: U, w: number): Vector;
     /**
      * Subtracts one vector from another or subtracts a scalar value from a vector.
      * @param a - The vector.
@@ -218,21 +205,27 @@ export declare class Vector {
      * @returns The magnitude of the vector.
      */
     static Length<T extends VectorType, U extends VectorLike>(this: T, obj: U): number;
+    type: unknown;
+    [size]: number;
+    x: number;
+    y: number;
+    z: number | undefined;
+    w: number | undefined;
     /**
      * Constructs a new vector.
-     * @param size The size of the vector (number of components).
      * @param x The x-component of the vector.
      * @param y The y-component of the vector (optional, defaults to x).
      * @param z The z-component of the vector (optional).
      * @param w The w-component of the vector (optional).
      */
-    constructor(size: number, x?: number, y?: number, z?: number | undefined, w?: number | undefined);
+    constructor(x: number, y?: number, z?: number, w?: number);
     [Symbol.iterator](): Iterator<number>;
+    get size(): number;
     toString(): string;
     /**
      * @see Vector.clone
      */
-    clone(): InferVector<this>;
+    clone<T extends this>(): T;
     /**
      * The product of the Euclidean magnitudes of this and another Vector.
      *
@@ -262,11 +255,11 @@ export declare class Vector {
     /**
      * @see Vector.addX
      */
-    addX(x: number): InferVector<this>;
+    addX(x: number): this;
     /**
      * @see Vector.addY
      */
-    addY(y: number): InferVector<this>;
+    addY(y: number): Vector;
     /**
      * @see Vector.subtract
      */
@@ -314,7 +307,8 @@ export declare class Vector {
  * Represents a 2-dimensional vector.
  */
 export declare class Vector2 extends Vector {
-    type: ClassTypes;
+    readonly type = ClassTypes.Vector2;
+    readonly [size]: number;
     static readonly Zero: Vector2;
     /**
      * Constructs a new 2D vector.
@@ -322,12 +316,20 @@ export declare class Vector2 extends Vector {
      * @param y The y-component of the vector (optional, defaults to x).
      */
     constructor(x: number, y?: number);
+    /**
+     * Creates a new vector based on the provided parameters.
+     * @param x The x-component of the vector.
+     * @param y The y-component of the vector (optional, defaults to the value of x).
+     * @returns A new vector instance.
+     */
+    protected static create(x: number | Vec, y?: number): Vector2;
 }
 /**
  * Represents a 3-dimensional vector.
  */
 export declare class Vector3 extends Vector implements Vec3 {
-    type: ClassTypes;
+    readonly type = ClassTypes.Vector3;
+    readonly [size]: number;
     z: number;
     static readonly Zero: Vector3;
     static readonly UnitX: Vector3;
@@ -350,10 +352,18 @@ export declare class Vector3 extends Vector implements Vec3 {
      * @param z The z-component of the vector (optional, defaults to y).
      */
     constructor(x: number, y?: number, z?: number);
+    /**
+     * Creates a new vector based on the provided parameters.
+     * @param x The x-component of the vector.
+     * @param y The y-component of the vector (optional, defaults to the value of x).
+     * @param z The z-component of the vector (optional, defaults to the value of y).
+     * @returns A new vector instance.
+     */
+    protected static create(x: number | Vec, y?: number, z?: number): Vector3;
     /**
      * @see Vector.addZ
      */
-    addZ(z: number): InferVector<this>;
+    addZ(z: number): Vector;
     /**
      * @see Vector.crossProduct
      */
@@ -367,7 +377,8 @@ export declare class Vector3 extends Vector implements Vec3 {
  * Represents a 4-dimensional vector.
  */
 export declare class Vector4 extends Vector {
-    type: ClassTypes;
+    readonly type = ClassTypes.Vector4;
+    readonly [size]: number;
     z: number;
     w: number;
     static readonly Zero: Vector4;
@@ -379,14 +390,23 @@ export declare class Vector4 extends Vector {
      * @param w The w-component of the vector (optional, defaults to z).
      */
     constructor(x: number, y?: number, z?: number, w?: number);
+    /**
+     * Creates a new vector based on the provided parameters.
+     * @param x The x-component of the vector.
+     * @param y The y-component of the vector (optional, defaults to the value of x).
+     * @param z The z-component of the vector (optional, defaults to the value of y).
+     * @param w The w-component of the vector (optional, defaults to the value of z).
+     * @returns A new vector instance.
+     */
+    protected static create(x: number | Vec, y?: number, z?: number, w?: number): Vector4;
     /**
      * @see Vector.addZ
      */
-    addZ(z: number): InferVector<this>;
+    addZ(z: number): Vector;
     /**
      * @see Vector.addW
      */
-    addW(w: number): InferVector<this>;
+    addW(w: number): Vector;
     /**
      * @see Vector.crossProduct
      */

package/utils/Vector.js

@@ -3,43 +3,15 @@ import { ClassTypes } from "./ClassTypes";
 const EXT_VECTOR2 = 20;
 const EXT_VECTOR3 = 21;
 const EXT_VECTOR4 = 22;
+const size = Symbol("size");
 /**
  * A base vector class inherited by all vector classes.
  */
-export class Vector {
-    size;
-    x;
-    y;
-    z;
-    w;
-    // DO NOT USE, ONLY EXPOSED BECAUSE TS IS TRASH, THIS TYPE IS NOT GUARANTEED
-    // TO EXIST
-    type = ClassTypes.Vector2;
-    /**
-     * Creates a new vector based on the provided parameters.
-     * @param x The x-component of the vector.
-     * @param y The y-component of the vector (optional, defaults to the value of x).
-     * @param z The z-component of the vector (optional, defaults to the value of y).
-     * @param w The w-component of the vector (optional, defaults to the value of z).
-     * @returns A new vector instance.
-     */
-    static create(x, y, z, w) {
-        if (y === undefined && typeof x === "number")
-            return new Vector2(x, x);
+class Vector {
+    static create(x, y = x, z, w) {
         if (typeof x === "object")
-            ({ x, y, z, w } = x);
-        const size = this instanceof Vector
-            ? this.size
-            : [x, y, z, w].filter((arg) => arg !== undefined).length;
-        switch (size) {
-            default:
-            case 2:
-                return new Vector2(x, y);
-            case 3:
-                return new Vector3(x, y, z);
-            case 4:
-                return new Vector4(x, y, z, w);
-        }
+            ({ x, y, z = y, w = z } = x);
+        return new this(x, y, z, w);
     }
     /**
      * Creates a vector from binary data in a MsgpackBuffer.
@@ -49,7 +21,9 @@ export class Vector {
     static fromBuffer({ buffer, type }) {
         if (type !== EXT_VECTOR2 && type !== EXT_VECTOR3 && type !== EXT_VECTOR4)
             throw new Error("Buffer type is not a valid Vector.");
-        const arr = Array.from(new Float32Array(buffer), (v) => Number(v.toPrecision(7)));
+        const arr = new Array(buffer.length / 4);
+        for (let i = 0; i < arr.length; i++)
+            arr[i] = Number(buffer.readFloatLE(i * 4).toPrecision(7));
         return this.fromArray(arr);
     }
     /**
@@ -94,9 +68,7 @@ export class Vector {
      * @returns A new vector with the x-component incremented.
      */
     static addX(obj, x) {
-        const vec = this.clone(obj);
-        vec.x += x;
-        return vec;
+        return this.create(obj.x + x, obj.y, obj.z, obj.w);
     }
     /**
      * Adds a scalar value to the y-component of a vector.
@@ -105,9 +77,7 @@ export class Vector {
      * @returns A new vector with the y-component incremented.
      */
     static addY(obj, y) {
-        const vec = this.clone(obj);
-        vec.y += y;
-        return vec;
+        return this.create(obj.x, obj.y + y, obj.z, obj.w);
     }
     /**
      * Adds a scalar value to the z-component of a vector.
@@ -116,9 +86,7 @@ export class Vector {
      * @returns A new vector with the z-component incremented.
      */
     static addZ(obj, z) {
-        const vec = this.clone(obj);
-        vec.z += z;
-        return vec;
+        return this.create(obj.x, obj.y, obj.z + z, obj.w);
     }
     /**
      * Adds a scalar value to the w-component of a vector.
@@ -127,9 +95,7 @@ export class Vector {
      * @returns A new vector with the w-component incremented.
      */
     static addW(obj, w) {
-        const vec = this.clone(obj);
-        vec.w += w;
-        return vec;
+        return this.create(obj.x, obj.y, obj.z, obj.w + w);
     }
     /**
      * Subtracts one vector from another or subtracts a scalar value from a vector.
@@ -299,20 +265,27 @@ export class Vector {
         }
         return Math.sqrt(sum);
     }
+    type;
+    [size] = 2;
+    x = 0;
+    y = 0;
+    z;
+    w;
     /**
      * Constructs a new vector.
-     * @param size The size of the vector (number of components).
      * @param x The x-component of the vector.
      * @param y The y-component of the vector (optional, defaults to x).
      * @param z The z-component of the vector (optional).
      * @param w The w-component of the vector (optional).
      */
-    constructor(size, x = 0, y = x, z, w) {
-        this.size = size;
+    constructor(x, y = x, z, w) {
+        for (let i = 0; i < arguments.length; i++) {
+            if (typeof arguments[i] !== "number") {
+                throw new TypeError(`${this.constructor.name} argument at index ${i} must be a number, but got ${typeof arguments[i]}`);
+            }
+        }
         this.x = x;
         this.y = y;
-        this.z = z;
-        this.w = w;
     }
     *[Symbol.iterator]() {
         yield this.x;
@@ -322,6 +295,9 @@ export class Vector {
         if (this.w !== undefined)
             yield this.w;
     }
+    get size() {
+        return this[size];
+    }
     toString() {
         return `vector${this.size}(${this.toArray().join(", ")})`;
     }
@@ -456,6 +432,7 @@ export class Vector2 extends Vector {
     // DO NOT USE, ONLY EXPOSED BECAUSE TS IS TRASH, THIS TYPE IS NOT GUARANTEED
     // TO EXIST, CHANGING IT WILL BREAK STUFF
     type = ClassTypes.Vector2;
+    [size] = 2;
     static Zero = new Vector2(0, 0);
     /**
      * Constructs a new 2D vector.
@@ -463,7 +440,18 @@ export class Vector2 extends Vector {
      * @param y The y-component of the vector (optional, defaults to x).
      */
     constructor(x, y = x) {
-        super(2, x, y);
+        super(x, y);
+    }
+    /**
+     * Creates a new vector based on the provided parameters.
+     * @param x The x-component of the vector.
+     * @param y The y-component of the vector (optional, defaults to the value of x).
+     * @returns A new vector instance.
+     */
+    static create(x, y = x) {
+        if (typeof x === "object")
+            ({ x, y } = x);
+        return new this(x, y);
     }
 }
 /**
@@ -473,7 +461,8 @@ export class Vector3 extends Vector {
     // DO NOT USE, ONLY EXPOSED BECAUSE TS IS TRASH, THIS TYPE IS NOT GUARANTEED
     // TO EXIST, CHANGING IT WILL BREAK STUFF
     type = ClassTypes.Vector3;
-    z;
+    [size] = 3;
+    z = 0;
     static Zero = new Vector3(0, 0, 0);
     static UnitX = new Vector3(1.0, 0.0, 0.0);
     static UnitY = new Vector3(0.0, 1.0, 0.0);
@@ -495,9 +484,21 @@ export class Vector3 extends Vector {
      * @param z The z-component of the vector (optional, defaults to y).
      */
     constructor(x, y = x, z = y) {
-        super(3, x, y, z);
+        super(x, y, z);
         this.z = z;
     }
+    /**
+     * Creates a new vector based on the provided parameters.
+     * @param x The x-component of the vector.
+     * @param y The y-component of the vector (optional, defaults to the value of x).
+     * @param z The z-component of the vector (optional, defaults to the value of y).
+     * @returns A new vector instance.
+     */
+    static create(x, y = x, z = y) {
+        if (typeof x === "object")
+            ({ x, y, z = y } = x);
+        return new this(x, y, z);
+    }
     /**
      * @see Vector.addZ
      */
@@ -524,8 +525,9 @@ export class Vector4 extends Vector {
     // DO NOT USE, ONLY EXPOSED BECAUSE TS IS TRASH, THIS TYPE IS NOT GUARANTEED
     // TO EXIST, CHANGING IT WILL BREAK STUFF
     type = ClassTypes.Vector4;
-    z;
-    w;
+    [size] = 4;
+    z = 0;
+    w = 0;
     static Zero = new Vector4(0, 0, 0, 0);
     /**
      * Constructs a new 4D vector.
@@ -535,10 +537,23 @@ export class Vector4 extends Vector {
      * @param w The w-component of the vector (optional, defaults to z).
      */
     constructor(x, y = x, z = y, w = z) {
-        super(4, x, y, z, w);
-        this.z = z;
+        super(x, y, z, w);
+        this.z = w;
         this.w = w;
     }
+    /**
+     * Creates a new vector based on the provided parameters.
+     * @param x The x-component of the vector.
+     * @param y The y-component of the vector (optional, defaults to the value of x).
+     * @param z The z-component of the vector (optional, defaults to the value of y).
+     * @param w The w-component of the vector (optional, defaults to the value of z).
+     * @returns A new vector instance.
+     */
+    static create(x, y = x, z = y, w = z) {
+        if (typeof x === "object")
+            ({ x, y, z = y, w = z } = x);
+        return new this(x, y, z, w);
+    }
     /**
      * @see Vector.addZ
      */