@nativewrappers/fivem 0.0.65 → 0.0.72

package/Model.js

@@ -1,213 +0,0 @@
-import { Game } from "./Game";
-import { VehicleHash } from "./hashes";
-import { Vector3, Wait } from "./utils";
-/**
- * Class to create and manage entity models.
- */
-export class Model {
-    /**
-     * Hash of this model.
-     */
-    hash;
-    requestedModel = false;
-    /**
-     * Creates a model object based on the hash key or model string.
-     *
-     * @param hash A number or string of the model's hash. Example: "mp_m_freemode_01"
-     */
-    constructor(hash) {
-        if (typeof hash === "string") {
-            this.hash = Game.generateHash(hash);
-        }
-        else {
-            this.hash = hash;
-        }
-    }
-    [Symbol.dispose]() {
-        if (this.requestedModel) {
-            this.markAsNoLongerNeeded();
-        }
-    }
-    /**
-     * Gets the hash of the model.
-     *
-     * @returns The hash key.
-     */
-    get Hash() {
-        return this.hash;
-    }
-    /**
-     * Gets if the model is valid or not.
-     *
-     * @returns Whether this model is valid.
-     */
-    get IsValid() {
-        return IsModelValid(this.hash);
-    }
-    /**
-     * Gets if the model is in cd image or not.
-     *
-     * @returns Whether this model is in cd image.
-     */
-    get IsInCdImage() {
-        return IsModelInCdimage(this.hash);
-    }
-    /**
-     * Gets if the model is loaded or not.
-     *
-     * @returns Whether this model is loaded.
-     */
-    get IsLoaded() {
-        return HasModelLoaded(this.hash);
-    }
-    /**
-     * Gets if the model collision is loaded or not.
-     *
-     * @returns Whether this model collision is loaded.
-     */
-    get IsCollisionLoaded() {
-        return HasCollisionForModelLoaded(this.hash);
-    }
-    /**
-     * Gets if the model is a bicycle or not.
-     *
-     * @returns Whether this model is a bicycle.
-     */
-    get IsBicycle() {
-        return IsThisModelABicycle(this.hash);
-    }
-    /**
-     * Gets if the model is a motorbike or not.
-     *
-     * @returns Whether this model is a motorbike.
-     */
-    get IsBike() {
-        return IsThisModelABike(this.hash);
-    }
-    /**
-     * Gets if the model is a boat or not.
-     *
-     * @returns Whether this model is a boat.
-     */
-    get IsBoat() {
-        return IsThisModelABoat(this.hash);
-    }
-    /**
-     * Gets if the model is a car or not.
-     *
-     * @returns Whether this model is a car.
-     */
-    get IsCar() {
-        return IsThisModelACar(this.hash);
-    }
-    /**
-     * Gets if the model is a cargobob or not.
-     *
-     * @returns Whether this model is a cargobob.
-     */
-    get IsCargobob() {
-        return (this.hash === VehicleHash.Cargobob ||
-            this.hash === VehicleHash.Cargobob2 ||
-            this.hash === VehicleHash.Cargobob3 ||
-            this.hash === VehicleHash.Cargobob4);
-    }
-    /**
-     * Gets if the model is a helicopter or not.
-     *
-     * @returns Whether this model is a helicopter.
-     */
-    get IsHelicopter() {
-        return IsThisModelAHeli(this.hash);
-    }
-    /**
-     * Gets if the model is a Ped or not.
-     *
-     * @returns Whether this model is a Ped.
-     */
-    get IsPed() {
-        return IsModelAPed(this.hash);
-    }
-    /**
-     * Gets if the model is a plane or not.
-     *
-     * @returns Whether this model is a plane.
-     */
-    get IsPlane() {
-        return IsThisModelAPlane(this.hash);
-    }
-    /**
-     * Gets if the model is a prop or not.
-     *
-     * @returns Whether this model is a prop.
-     */
-    get IsProp() {
-        return (this.IsValid &&
-            !this.IsPed &&
-            !this.IsVehicle &&
-            !IsWeaponValid(this.hash));
-    }
-    /**
-     * Gets if the model is a quadbike or not.
-     *
-     * @returns Whether this model is a quadbike.
-     */
-    get IsQuadbike() {
-        return IsThisModelAQuadbike(this.hash);
-    }
-    /**
-     * Gets if the model is a train or not.
-     *
-     * @returns Whether this model is a train.
-     */
-    get IsTrain() {
-        return IsThisModelATrain(this.hash);
-    }
-    /**
-     * Gets if the model is a Vehicle or not.
-     *
-     * @returns Whether this model is a Vehicle.
-     */
-    get IsVehicle() {
-        return IsModelAVehicle(this.hash);
-    }
-    /**
-     * Gets the model dimensions.
-     *
-     * @returns This model min & max dimensions.
-     */
-    get Dimensions() {
-        const [minArray, maxArray] = GetModelDimensions(this.hash);
-        const min = Vector3.fromArray(minArray);
-        const max = Vector3.fromArray(maxArray);
-        return { min, max };
-    }
-    /**
-     * 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 timeoutMs Maximum allowed time for model to load.
-     */
-    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 && GetGameTimer() < timeout) {
-            await Wait(0);
-        }
-        this.requestedModel = true;
-        return this.IsLoaded;
-    }
-    /**
-     * Sets the model as no longer needed allowing the game engine to free memory.
-     */
-    markAsNoLongerNeeded() {
-        SetModelAsNoLongerNeeded(this.hash);
-    }
-}

package/NetworkedScene.js

@@ -1,18 +0,0 @@
-export class NetworkedScene {
-    scene;
-    constructor(pos, rot, rotationOrder, holdLastFrame, looped, sceneHash, animTime, animSpeed) {
-        this.scene = NetworkCreateSynchronisedScene(pos.x, pos.y, pos.z, rot.x, rot.y, rot.z, rotationOrder, holdLastFrame, looped, sceneHash, animTime + 0.0, animSpeed + 0.0);
-    }
-    addPed(ped, animDict, animName, blendInSpeed, blendOutSpeed, duration, flag, playbackRate, p9) {
-        NetworkAddPedToSynchronisedScene(ped.Handle, this.scene, animDict, animName, blendInSpeed, blendOutSpeed, duration, flag, playbackRate, p9);
-    }
-    addEntity(entity, animDict, animName, speed, speedMultiplier, flag) {
-        NetworkAddEntityToSynchronisedScene(entity.Handle, this.scene, animDict, animName, speed, speedMultiplier, flag);
-    }
-    start() {
-        NetworkStartSynchronisedScene(this.scene);
-    }
-    stop() {
-        NetworkStopSynchronisedScene(this.scene);
-    }
-}

package/ParticleEffect.js

@@ -1,123 +0,0 @@
-import { InvertAxisFlags } from "./enums";
-import { Color, Vector3 } from "./utils";
-// TODO: Lots of Matrix stuff through memory access
-/**
- * UNFINISHED! Class to manage particle effects.
- */
-export class ParticleEffect {
-    asset;
-    effectName;
-    offset = new Vector3(0, 0, 0);
-    rotation = new Vector3(0, 0, 0);
-    color = Color.Transparent;
-    scale = 1.0;
-    range = 1.0;
-    invertAxis = { flags: InvertAxisFlags.None };
-    handle;
-    /**
-     * Creates a particle effect.
-     *
-     * @param asset Particle effect asset.
-     * @param effectName Name of effect.
-     */
-    constructor(asset, effectName) {
-        this.handle = -1;
-        this.asset = asset;
-        this.effectName = effectName;
-    }
-    /**
-     * Get the particle effect handle.
-     */
-    get Handle() {
-        return this.handle;
-    }
-    /**
-     * Get whether particle effect is currently active.
-     */
-    get IsActive() {
-        return this.Handle !== -1 && DoesParticleFxLoopedExist(this.Handle);
-    }
-    /**
-     * Stop a particle effect.
-     */
-    stop() {
-        if (this.IsActive) {
-            RemoveParticleFx(this.Handle, false);
-        }
-        this.handle = -1;
-    }
-    /**
-     * Get the rotation of the particle effect.
-     */
-    get Rotation() {
-        return this.rotation;
-    }
-    /**
-     * Set the rotation of the particle effect.
-     */
-    set Rotation(rotation) {
-        this.rotation = rotation;
-        if (this.IsActive) {
-            const off = this.offset; // TODO Matrix stuff to access from memory
-            SetParticleFxLoopedOffsets(this.Handle, off.x, off.y, off.z, rotation.x, rotation.y, rotation.z);
-        }
-    }
-    /**
-     * Get the range of the particle effect.
-     */
-    get Range() {
-        return this.range;
-    }
-    /**
-     * Set the range of the particle effect.
-     */
-    set Range(range) {
-        this.range = range;
-        SetParticleFxLoopedRange(this.Handle, range);
-    }
-    /**
-     * Get the invert axis flag of the particle effect.
-     */
-    get InvertAxis() {
-        return this.invertAxis;
-    }
-    /**
-     * Set the inverted axis of the particle effect.
-     */
-    set InvertAxis(invertAxis) {
-        this.invertAxis = invertAxis;
-        if (this.IsActive) {
-            this.stop();
-            this.start();
-        }
-    }
-    /**
-     * Set a paramaeter of a particle effect.
-     *
-     * @param parameterName Name of parameter.
-     * @param value Value of parameter.
-     */
-    setParameter(parameterName, value) {
-        if (this.IsActive) {
-            SetParticleFxLoopedEvolution(this.Handle, parameterName, value, false);
-        }
-    }
-    /**
-     * Get the name of the particle effect asset. Same as ParticleEffect.AssetName.
-     */
-    get AssetName() {
-        return this.asset.AssetName;
-    }
-    /**
-     * Get the name of the particle effect.
-     */
-    get EffectName() {
-        return this.effectName;
-    }
-    /**
-     * Return the particle effect as string. `AssetName`\\`EffectName`.
-     */
-    toString() {
-        return `${this.AssetName}\\${this.EffectName}`;
-    }
-}

package/ParticleEffectAsset.js

@@ -1,105 +0,0 @@
-import { InvertAxisFlags } from "./enums";
-import { Vector3 } from "./utils";
-/**
- * UNFINISHED! Class that represents a particle effect asset.
- */
-export class ParticleEffectAsset {
-    /**
-     * Returns the name of the asset. Same as AssetName.
-     */
-    get Asset() {
-        return this.assetName;
-    }
-    assetName;
-    constructor(assetName) {
-        this.assetName = assetName;
-    }
-    /**
-     * Get the name of the particle effect.
-     */
-    get AssetName() {
-        return this.assetName;
-    }
-    /**
-     * Get whether the particle effect has loaded into game memory.
-     */
-    get IsLoaded() {
-        return HasNamedPtfxAssetLoaded(this.assetName);
-    }
-    /**
-     * Start a particle effect at a world position.
-     *
-     * @param effectName Name of effect.
-     * @param rot Rotation from entity position.
-     * @param scale Size of the effect.
-     * @param invertAxis Which axis to invert (default none).
-     */
-    startNonLoopedAtCoord(effectName, pos, rot = new Vector3(0, 0, 0), scale = 1.0, invertAxis = { flags: InvertAxisFlags.None }) {
-        if (!this.setNextCall()) {
-            return false;
-        }
-        const invertAxisFlags = invertAxis.flags;
-        SetPtfxAssetNextCall(this.assetName);
-        return (StartParticleFxLoopedAtCoord(effectName, pos.x, pos.y, pos.z, rot.x, rot.y, rot.z, scale, !!(invertAxisFlags & InvertAxisFlags.X), !!(invertAxisFlags & InvertAxisFlags.Y), !!(invertAxisFlags & InvertAxisFlags.Z), false) > 0);
-    }
-    /**
-     * Start a particle effect on an entity
-     *
-     * @param effectName Name of effect.
-     * @param entity Entity to use effect on.
-     * @param off Offset from entity position.
-     * @param rot Rotation from entity position.
-     * @param scale Size of the effect.
-     * @param invertAxis Which axis to invert (default none).
-     */
-    startNonLoopedOnEntity(effectName, entity, off = new Vector3(0, 0, 0), rot = new Vector3(0, 0, 0), scale = 1.0, invertAxis = { flags: InvertAxisFlags.None }) {
-        if (!this.setNextCall()) {
-            return false;
-        }
-        const invertAxisFlags = invertAxis.flags;
-        SetPtfxAssetNextCall(this.assetName);
-        // This still returns
-        return !!StartParticleFxLoopedOnEntity(effectName, entity.Handle, off.x, off.y, off.z, rot.x, rot.y, rot.z, scale, !!(invertAxisFlags & InvertAxisFlags.X), !!(invertAxisFlags & InvertAxisFlags.Y), !!(invertAxisFlags & InvertAxisFlags.Z));
-    }
-    /**
-     * Load a particle effect into the game memory.
-     *
-     * @param timeout Max time to load Particle Effect
-     */
-    request(timeout) {
-        return new Promise((resolve) => {
-            if (!this.IsLoaded) {
-                RequestNamedPtfxAsset(this.assetName);
-                const start = GetGameTimer();
-                const interval = setInterval(() => {
-                    if (this.IsLoaded || GetGameTimer() - start >= timeout) {
-                        clearInterval(interval);
-                        resolve(this.IsLoaded);
-                    }
-                }, 0);
-            }
-            else {
-                resolve(this.IsLoaded);
-            }
-        });
-    }
-    /**
-     * Allow game engine to safely unload particle effect model from memory.
-     */
-    markAsNoLongerNeeded() {
-        RemoveNamedPtfxAsset(this.assetName);
-    }
-    toString() {
-        return this.assetName;
-    }
-    setNextCall() {
-        if (!this.IsLoaded) {
-            RequestNamedPtfxAsset(this.assetName);
-        }
-        else {
-            SetPtfxAssetNextCall(this.assetName);
-            return true;
-        }
-        return false;
-    }
-}

package/Pickup.js

@@ -1,19 +0,0 @@
-import { Vector3 } from "./utils";
-export class Pickup {
-    handle;
-    constructor(handle) {
-        this.handle = handle;
-    }
-    get Position() {
-        return Vector3.fromArray(GetPickupCoords(this.handle));
-    }
-    get IsCollected() {
-        return HasPickupBeenCollected(this.handle);
-    }
-    delete() {
-        RemovePickup(this.handle);
-    }
-    exists() {
-        return DoesPickupExist(this.handle);
-    }
-}

package/Raycast.js

@@ -1,123 +0,0 @@
-import { ShapeTestStatus } from "./enums/RaycastEnums";
-import { Game } from "./Game";
-import { Delay, Vector3 } from "./utils";
-/**
- * Class that represents the result of a raycast.
- */
-class RaycastResult {
-    /**
-     * Return the entity that was hit.
-     */
-    get HitEntity() {
-        return this.entityHandleArg;
-    }
-    /**
-     * Get the position of the entity that was hit.
-     */
-    get HitPosition() {
-        return this.hitPositionArg;
-    }
-    /**
-     * Return the vector perpendicular to the tangent plane.
-     */
-    get SurfaceNormal() {
-        return this.surfaceNormalArg;
-    }
-    /**
-     * Whether we hit anything.
-     */
-    get DidHit() {
-        return this.hitSomethingArg;
-    }
-    /**
-     * Whether the entity hit exists.
-     */
-    get DidHitEntity() {
-        return this.entityHandleArg !== null && this.entityHandleArg.Handle !== 0;
-    }
-    /**
-     * Material type that was hit.
-     */
-    get Material() {
-        return this.materialArg;
-    }
-    /**
-     * Raycast result's handle.
-     */
-    get Result() {
-        return this.result;
-    }
-    /**
-     * @returns if the shape test handle was already discarded
-     */
-    get WasDiscarded() {
-        return this.result === ShapeTestStatus.Discarded;
-    }
-    /**
-     * NOTE: These will not be updated unless polled by `resolve` or the shape
-     * test is synchronous
-     * @returns if the raycast has been marked as ready by the engine
-     */
-    get HasResolved() {
-        return this.result === ShapeTestStatus.Ready;
-    }
-    applyShapeTestResults() {
-        const [result, hit, endCoords, surfaceNormal, materialHash, entityHit] = GetShapeTestResultIncludingMaterial(this.handle);
-        this.result = result;
-        if (!this.HasResolved || this.WasDiscarded)
-            return;
-        this.hitSomethingArg = hit;
-        this.hitPositionArg = Vector3.fromArray(endCoords);
-        this.surfaceNormalArg = Vector3.fromArray(surfaceNormal);
-        this.materialArg = materialHash;
-        if (entityHit !== 0) {
-            this.entityHandleArg = Game.entityFromHandle(entityHit);
-        }
-    }
-    handle;
-    hitPositionArg;
-    hitSomethingArg;
-    entityHandleArg;
-    surfaceNormalArg;
-    materialArg;
-    result;
-    /**
-     * Create a RaycastResult object that gets the results from a StartShapeTestRay()
-     *
-     * @param handle The handle returned from StartShapeTestRay()
-     */
-    constructor(handle) {
-        this.handle = handle;
-        this.hitPositionArg = new Vector3(0, 0, 0);
-        this.hitSomethingArg = false;
-        this.entityHandleArg = null;
-        this.surfaceNormalArg = new Vector3(0, 0, 0);
-        this.materialArg = 0;
-        this.result = ShapeTestStatus.NotReady;
-    }
-}
-export class SynchronousRaycastResult extends RaycastResult {
-    constructor(handle) {
-        super(handle);
-        // if we're using a synchronous call then we want to instantly update our
-        // data, if its invalid then the caller can deal with it.
-        this.applyShapeTestResults();
-    }
-}
-export class AsynchronousRaycastResult extends RaycastResult {
-    /**
-     * waits until the shape test handle is valid and then sets the expected
-     * values on the RaycastResult
-     */
-    async resolve(timeoutInMs = 1000) {
-        const timeout = GetGameTimer() + timeoutInMs;
-        // this has to be polled every frame or the engien will mark the field shape
-        // test handle as discarded
-        while (!this.HasResolved && !this.WasDiscarded) {
-            this.applyShapeTestResults();
-            if (timeout < GetGameTimer())
-                break;
-            await Delay(0);
-        }
-    }
-}

package/RelationshipGroup.js

@@ -1,67 +0,0 @@
-/**
- * Class to create and manage a relationship group. Useful to manage behavior between Peds.
- */
-export class RelationshipGroup {
-    /**
-     * The hash of the relationship group
-     */
-    hash;
-    /**
-     * Create a relationship group. Optionally pass a group hash.
-     *
-     * @param name Name of the relationship group.
-     */
-    constructor(name) {
-        const [, groupHash] = AddRelationshipGroup(name);
-        this.hash = groupHash;
-    }
-    /**
-     * Gets the hash of the relationship group.
-     *
-     * @returns The hash of this object.
-     */
-    get Hash() {
-        return this.hash;
-    }
-    /**
-     * Get the relationship between two relationship groups.
-     *
-     * @param targetGroup The other relationship group.
-     * @returns The relationship
-     */
-    getRelationshipBetweenGroups(targetGroup) {
-        return GetRelationshipBetweenGroups(this.Hash, targetGroup.Hash);
-    }
-    /**
-     * Set the relationship group between this relationship group and another one.
-     *
-     * @param targetGroup The other relationship group.
-     * @param relationship The desired relationship.
-     * @param biDirectionally If target group should have same relationship towards this.
-     */
-    setRelationshipBetweenGroups(targetGroup, relationship, biDirectionally = false) {
-        SetRelationshipBetweenGroups(Number(relationship), this.Hash, targetGroup.Hash);
-        if (biDirectionally) {
-            SetRelationshipBetweenGroups(Number(relationship), targetGroup.Hash, this.Hash);
-        }
-    }
-    /**
-     * Clear the relationship between this relationship group and another.
-     *
-     * @param targetGroup The other relationship group.
-     * @param relationship The desired relationship to clear.
-     * @param biDirectionally Whether the target group should also clear the relationship.
-     */
-    clearRelationshipBetweenGroups(targetGroup, relationship, biDirectionally = false) {
-        ClearRelationshipBetweenGroups(Number(relationship), this.Hash, targetGroup.Hash);
-        if (biDirectionally) {
-            ClearRelationshipBetweenGroups(Number(relationship), targetGroup.Hash, this.Hash);
-        }
-    }
-    /**
-     * Remove this relationship group from the game. This will not delete this object.
-     */
-    remove() {
-        RemoveRelationshipGroup(this.Hash);
-    }
-}