@nativewrappers/fivem 0.0.35 → 0.0.37

package/client/Model.d.ts

@@ -123,10 +123,12 @@ export declare class Model {
     get Dimensions(): Dimensions;
     /**
      * Request and load the model with a specified timeout. Default timeout is 1000 (recommended).
+     * This function will not automatically set the model as no longer needed when
+     * done.
      *
      * @param timeout Maximum allowed time for model to load.
      */
-    request(timeout?: number): Promise<boolean>;
+    request(timeoutMs?: number): Promise<boolean>;
     /**
      * Sets the model as no longer needed allowing the game engine to free memory.
      */

package/client/Model.js

@@ -1,6 +1,6 @@
 import { Game } from './Game';
 import { VehicleHash } from './hashes';
-import { Vector3 } from './utils';
+import { Vector3, Wait } from './utils';
 /**
  * Class to create and manage entity models.
  */
@@ -170,24 +170,25 @@ export class Model {
     }
     /**
      * Request and load the model with a specified timeout. Default timeout is 1000 (recommended).
+     * This function will not automatically set the model as no longer needed when
+     * done.
      *
      * @param timeout Maximum allowed time for model to load.
      */
-    request(timeout = 1000) {
-        return new Promise(resolve => {
-            if (!this.IsInCdImage && !this.IsValid && !IsWeaponValid(this.hash)) {
-                resolve(false);
-            }
-            RequestModel(this.hash);
-            const start = GetGameTimer();
-            const interval = setInterval(() => {
-                if (this.IsLoaded || GetGameTimer() - start >= timeout) {
-                    clearInterval(interval);
-                    this.markAsNoLongerNeeded();
-                    resolve(this.IsLoaded);
-                }
-            }, 0);
-        });
+    async request(timeoutMs = 1000) {
+        if (!this.IsInCdImage && !this.IsValid && !IsWeaponValid(this.hash)) {
+            return false;
+        }
+        // pre-check so if its already loaded we don't add another ref
+        if (this.IsLoaded) {
+            return true;
+        }
+        RequestModel(this.hash);
+        const timeout = GetGameTimer() + timeoutMs;
+        while (!this.IsLoaded && timeout < GetGameTimer()) {
+            await Wait(0);
+        }
+        return this.IsLoaded;
     }
     /**
      * Sets the model as no longer needed allowing the game engine to free memory.

package/client/World.d.ts

@@ -179,7 +179,7 @@ export declare abstract class World {
      * @param isNetwork
      * @returns Ped object.
      */
-    static createPed(model: Model, position: Vector3, heading?: number, isNetwork?: boolean): Promise<Ped | null>;
+    static createPed(model: Model, position: Vector3, heading?: number, isNetwork?: boolean, pinToScript?: boolean): Promise<Ped | null>;
     /**
      * Creates a [[`Ped`]] with a random model.
      *
@@ -207,7 +207,7 @@ export declare abstract class World {
      * @param isNetwork
      * @returns Vehicle object.
      */
-    static createVehicle(model: Model, position: Vector3, heading?: number, isNetwork?: boolean): Promise<Vehicle | null>;
+    static createVehicle(model: Model, position: Vector3, heading?: number, isNetwork?: boolean, pinToScript?: boolean): Promise<Vehicle | null>;
     /**
      * Create a random vehicle at a desired location.
      *
@@ -234,12 +234,12 @@ export declare abstract class World {
      *
      * @param model The [[`Model`]] to spawn (must be a Prop)
      * @param position Location of Prop
-     * @param dynamic If set to true, the Prop will have physics otherwise it's static.
+     * @param doorFlag If set to true, the Prop will have physics otherwise it's static.
      * @param placeOnGround If set to true, sets the Prop on the ground nearest to position.
      * @param isNetwork
      * @returns Prop object.
      */
-    static createProp(model: Model, position: Vector3, dynamic: boolean, placeOnGround: boolean, isNetwork?: boolean): Promise<Prop | null>;
+    static createProp(model: Model, position: Vector3, placeOnGround: boolean, isNetwork?: boolean, pinToScript?: boolean, forceToBeObject?: boolean): Promise<Prop | null>;
     /**
      * Create a pickup in a specific position in the world with a specified type and value.
      *
@@ -250,7 +250,7 @@ export declare abstract class World {
      * @param rotation If set, create a rotating pickup with this rotation.
      * @returns Pickup object.
      */
-    static CreatePickup(type: PickupType, position: Vector3, model: Model, value: number, rotation?: Vector3): Promise<Pickup | null>;
+    static createPickup(type: PickupType, position: Vector3, model: Model, value: number, rotation?: Vector3): Promise<Pickup | null>;
     /**
      * Creates an ambient pickup.
      *
@@ -260,7 +260,7 @@ export declare abstract class World {
      * @param value The value tied to the pickup.
      * @returns The pickup in form of a Prop.
      */
-    static CreateAmbientPickup(type: PickupType, position: Vector3, model: Model, value: number): Promise<Prop | null>;
+    static createAmbientPickup(type: PickupType, position: Vector3, model: Model, value: number): Promise<Prop | null>;
     /**
      * Draw a marker at a desired location. Careful! Must be drawn every tick.
      *
@@ -363,6 +363,7 @@ export declare abstract class World {
      * @returns {@see AsynchronousRaycastResult} object that must be awaited to get its results.
      */
     static raycast(start: Vector3, end: Vector3, losFlags?: IntersectFlags, shapeTestOptions?: number, ignoreEntity?: BaseEntity): AsynchronousRaycastResult;
+    static raycastDirection(source: Vector3, direction: Vector3, maxDistance: number, losFlags?: IntersectFlags, shapeTestOptions?: number, ignoreEntity?: BaseEntity): AsynchronousRaycastResult;
     /**
      * Cast a ray from the local players camera until it hits an entity
      *

package/client/World.js

@@ -8,7 +8,7 @@ import { Ped, Vehicle } from './models';
 import { Pickup } from './Pickup';
 import { AsynchronousRaycastResult, SynchronousRaycastResult } from './Raycast';
 import { Rope } from './Rope';
-import { Maths, Wait } from './utils';
+import { Maths, Vector3, Wait } from './utils';
 /**
  * Class with common world manipulations.
  *
@@ -322,11 +322,16 @@ export class World {
      * @param isNetwork
      * @returns Ped object.
      */
-    static async createPed(model, position, heading = 0, isNetwork = true) {
+    static async createPed(model, position, heading = 0, isNetwork = true, pinToScript = true) {
         if (!model.IsPed || !(await model.request(1000))) {
             return null;
         }
-        return new Ped(CreatePed(26, model.Hash, position.x, position.y, position.z, heading, isNetwork, false));
+        const ped = CreatePed(-1, model.Hash, position.x, position.y, position.z, heading, isNetwork, pinToScript);
+        model.markAsNoLongerNeeded();
+        if (ped === 0) {
+            return null;
+        }
+        return new Ped(ped);
     }
     /**
      * Creates a [[`Ped`]] with a random model.
@@ -357,11 +362,15 @@ export class World {
      * @param isNetwork
      * @returns Vehicle object.
      */
-    static async createVehicle(model, position, heading = 0, isNetwork = true) {
+    static async createVehicle(model, position, heading = 0.0, isNetwork = true, pinToScript = true) {
         if (!model.IsVehicle || !(await model.request(1000))) {
             return null;
         }
-        return new Vehicle(CreateVehicle(model.Hash, position.x, position.y, position.z, heading, isNetwork, false));
+        const vehicle = CreateVehicle(model.Hash, position.x, position.y, position.z, heading, isNetwork, pinToScript);
+        if (vehicle === 0) {
+            return null;
+        }
+        return new Vehicle(vehicle);
     }
     /**
      * Create a random vehicle at a desired location.
@@ -376,16 +385,13 @@ export class World {
      * @param isNetwork
      * @returns Vehicle object.
      */
-    static async createRandomVehicle(position, heading = 0, isNetwork = true) {
+    static async createRandomVehicle(position, heading = 0.0, isNetwork = true) {
         const vehicleCount = Object.keys(VehicleHash).length / 2; // check
         const randomIndex = Maths.getRandomInt(0, vehicleCount);
         const randomVehicleName = VehicleHash[randomIndex];
         const modelHash = GetHashKey(randomVehicleName);
         const model = new Model(modelHash);
-        if (!model.IsVehicle || !(await model.request(1000))) {
-            return null;
-        }
-        return new Vehicle(CreateVehicle(model.Hash, position.x, position.y, position.z, heading, isNetwork, false));
+        return this.createVehicle(model, position, heading, isNetwork, false);
     }
     /*
      * Creates a rope at the specified location.
@@ -422,16 +428,21 @@ export class World {
      *
      * @param model The [[`Model`]] to spawn (must be a Prop)
      * @param position Location of Prop
-     * @param dynamic If set to true, the Prop will have physics otherwise it's static.
+     * @param doorFlag If set to true, the Prop will have physics otherwise it's static.
      * @param placeOnGround If set to true, sets the Prop on the ground nearest to position.
      * @param isNetwork
      * @returns Prop object.
      */
-    static async createProp(model, position, dynamic, placeOnGround, isNetwork = true) {
+    static async createProp(model, position, placeOnGround, isNetwork = true, pinToScript = true, forceToBeObject = false) {
         if (!model.IsProp || !(await model.request(1000))) {
             return null;
         }
-        const prop = new Prop(CreateObject(model.Hash, position.x, position.y, position.z, isNetwork, true, dynamic));
+        const object = CreateObject(model.Hash, position.x, position.y, position.z, isNetwork, pinToScript, forceToBeObject);
+        model.markAsNoLongerNeeded();
+        if (object === 0) {
+            return null;
+        }
+        const prop = new Prop(object);
         if (placeOnGround) {
             prop.placeOnGround();
         }
@@ -447,7 +458,7 @@ export class World {
      * @param rotation If set, create a rotating pickup with this rotation.
      * @returns Pickup object.
      */
-    static async CreatePickup(type, position, model, value, rotation) {
+    static async createPickup(type, position, model, value, rotation) {
         if (!(await model.request(1000))) {
             return null;
         }
@@ -456,6 +467,7 @@ export class World {
             handle = CreatePickupRotate(type, position.x, position.y, position.z, rotation.x, rotation.y, rotation.z, 0, value, 2, true, model.Hash);
         else
             handle = CreatePickup(type, position.x, position.y, position.z, 0, value, true, model.Hash);
+        model.markAsNoLongerNeeded();
         if (handle === 0) {
             return null;
         }
@@ -470,11 +482,12 @@ export class World {
      * @param value The value tied to the pickup.
      * @returns The pickup in form of a Prop.
      */
-    static async CreateAmbientPickup(type, position, model, value) {
+    static async createAmbientPickup(type, position, model, value) {
         if (!(await model.request(1000))) {
             return null;
         }
         const handle = CreateAmbientPickup(type, position.x, position.y, position.z, 0, value, model.Hash, false, true);
+        model.markAsNoLongerNeeded();
         if (handle === 0) {
             return null;
         }
@@ -599,6 +612,10 @@ export class World {
     static raycast(start, end, losFlags = IntersectFlags.All, shapeTestOptions = SHAPE_TEST_DEFAULT, ignoreEntity) {
         return new AsynchronousRaycastResult(StartShapeTestLosProbe(start.x, start.y, start.z, end.x, end.y, end.z, losFlags, ignoreEntity?.Handle ?? 0, shapeTestOptions));
     }
+    static raycastDirection(source, direction, maxDistance, losFlags = IntersectFlags.All, shapeTestOptions = SHAPE_TEST_DEFAULT, ignoreEntity) {
+        const target = Vector3.add(source, Vector3.multiply(direction, maxDistance));
+        return new AsynchronousRaycastResult(StartShapeTestLosProbe(source.x, source.y, source.z, target.x, target.y, target.z, losFlags, ignoreEntity?.Handle ?? 0, shapeTestOptions));
+    }
     /**
      * Cast a ray from the local players camera until it hits an entity
      *

package/common/utils/Vector.d.ts

@@ -206,7 +206,7 @@ export declare class Vector {
      * Creates a vector from an array or object containing vector components.
      * @param primitive The object to use as a vector.
      */
-    static fromObject<T extends VectorType, U extends InferVector<T> | VectorArray<T>>(this: T, primitive: U): InstanceType<T>;
+    static fromObject<T extends VectorType, U extends InferVector<T> | VectorArray<T>>(this: T, primitive: U | MsgpackBuffer): InstanceType<T>;
     /**
      * Creates an array of vectors from an array of number arrays
      * @param primitives A multi-dimensional array of number arrays
@@ -280,8 +280,8 @@ export declare class Vector {
      */
     divide(v: VectorLike | number): this;
     /**
-      * @see Vector.addAbsolute
-      */
+     * @see Vector.addAbsolute
+     */
     addAbsolute(v: VectorLike): this;
     /**
      * @see Vector.subtractAbsolute
@@ -346,8 +346,8 @@ export declare class Vector3 extends Vector implements Vec3 {
      */
     crossProduct(v: Vec3 | Vec4): Vec3 | Vec4;
     /**
-      * @returns the x and y values as Vec2
-      */
+     * @returns the x and y values as Vec2
+     */
     toVec2(): Vector2;
 }
 /**
@@ -379,12 +379,12 @@ export declare class Vector4 extends Vector {
      */
     crossProduct(v: Vec3 | Vec4): Vec3 | Vec4;
     /**
-      * @returns the x and y values as Vec2
-      */
+     * @returns the x and y values as Vec2
+     */
     toVec2(): Vector2;
     /**
-      * @returns the x and y values as Vec3
-      */
+     * @returns the x and y values as Vec3
+     */
     toVec3(): Vector3;
 }
 export {};

package/common/utils/Vector.js

@@ -57,12 +57,12 @@ 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 ?? 0);
-        y = operator(y, isNumber ? b : b.y ?? 0);
+        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);
+            z = operator(z, isNumber ? b : (b.z ?? 0));
         if (w)
-            w = operator(w, isNumber ? b : b.w ?? 0);
+            w = operator(w, isNumber ? b : (b.w ?? 0));
         return this.create(x, y, z, w);
     }
     /**
@@ -259,6 +259,8 @@ export class Vector {
     static fromObject(primitive) {
         if (Array.isArray(primitive))
             return this.fromArray(primitive);
+        if ('buffer' in primitive && 'type' in primitive)
+            return this.fromBuffer(primitive);
         const { x, y, z, w } = primitive;
         return this.create(x, y, z, w);
     }
@@ -387,8 +389,8 @@ export class Vector {
         return Vector.divide(this, v);
     }
     /**
-      * @see Vector.addAbsolute
-      */
+     * @see Vector.addAbsolute
+     */
     addAbsolute(v) {
         return Vector.addAbsolute(this, v);
     }
@@ -484,8 +486,8 @@ export class Vector3 extends Vector {
         return Vector.crossProduct(this, v);
     }
     /**
-      * @returns the x and y values as Vec2
-      */
+     * @returns the x and y values as Vec2
+     */
     toVec2() {
         return new Vector2(this.x, this.y);
     }
@@ -529,14 +531,14 @@ export class Vector4 extends Vector {
         return Vector.crossProduct(this, v);
     }
     /**
-      * @returns the x and y values as Vec2
-      */
+     * @returns the x and y values as Vec2
+     */
     toVec2() {
         return new Vector2(this.x, this.y);
     }
     /**
-      * @returns the x and y values as Vec3
-      */
+     * @returns the x and y values as Vec3
+     */
     toVec3() {
         return new Vector3(this.x, this.y, this.z);
     }

package/package.json

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