@nativewrappers/fivem 0.0.21 → 0.0.24

package/common/utils/Vector.d.ts

@@ -9,26 +9,19 @@ export interface Vec2 {
 /**
  * Represents a 3-dimensional vector.
  */
-export interface Vec3 {
-    x: number;
-    y: number;
+export interface Vec3 extends Vec2 {
     z: number;
 }
 /**
  * Represents a 4-dimensional vector.
  */
-export interface Vec4 {
-    x: number;
-    y: number;
-    z: number;
+export interface Vec4 extends Vec3 {
     w: number;
 }
 /**
  * An object with vector components.
  */
-interface VectorObject {
-    x: number;
-    y: number;
+export interface Vec extends Vec2 {
     z?: number;
     w?: number;
 }
@@ -47,7 +40,7 @@ type VectorType = typeof Vector;
 /**
  * Represents an object or class that can be treated as a vector.
  */
-type VectorLike = VectorObject | Vector;
+type VectorLike = Vec | Vector;
 /**
  * Utility type to get the vector type of an object based on its component.
  */
@@ -114,21 +107,21 @@ export declare class 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> | undefined;
+    static addY<T extends VectorType, U extends VectorLike>(this: T, obj: U, y: number): InferVector<U>;
     /**
      * 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 VectorLike>(this: T, obj: U, z: number): InferVector<U> | undefined;
+    static addZ<T extends VectorType, U extends Vec3 | Vec4>(this: T, obj: U, z: number): InferVector<U>;
     /**
      * 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 VectorLike>(this: T, obj: U, w: number): InferVector<U> | undefined;
+    static addW<T extends VectorType, U extends Vec4>(this: T, obj: U, w: number): InferVector<U>;
     /**
      * Subtracts one vector from another or subtracts a scalar value from a vector.
      * @param a - The vector.
@@ -163,7 +156,7 @@ export declare class Vector {
      * @param b - The second vector.
      * @returns A new vector perpendicular to both input vectors.
      */
-    static crossProduct<T extends VectorType, U extends VectorObject>(this: T, a: U, b: U): U;
+    static crossProduct<T extends VectorType, U extends Vec3 | Vec4>(this: T, a: U, b: U): U;
     /**
      * Normalizes a vector, producing a new vector with the same direction but with a magnitude of 1.
      * @param vector - The vector to be normalized.
@@ -240,7 +233,7 @@ export declare class Vector {
     /**
      * @see Vector.addY
      */
-    addY(x: number): InferVector<this> | undefined;
+    addY(x: number): InferVector<this>;
     /**
      * @see Vector.subtract
      */
@@ -256,7 +249,7 @@ export declare class Vector {
     /**
      * Converts the vector to an array of its components.
      */
-    toArray(): number[];
+    toArray<T extends this>(): VectorArray<T>;
     /**
      * Replaces the components of the vector with the components of another vector object.
      * @param v - The object whose components will replace the current vector's components.
@@ -298,11 +291,11 @@ export declare class Vector3 extends Vector implements Vec3 {
     /**
      * @see Vector.addZ
      */
-    addZ(z: number): InferVector<this> | undefined;
+    addZ(z: number): InferVector<this>;
     /**
      * @see Vector.crossProduct
      */
-    crossProduct(v: VectorLike): VectorLike;
+    crossProduct(v: Vec3 | Vec4): Vec3 | Vec4;
 }
 /**
  * Represents a 4-dimensional vector.
@@ -323,14 +316,14 @@ export declare class Vector4 extends Vector {
     /**
      * @see Vector.addZ
      */
-    addZ(z: number): InferVector<this> | undefined;
+    addZ(z: number): InferVector<this>;
     /**
      * @see Vector.addW
      */
-    addW(w: number): InferVector<this> | undefined;
+    addW(w: number): InferVector<this>;
     /**
      * @see Vector.crossProduct
      */
-    crossProduct(v: VectorLike): VectorLike;
+    crossProduct(v: Vec3 | Vec4): Vec3 | Vec4;
 }
 export {};

package/common/utils/Vector.js

@@ -58,8 +58,8 @@ export class Vector {
     static operate(a, b, operator) {
         let { x, y, z, w } = a;
         const isNumber = typeof b === 'number';
-        x = operator(x, isNumber ? b : b.x);
-        y = operator(y, isNumber ? b : b.y);
+        x = operator(x, isNumber ? b : b.x ?? 0);
+        y = operator(y, isNumber ? b : b.y ?? 0);
         if (z)
             z = operator(z, isNumber ? b : b.z ?? 0);
         if (w)
@@ -93,8 +93,6 @@ export class Vector {
      * @returns A new vector with the y-component incremented.
      */
     static addY(obj, y) {
-        if (typeof obj.y !== 'number')
-            return;
         const vec = this.clone(obj);
         vec.y += y;
         return vec;
@@ -106,8 +104,6 @@ export class Vector {
      * @returns A new vector with the z-component incremented.
      */
     static addZ(obj, z) {
-        if (typeof obj.z !== 'number')
-            return;
         const vec = this.clone(obj);
         vec.z += z;
         return vec;
@@ -119,8 +115,6 @@ export class Vector {
      * @returns A new vector with the w-component incremented.
      */
     static addW(obj, w) {
-        if (typeof obj.w !== 'number')
-            return;
         const vec = this.clone(obj);
         vec.w += w;
         return vec;
@@ -161,11 +155,9 @@ export class Vector {
     static dotProduct(a, b) {
         let result = 0;
         for (const key of ['x', 'y', 'z', 'w']) {
-            const v1 = a[key];
-            const v2 = b[key];
-            if (v1 && v2)
-                result += v1 * v2;
-            else if (v1 || v2) {
+            if (key in a && key in b)
+                result += a[key] * b[key];
+            else {
                 throw new Error('Vectors must have the same dimensions');
             }
         }

package/package.json

@@ -4,7 +4,7 @@
   "author": "Remco Troost <d0p3t>",
   "license": "MIT",
   "type": "module",
-  "version": "0.0.21",
+  "version": "0.0.24",
   "publishConfig": {
     "directory": "lib"
   },

package/server/entities/BaseEntity.d.ts

@@ -9,12 +9,18 @@ export declare class BaseEntity {
     protected handle: number;
     protected type: ClassTypes;
     constructor(handle: number);
+    static fromNetworkId(networkId: number): BaseEntity | null;
+    static fromStateBagName(stateBagName: string): BaseEntity | null;
     get State(): StateBagInterface;
     get Handle(): number;
     get Owner(): number;
     get FirstOwner(): number;
     get Exists(): boolean;
-    get AttachedTo(): number;
+    /**
+     * @returns the entity that the calling entity is attached to, or null if
+     * there is none
+     */
+    get AttachedTo(): BaseEntity | null;
     get Position(): Vector3;
     get Heading(): number;
     get PositionAndHeading(): Vector4;

package/server/entities/BaseEntity.js

@@ -7,6 +7,18 @@ export class BaseEntity {
         this.handle = handle;
         this.type = ClassTypes.Entity;
     }
+    static fromNetworkId(networkId) {
+        const ent = NetworkGetEntityFromNetworkId(networkId);
+        if (ent === 0)
+            return null;
+        return new BaseEntity(ent);
+    }
+    static fromStateBagName(stateBagName) {
+        const ent = GetEntityFromStateBagName(stateBagName);
+        if (ent === 0)
+            return null;
+        return new BaseEntity(ent);
+    }
     get State() {
         return cfx.Entity(this.handle).state;
     }
@@ -22,8 +34,15 @@ export class BaseEntity {
     get Exists() {
         return this.handle !== 0 && DoesEntityExist(this.handle);
     }
+    /**
+     * @returns the entity that the calling entity is attached to, or null if
+     * there is none
+     */
     get AttachedTo() {
-        return GetEntityAttachedTo(this.handle);
+        const ent = GetEntityAttachedTo(this.handle);
+        if (ent === 0)
+            return null;
+        return new BaseEntity(ent);
     }
     get Position() {
         return Vector3.fromArray(GetEntityCoords(this.handle));
@@ -83,6 +102,8 @@ export class BaseEntity {
         return HasEntityBeenMarkedAsNoLongerNeeded(this.handle);
     }
     delete() {
-        DeleteEntity(this.handle);
+        if (this.Exists) {
+            DeleteEntity(this.handle);
+        }
     }
 }

package/server/entities/Entity.d.ts

@@ -1,5 +1,6 @@
 import { BaseEntity } from './BaseEntity';
 export declare class Entity extends BaseEntity {
+    constructor(handle: number);
     static fromNetworkId(netId: number): Entity;
     static fromHandle(handle: number): Entity;
 }

package/server/entities/Entity.js

@@ -1,5 +1,8 @@
 import { BaseEntity } from './BaseEntity';
 export class Entity extends BaseEntity {
+    constructor(handle) {
+        super(handle);
+    }
     static fromNetworkId(netId) {
         return new Entity(NetworkGetEntityFromNetworkId(netId));
     }

package/server/entities/Ped.d.ts

@@ -1,6 +1,7 @@
 import { ClassTypes } from '../enum/ClassTypes';
 import { Hash } from '../type/Hash';
 import { BaseEntity } from './BaseEntity';
+import { Vehicle } from './Vehicle';
 export declare class Ped extends BaseEntity {
     protected type: ClassTypes;
     constructor(handle: number);
@@ -9,9 +10,9 @@ export declare class Ped extends BaseEntity {
      * @returns Iterable list of Peds.
      */
     static AllPeds(): IterableIterator<Ped>;
-    static fromNetworkId(netId: number): Ped;
+    static fromNetworkId(netId: number): Ped | null;
+    static fromStateBagName(stateBagName: string): Ped | null;
     static fromSource(source: number): Ped;
-    static fromHandle(handle: number): Ped;
     get Armour(): number;
     get CauseOfDeath(): Hash;
     get DesiredHeading(): number;
@@ -19,10 +20,13 @@ export declare class Ped extends BaseEntity {
     get TaskCommand(): Hash;
     get TaskStage(): number;
     get LastSourceOfDamage(): number;
-    get DeathCause(): number;
+    get DeathCause(): Hash;
     get Weapon(): Hash;
-    get Vehicle(): number;
-    get LastVehicle(): number;
+    /**
+     * @returns the current vehicle the ped is in, or null if it doesn't exist
+     */
+    get CurrentVehicle(): Vehicle | null;
+    get LastVehicle(): Vehicle | null;
     get IsPlayer(): boolean;
-    specificTaskType(index: number): number;
+    getSpecificTaskType(index: number): number;
 }

package/server/entities/Ped.js

@@ -1,5 +1,6 @@
 import { ClassTypes } from '../enum/ClassTypes';
 import { BaseEntity } from './BaseEntity';
+import { Vehicle } from './Vehicle';
 export class Ped extends BaseEntity {
     constructor(handle) {
         super(handle);
@@ -15,14 +16,20 @@ export class Ped extends BaseEntity {
         }
     }
     static fromNetworkId(netId) {
-        return new Ped(NetworkGetEntityFromNetworkId(netId));
+        const ent = NetworkGetEntityFromNetworkId(netId);
+        if (ent === 0)
+            return null;
+        return new Ped(ent);
+    }
+    static fromStateBagName(stateBagName) {
+        const handle = GetEntityFromStateBagName(stateBagName);
+        if (handle === 0)
+            return null;
+        return new Ped(handle);
     }
     static fromSource(source) {
         return new Ped(GetPlayerPed(source));
     }
-    static fromHandle(handle) {
-        return new Ped(handle);
-    }
     get Armour() {
         return GetPedArmour(this.handle);
     }
@@ -50,16 +57,25 @@ export class Ped extends BaseEntity {
     get Weapon() {
         return GetSelectedPedWeapon(this.handle);
     }
-    get Vehicle() {
-        return GetVehiclePedIsIn(this.handle, false);
+    /**
+     * @returns the current vehicle the ped is in, or null if it doesn't exist
+     */
+    get CurrentVehicle() {
+        const vehicle = GetVehiclePedIsIn(this.handle, false);
+        if (vehicle === 0)
+            return null;
+        return new Vehicle(vehicle);
     }
     get LastVehicle() {
-        return GetVehiclePedIsIn(this.handle, true);
+        const vehicle = GetVehiclePedIsIn(this.handle, false);
+        if (vehicle === 0)
+            return null;
+        return new Vehicle(GetVehiclePedIsIn(this.handle, true));
     }
     get IsPlayer() {
         return IsPedAPlayer(this.handle);
     }
-    specificTaskType(index) {
+    getSpecificTaskType(index) {
         return GetPedSpecificTaskType(this.handle, index);
     }
 }

package/server/entities/Prop.d.ts

@@ -8,6 +8,7 @@ export declare class Prop extends BaseEntity {
      * @returns Iterable list of Props.
      */
     static AllProps(): IterableIterator<Prop>;
-    static fromNetworkId(netId: number): Prop;
+    static fromNetworkId(networkId: number): Prop | null;
+    static fromStateBagName(stateBagName: string): Prop | null;
     static fromHandle(handle: number): Prop;
 }

package/server/entities/Prop.js

@@ -14,8 +14,17 @@ export class Prop extends BaseEntity {
             yield new Prop(prop);
         }
     }
-    static fromNetworkId(netId) {
-        return new Prop(NetworkGetEntityFromNetworkId(netId));
+    static fromNetworkId(networkId) {
+        const ent = NetworkGetEntityFromNetworkId(networkId);
+        if (ent === 0)
+            return null;
+        return new Prop(ent);
+    }
+    static fromStateBagName(stateBagName) {
+        const ent = GetEntityFromStateBagName(stateBagName);
+        if (ent === 0)
+            return null;
+        return new Prop(ent);
     }
     static fromHandle(handle) {
         return new Prop(handle);

package/server/entities/Vehicle.d.ts

@@ -12,8 +12,8 @@ export declare class Vehicle extends BaseEntity {
      * @returns Iterable list of Vehicles.
      */
     static AllVehicles(): IterableIterator<Vehicle>;
-    static fromNetworkId(netId: number): Vehicle;
-    static fromHandle(handle: number): Vehicle;
+    static fromNetworkId(networkId: number): Vehicle | null;
+    static fromStateBagName(stateBageName: string): Vehicle | null;
     get IsEngineRunning(): boolean;
     get IsPrimaryColourCustom(): boolean;
     get IsSecondaryColourCustom(): boolean;

package/server/entities/Vehicle.js

@@ -15,11 +15,17 @@ export class Vehicle extends BaseEntity {
             yield new Vehicle(veh);
         }
     }
-    static fromNetworkId(netId) {
-        return new Vehicle(NetworkGetEntityFromNetworkId(netId));
-    }
-    static fromHandle(handle) {
-        return new Vehicle(handle);
+    static fromNetworkId(networkId) {
+        const ent = NetworkGetEntityFromNetworkId(networkId);
+        if (ent === 0)
+            return null;
+        return new Vehicle(ent);
+    }
+    static fromStateBagName(stateBageName) {
+        const ent = GetEntityFromStateBagName(stateBageName);
+        if (ent === 0)
+            return null;
+        return new Vehicle(ent);
     }
     get IsEngineRunning() {
         return GetIsVehicleEngineRunning(this.handle);
@@ -79,7 +85,6 @@ export class Vehicle extends BaseEntity {
         return GetVehicleInteriorColour(this.handle);
     }
     get LightsState() {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         const [_, lightsOn, highbeansOn] = GetVehicleLightsState(this.handle);
         return [lightsOn, highbeansOn];
     }
@@ -132,7 +137,7 @@ export class Vehicle extends BaseEntity {
         return IsVehicleSirenOn(this.handle);
     }
     get MaxHealth() {
-        return GetPedMaxHealth(this.handle);
+        return GetEntityMaxHealth(this.handle);
     }
     get ScriptTaskCommand() {
         return GetPedScriptTaskCommand(this.handle);