@armoury/fivem-framework-client 0.0.0-stage → 1.0.8

package/dist/cjs/client/client-action-points.js

@@ -0,0 +1,179 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientActionPoints = void 0;
+// TODO: Remove
+const client_entities_1 = require("./client-entities");
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+let ClientActionPoints = class ClientActionPoints extends client_entities_1.ClientEntities {
+    constructor() {
+        super(...arguments);
+        this.chunkRadius = 75;
+        this._actionPoints = {};
+        this._cachedPlayerPosition = [NaN, NaN];
+        this._cachedPlayerRoundedPosition = [NaN, NaN];
+        this._cachedIsPlayerInAnyVehicle = false;
+    }
+    get actionPoints() {
+        return this._actionPoints;
+    }
+    get cachedPlayerPosition() {
+        return this._cachedPlayerPosition;
+    }
+    createMarkers(markers) {
+        super.createMarkers(markers);
+        this.createActionPoints(...markers.map((marker) => ({
+            id: `${Cfx.Client.GetCurrentResourceName()}_marker_${marker.pos[0]}_${marker.pos[1]}`,
+            pos: marker.pos,
+            range: marker.renderDistance,
+            action: async () => {
+                var _a, _b, _c, _d, _e, _f, _g;
+                if (marker.textureDict && !Cfx.Client.HasStreamedTextureDictLoaded(marker.textureDict)) {
+                    Cfx.Client.RequestStreamedTextureDict(marker.textureDict, true);
+                    while (!Cfx.Client.HasStreamedTextureDictLoaded(marker.textureDict)) {
+                        await (0, fivem_framework_common_1.Delay)(100);
+                    }
+                }
+                Cfx.Client.DrawMarker(marker.marker, marker.pos[0], marker.pos[1], marker.pos[2], 0.0, 0.0, 0.0, ((_a = marker.rotation) === null || _a === void 0 ? void 0 : _a[0]) || 0.0, ((_b = marker.rotation) === null || _b === void 0 ? void 0 : _b[1]) || 0.0, ((_c = marker.rotation) === null || _c === void 0 ? void 0 : _c[2]) || 0.0, marker.scale, marker.scale, marker.scale, marker.rgba[0], marker.rgba[1], marker.rgba[2], marker.rgba[3], false, true, 2, false, (marker.textureDict || null), (marker.textureName || null), false);
+                if (marker.underlyingCircle) {
+                    Cfx.Client.DrawMarker(marker.underlyingCircle.marker, marker.pos[0], marker.pos[1], marker.pos[2] - 0.9, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, marker.underlyingCircle.scale, marker.underlyingCircle.scale, marker.underlyingCircle.scale, ((_d = marker.underlyingCircle.rgba) === null || _d === void 0 ? void 0 : _d[0]) || marker.rgba[0], ((_e = marker.underlyingCircle.rgba) === null || _e === void 0 ? void 0 : _e[1]) || marker.rgba[1], ((_f = marker.underlyingCircle.rgba) === null || _f === void 0 ? void 0 : _f[2]) || marker.rgba[2], ((_g = marker.underlyingCircle.rgba) === null || _g === void 0 ? void 0 : _g[3]) || marker.rgba[3], false, true, 2, false, null, null, false);
+                }
+            }
+        })));
+    }
+    clearMarkers() {
+        this.markers.forEach((_marker) => {
+            this.clearActionPoint(`${Cfx.Client.GetCurrentResourceName()}_marker_${_marker.pos[0]}_${_marker.pos[1]}`);
+        });
+        super.clearMarkers();
+    }
+    /** Creates one or multiple Action Points. Action points DO NOT include markers and/or blips.
+     * They only contain the logic executed when a position is met.
+    */
+    createActionPoints(...actionPoints) {
+        actionPoints.forEach((actionPoint) => {
+            this.createActionPoint(actionPoint);
+        });
+    }
+    createActionPoint(actionPoint) {
+        const nearestX = this.roundToNearest(actionPoint.pos[0], this.chunkRadius);
+        const nearestY = this.roundToNearest(actionPoint.pos[1], this.chunkRadius);
+        if (!this._actionPoints[nearestX]) {
+            this._actionPoints[nearestX] = {};
+        }
+        if (!this.actionPoints[nearestX][nearestY]) {
+            this._actionPoints[nearestX][nearestY] = [];
+        }
+        this._actionPoints[nearestX][nearestY].push(actionPoint);
+    }
+    clearActionPoint(id) {
+        Object.keys(this._actionPoints).forEach((posXAsStr) => {
+            const posX = Number(posXAsStr);
+            Object.keys(this._actionPoints[posX]).forEach((posYAsStr) => {
+                const posY = Number(posYAsStr);
+                this._actionPoints[posX][posY] =
+                    this._actionPoints[posX][posY].filter((_actionPoint) => _actionPoint.id != id);
+            });
+        });
+    }
+    clearActionPoints() {
+        this._actionPoints = {};
+        this.removeFromTick(`${Cfx.Client.GetCurrentResourceName()}_actionpoints`);
+    }
+    actionPointExistsAtPosition(posX, posY, posZ) {
+        const roundedPosX = this.roundToNearest(posX, this.chunkRadius);
+        const roundedPosY = this.roundToNearest(posY, this.chunkRadius);
+        if (!this.actionPoints[roundedPosX] || !this.actionPoints[roundedPosX][roundedPosY]) {
+            return false;
+        }
+        if (this.actionPoints[roundedPosX][roundedPosY].find((actionPoint) => actionPoint.pos[0] == posX
+            && actionPoint.pos[1] == posY
+            && actionPoint.pos[2] == posZ)) {
+            return true;
+        }
+        return false;
+    }
+    removeActionPoint(actionPoint) {
+        var _a, _b;
+        if ((_b = (_a = this._actionPoints[this.roundToNearest(actionPoint.pos[0], this.chunkRadius)]) === null || _a === void 0 ? void 0 : _a[this.roundToNearest(actionPoint.pos[1], this.chunkRadius)]) === null || _b === void 0 ? void 0 : _b.length) {
+            this._actionPoints[this.roundToNearest(actionPoint.pos[0], this.chunkRadius)][this.roundToNearest(actionPoint.pos[1], this.chunkRadius)] =
+                this._actionPoints[this.roundToNearest(actionPoint.pos[0], this.chunkRadius)][this.roundToNearest(actionPoint.pos[1], this.chunkRadius)].filter((_actionPoint) => _actionPoint.id != actionPoint.id);
+        }
+    }
+    onThreadTriggered(optimizationType) {
+        var _a, _b;
+        if (optimizationType === 'chunk-checker') {
+            this._cachedPlayerPosition = Cfx.Client.GetEntityCoords(Cfx.Client.PlayerPedId(), true);
+            const [nearestX, nearestY] = [this.roundToNearest(this._cachedPlayerPosition[0], this.chunkRadius), this.roundToNearest(this._cachedPlayerPosition[1], this.chunkRadius)];
+            if (this._cachedPlayerRoundedPosition[0] == nearestX && this._cachedPlayerRoundedPosition[1] == nearestY) {
+                return;
+            }
+            this._cachedPlayerRoundedPosition = [nearestX, nearestY];
+            this._cachedIsPlayerInAnyVehicle = Cfx.Client.IsPedInAnyVehicle(Cfx.Client.PlayerPedId(), false);
+            if ((_b = (_a = this._actionPoints[this._cachedPlayerRoundedPosition[0]]) === null || _a === void 0 ? void 0 : _a[this._cachedPlayerRoundedPosition[1]]) === null || _b === void 0 ? void 0 : _b.length) {
+                this.addToTickUnique({
+                    id: `${Cfx.Client.GetCurrentResourceName()}_actionpoints`,
+                    function: (() => {
+                        var _a, _b, _c, _d;
+                        for (let i = 0; i < ((_b = (_a = this._actionPoints[this._cachedPlayerRoundedPosition[0]]) === null || _a === void 0 ? void 0 : _a[this._cachedPlayerRoundedPosition[1]]) === null || _b === void 0 ? void 0 : _b.length); i++) {
+                            const _actionPoint = (_c = this._actionPoints[this._cachedPlayerRoundedPosition[0]]) === null || _c === void 0 ? void 0 : _c[this._cachedPlayerRoundedPosition[1]][i];
+                            if ((0, fivem_framework_common_1.calculateDistance)([_actionPoint.pos[0], _actionPoint.pos[1], _actionPoint.pos[2], this._cachedPlayerPosition[0], this._cachedPlayerPosition[1], _actionPoint.pos[2]]) <= (_actionPoint.range || 1.0) + (this._cachedIsPlayerInAnyVehicle && !_actionPoint.onfootOnly ? 5 : 0)) {
+                                const actionPassed = (!_actionPoint.onceIf || _actionPoint.onceIf()) && (!_actionPoint.onfootOnly || !Cfx.Client.IsPedInAnyVehicle(Cfx.Client.PlayerPedId(), false)) && (!_actionPoint.inVehicleOnly || Cfx.Client.IsPedInAnyVehicle(Cfx.Client.PlayerPedId(), false));
+                                if (actionPassed) {
+                                    _actionPoint.action();
+                                }
+                                if ((_actionPoint.once || _actionPoint.onceIf) && actionPassed) {
+                                    (_d = this._actionPoints[this._cachedPlayerRoundedPosition[0]]) === null || _d === void 0 ? void 0 : _d[this._cachedPlayerRoundedPosition[1]].splice(i, 1);
+                                    i--;
+                                }
+                            }
+                        }
+                    })
+                });
+            }
+            else {
+                this.removeFromTick(`${Cfx.Client.GetCurrentResourceName()}_actionpoints`);
+            }
+        }
+    }
+    debug_ActionPoints() {
+        var _a, _b;
+        let totalActionPoints = 0;
+        const currentAreaActionPoints = ((_b = (_a = this.actionPoints[this.roundToNearest(this._cachedPlayerPosition[0], this.chunkRadius)]) === null || _a === void 0 ? void 0 : _a[this.roundToNearest(this._cachedPlayerPosition[1], this.chunkRadius)]) === null || _b === void 0 ? void 0 : _b.length) || 0;
+        Object.keys(this.actionPoints).forEach((posXAsStr) => {
+            const posX = Number(posXAsStr);
+            Object.keys(this.actionPoints[posX]).forEach((posYAsStr) => {
+                const posY = Number(posYAsStr);
+                totalActionPoints += this.actionPoints[posX][posY].length;
+            });
+        });
+        console.log(`Total action points: ${totalActionPoints}. Action points in this area: ${currentAreaActionPoints}`);
+    }
+    roundToNearest(num, multiple) {
+        return Math.round(num / multiple) * multiple;
+    }
+};
+exports.ClientActionPoints = ClientActionPoints;
+__decorate([
+    (0, fivem_framework_common_1.EventListener)({ eventName: 'armoury:thread-triggerer', direction: fivem_framework_common_1.EVENT_DIRECTIONS.CLIENT_TO_CLIENT }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ClientActionPoints.prototype, "onThreadTriggered", null);
+__decorate([
+    (0, fivem_framework_common_1.Command)({ suffix: `_${Cfx.Client.GetCurrentResourceName()}` }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ClientActionPoints.prototype, "debug_ActionPoints", null);
+exports.ClientActionPoints = ClientActionPoints = __decorate([
+    (0, fivem_framework_common_1.Controller)()
+], ClientActionPoints);

package/dist/cjs/client/client-entities.js

@@ -0,0 +1,287 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientEntities = void 0;
+// TODO: Remove
+const color_mappings_1 = require("./constants/color.mappings");
+const client_base_1 = require("./client.base");
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+let ClientEntities = class ClientEntities extends client_base_1.ClientBase {
+    get blips() {
+        return this._blips;
+    }
+    get markers() {
+        return this._markers;
+    }
+    get vehicles() {
+        return this._vehicles;
+    }
+    get peds() {
+        return this._peds;
+    }
+    get waypoints() {
+        return this._waypoints;
+    }
+    get checkpoints() {
+        return this._checkpoints;
+    }
+    constructor() {
+        super();
+        this._blips = [];
+        this._markers = [];
+        this._vehicles = [];
+        this._peds = [];
+        this._waypoints = [];
+        this._checkpoints = new Map();
+        this.assignDefaultEntityListeners();
+    }
+    createBlips(blips) {
+        const _blips = blips.map((blip) => (Object.assign(Object.assign({}, blip), { instance: null })));
+        this._blips.push(..._blips);
+        this.refreshBlips();
+    }
+    createBlip(blip) {
+        var _a;
+        const _blip = (!blip.type || blip.type === 'coords'
+            ? Cfx.Client.AddBlipForCoord(blip.pos[0], blip.pos[1], blip.pos[2])
+            : (blip.type === 'range'
+                ? Cfx.Client.AddBlipForRadius(blip.pos[0], blip.pos[1], blip.pos[2], blip.scale || 1.0)
+                : Cfx.Client.AddBlipForEntity((_a = blip.entityId) !== null && _a !== void 0 ? _a : Cfx.Client.PlayerPedId())));
+        if (!blip.type || blip.type !== 'range') {
+            Cfx.Client.SetBlipScale(_blip, blip.scale || 1.0);
+        }
+        Cfx.Client.SetBlipSprite(_blip, blip.id);
+        Cfx.Client.SetBlipDisplay(_blip, 4);
+        Cfx.Client.SetBlipColour(_blip, blip.color);
+        Cfx.Client.SetBlipAlpha(_blip, blip.alpha || 255);
+        Cfx.Client.SetBlipAsShortRange(_blip, !blip.longRange);
+        Cfx.Client.BeginTextCommandSetBlipName('STRING');
+        Cfx.Client.AddTextComponentString(blip.title);
+        Cfx.Client.EndTextCommandSetBlipName(_blip);
+        return _blip;
+    }
+    clearBlip(blipId) {
+        this._blips = this._blips.filter((_blip) => _blip.instance !== blipId);
+        if (Cfx.Client.DoesBlipExist(blipId)) {
+            Cfx.Client.RemoveBlip(blipId);
+        }
+    }
+    clearBlips() {
+        this._blips.forEach((blip) => {
+            Cfx.Client.RemoveBlip(blip.instance);
+        });
+        this._blips = [];
+    }
+    refreshBlips() {
+        this.blips.forEach((blip) => {
+            if (!blip.instance) {
+                blip.instance = this.createBlip(blip);
+            }
+        });
+    }
+    /** Defines a custom, irreplaceable waypoint */
+    createWaypoint(pos, title, color, id, routeColor, diameter = 3.0) {
+        const currentResource = Cfx.Client.GetCurrentResourceName().replace('-', ' ');
+        const defaultTitle = `${currentResource.slice(0, 1).toUpperCase()}${currentResource.slice(1)}`;
+        const _waypoint = this.createBlip({
+            id: id || 1,
+            color: color || 69,
+            title: title || defaultTitle,
+            pos,
+            longRange: true
+        });
+        this.createCheckpoint(2, pos[0], pos[1], pos[2], null, null, null, diameter, color_mappings_1.COLOR_MAPPINGS[color !== null && color !== void 0 ? color : 0][0], color_mappings_1.COLOR_MAPPINGS[color !== null && color !== void 0 ? color : 0][1], color_mappings_1.COLOR_MAPPINGS[color !== null && color !== void 0 ? color : 0][2], 255, 0);
+        if (routeColor !== -1) {
+            Cfx.Client.SetBlipRoute(_waypoint, true);
+            if (routeColor) {
+                Cfx.Client.SetBlipRouteColour(_waypoint, routeColor);
+            }
+        }
+        this._waypoints.push(_waypoint);
+        return _waypoint;
+    }
+    clearWaypoints() {
+        this._waypoints.forEach((waypoint) => {
+            this.clearWaypoint(waypoint, true);
+        });
+        this._waypoints = [];
+    }
+    clearWaypoint(waypoint, ignoreSplice = false) {
+        this.clearCheckpointByPosition(Cfx.Client.GetBlipCoords(waypoint));
+        Cfx.Client.SetBlipRoute(waypoint, false);
+        Cfx.Client.RemoveBlip(waypoint);
+        if (!ignoreSplice) {
+            this._waypoints.splice(this._waypoints.indexOf(waypoint), 1);
+        }
+    }
+    createCheckpoint(type, posX1, posY1, posZ1, posX2, posY2, posZ2, diameter, red, green, blue, alpha, reserved) {
+        const checkpoint = Cfx.Client.CreateCheckpoint(type, posX1, posY1, posZ1, posX2, posY2, posZ2, diameter, red, green, blue, alpha, reserved);
+        this._checkpoints.set(checkpoint, [posX1, posY1, posZ1, posX2, posY2, posZ2]);
+        return checkpoint;
+    }
+    clearCheckpoint(checkpoint) {
+        Cfx.Client.DeleteCheckpoint(checkpoint);
+        if (this._checkpoints.has(checkpoint)) {
+            this._checkpoints.delete(checkpoint);
+        }
+    }
+    clearCheckpointByPosition(pos) {
+        const checkpoint = Array.from(this._checkpoints.keys()).find((_checkpoint) => Math.floor(this._checkpoints.get(_checkpoint)[0]) === Math.floor(pos[0])
+            && Math.floor(this._checkpoints.get(_checkpoint)[1]) === Math.floor(pos[1])
+            && Math.floor(this._checkpoints.get(_checkpoint)[2]) === Math.floor(pos[2]));
+        if (checkpoint) {
+            this.clearCheckpoint(checkpoint);
+        }
+    }
+    /** Defines permanent markers. Handles draw-per-tick automatically. */
+    createMarkers(markers) {
+        const _markers = markers.map((marker) => (Object.assign(Object.assign({}, marker), { instance: null })));
+        this._markers.push(..._markers);
+    }
+    clearMarkers() {
+        this._markers = [];
+    }
+    /** Wrapper of FiveM's native CreateVehicle - includes requesting the model */
+    async createVehicleAsync(modelHash, x, y, z, heading, isNetwork, netMissionEntity, putPlayerInVehicle = false) {
+        let attempts = 0;
+        Cfx.Client.RequestModel(modelHash);
+        while (!Cfx.Client.HasModelLoaded(modelHash)) {
+            if (attempts > 10) {
+                return 0;
+            }
+            await (0, fivem_framework_common_1.Delay)(100);
+            attempts++;
+        }
+        const createdVehicle = Cfx.Client.CreateVehicle(modelHash, x, y, z, heading, isNetwork, netMissionEntity);
+        if (createdVehicle) {
+            if (netMissionEntity) {
+                this._vehicles.push(createdVehicle);
+            }
+            if (putPlayerInVehicle) {
+                Cfx.Client.TaskWarpPedIntoVehicle(Cfx.Client.GetPlayerPed(-1), createdVehicle, -1);
+            }
+        }
+        return createdVehicle;
+    }
+    removeVehicle(vehicle) {
+        if (Cfx.Client.DoesEntityExist(vehicle)) {
+            Cfx.Client.DeleteEntity(vehicle);
+        }
+        if (this._vehicles.indexOf(vehicle) > -1) {
+            this._vehicles.splice(this._vehicles.indexOf(vehicle), 1);
+        }
+    }
+    removePed(ped) {
+        if (Cfx.Client.DoesEntityExist(ped)) {
+            Cfx.Client.DeleteEntity(ped);
+        }
+        if (this._peds.indexOf(ped) > -1) {
+            this._peds.splice(this._peds.indexOf(ped), 1);
+        }
+    }
+    async createPedInsideVehicleAsync(vehicle, pedType, modelHash, seat, isNetwork, bScriptHostPed) {
+        let attempts = 0;
+        Cfx.Client.RequestModel(modelHash);
+        while (!Cfx.Client.HasModelLoaded(modelHash)) {
+            if (attempts > 10) {
+                return 0;
+            }
+            await (0, fivem_framework_common_1.Delay)(100);
+            attempts++;
+        }
+        const createdPed = Cfx.Client.CreatePedInsideVehicle(vehicle, pedType, modelHash, seat, isNetwork, bScriptHostPed);
+        if (createdPed) {
+            this._peds.push(createdPed);
+        }
+        return createdPed;
+    }
+    async createPedAsync(pedType, modelHash, x, y, z, heading, isNetwork, bScriptHostPed) {
+        let attempts = 0;
+        Cfx.Client.RequestModel(modelHash);
+        while (!Cfx.Client.HasModelLoaded(modelHash)) {
+            if (attempts > 10) {
+                return 0;
+            }
+            await (0, fivem_framework_common_1.Delay)(100);
+            attempts++;
+        }
+        const createdPed = Cfx.Client.CreatePed(pedType, modelHash, x, y, z, heading, isNetwork, bScriptHostPed);
+        if (createdPed) {
+            this._peds.push(createdPed);
+        }
+        return createdPed;
+    }
+    async playAnimForPed(ped, animationDict, animationName, duration, flag = 0, blendInSpeed = 8.0, blendOutSpeed = 8.0) {
+        let attempts = 0;
+        Cfx.Client.RequestAnimDict(animationDict);
+        while (!Cfx.Client.HasAnimDictLoaded(animationDict)) {
+            if (attempts > 10) {
+                return;
+            }
+            await (0, fivem_framework_common_1.Delay)(100);
+            attempts++;
+        }
+        if (Cfx.Client.HasAnimDictLoaded(animationDict)) {
+            Cfx.Client.TaskPlayAnim(ped, animationDict, animationName, blendInSpeed, blendOutSpeed, duration, flag, 0, false, false, false);
+        }
+    }
+    async setPedModelAsync(ped, modelHash) {
+        let attempts = 0;
+        Cfx.Client.RequestModel(modelHash);
+        while (!Cfx.Client.HasModelLoaded(modelHash)) {
+            if (attempts > 10) {
+                return false;
+            }
+            await (0, fivem_framework_common_1.Delay)(100);
+            attempts++;
+        }
+        Cfx.Client.SetPlayerModel(ped, modelHash);
+        Cfx.Client.SetModelAsNoLongerNeeded(modelHash);
+        return true;
+    }
+    assignDefaultEntityListeners() {
+        Cfx.Client.onNet('onResourceStop', (resourceName) => {
+            if (resourceName === Cfx.Client.GetCurrentResourceName()) {
+                this._vehicles.forEach((vehicle) => {
+                    this.removeVehicle(vehicle);
+                });
+                this._peds.forEach((ped) => {
+                    this.removePed(ped);
+                });
+                this._vehicles = [];
+                this._peds = [];
+            }
+        });
+    }
+    onRefreshPlayersInVirtualWorld() {
+        const activePlayers = Cfx.Client.GetActivePlayers();
+        activePlayers.forEach((activePlayer) => {
+            const playerServerId = Cfx.Client.GetPlayerServerId(activePlayer);
+            if (this.getPlayerInfo('virtualWorld') === this.getPlayerInfo('virtualWorld', playerServerId)) {
+                Cfx.Client.NetworkConcealPlayer(activePlayer, false, false);
+            }
+            else {
+                Cfx.Client.NetworkConcealPlayer(activePlayer, true, false);
+            }
+        });
+    }
+};
+exports.ClientEntities = ClientEntities;
+__decorate([
+    (0, fivem_framework_common_1.EventListener)({ eventName: `${Cfx.Client.GetCurrentResourceName()}:refresh-virtual-world` }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], ClientEntities.prototype, "onRefreshPlayersInVirtualWorld", null);
+exports.ClientEntities = ClientEntities = __decorate([
+    (0, fivem_framework_common_1.Controller)(),
+    __metadata("design:paramtypes", [])
+], ClientEntities);

package/dist/cjs/client/client-hud.controller.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientHudController = void 0;
+// TODO: Remove
+const client_action_points_1 = require("./client-action-points");
+class ClientHudController extends client_action_points_1.ClientActionPoints {
+    addToFeed(feedItemLength = 8000, ...texts) {
+        texts.forEach((text, index) => {
+            setTimeout(() => {
+                Cfx.Client.BeginTextCommandThefeedPost('STRING');
+                Cfx.Client.AddTextComponentSubstringPlayerName(text);
+                Cfx.Client.EndTextCommandThefeedPostTicker(false, true);
+            }, index * feedItemLength);
+        });
+    }
+}
+exports.ClientHudController = ClientHudController;

package/dist/cjs/client/client-ui.controller.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientWithUIController = void 0;
+// TODO: Remove
+const events_1 = __importDefault(require("events"));
+const client_controller_1 = require("./client.controller");
+class ClientWithUIController extends client_controller_1.ClientController {
+    constructor() {
+        super();
+        this.uiDisplay = false;
+        this.uiDisplayCooldownTimestamp = 0;
+        this.onIncomingUIMessageEvent = new events_1.default();
+        this.addDefaultListeners();
+    }
+    isUIShowing() {
+        return this.uiDisplay;
+    }
+    isUIOnCooldown() {
+        return Date.now() < this.uiDisplayCooldownTimestamp;
+    }
+    showUI(ignoreCursorMode = false, ignoreFocus = false) {
+        if (!this.isUIShowing()) {
+            if (!ignoreCursorMode) {
+                Cfx.Client.EnterCursorMode();
+            }
+            if (!ignoreFocus) {
+                Cfx.Client.SetNuiFocus(true, true);
+                Cfx.Client.SetNuiFocusKeepInput(false);
+            }
+        }
+        this.uiDisplay = true;
+        this.addToTickUnique({
+            id: `${Cfx.Client.GetCurrentResourceName()}_UI`,
+            function: () => {
+                Cfx.Client.DisableControlAction(0, 1, this.uiDisplay);
+                Cfx.Client.DisableControlAction(0, 2, this.uiDisplay);
+                Cfx.Client.DisableControlAction(0, 142, this.uiDisplay);
+                Cfx.Client.DisableControlAction(0, 18, this.uiDisplay);
+                Cfx.Client.DisableControlAction(0, 322, this.uiDisplay);
+                Cfx.Client.DisableControlAction(0, 106, this.uiDisplay);
+                if (!this.uiDisplay) {
+                    this.removeFromTick(`${Cfx.Client.GetCurrentResourceName()}_UI`);
+                    Cfx.Client.SetNuiFocus(false, false);
+                }
+            }
+        });
+    }
+    hideUI() {
+        this.uiDisplayCooldownTimestamp = Date.now() + (1000 * 3);
+        Cfx.Client.LeaveCursorMode();
+        this.uiDisplay = false;
+        Cfx.Client.SendNuiMessage(JSON.stringify({
+            type: 'dismiss'
+        }));
+    }
+    addUIListener(name) {
+        Cfx.Client.RegisterNuiCallbackType(name);
+        Cfx.Client.on(`__cfx_nui:${name}`, (data, callback) => {
+            this.onIncomingUIMessageEvent.emit(name, data);
+            callback('ok');
+        });
+        this.onIncomingUIMessageEvent.on(name, (eventData) => { this.onIncomingUIMessage.call(this, name, eventData); });
+    }
+    /** Remember that you NEED to use addUIListener in order to be able to listen for events */
+    onIncomingUIMessage(eventName, eventData) { }
+    onForceShowUI(data, ignoreCursorMode = false, ignoreFocus = false) {
+        this.showUI(ignoreCursorMode, ignoreFocus);
+    }
+    onForceHideUI() {
+        this.hideUI();
+    }
+    addDefaultListeners() {
+        Cfx.Client.RegisterNuiCallbackType('dismiss');
+        Cfx.Client.on(`__cfx_nui:dismiss`, (data, callback) => {
+            this.onForceHideUI();
+            Cfx.Client.TriggerServerEvent(`${Cfx.Client.GetCurrentResourceName()}:on-force-hidden`);
+            Cfx.Client.emit(`${Cfx.Client.GetCurrentResourceName()}:on-force-hidden`);
+            callback('ok');
+        });
+        Cfx.Client.onNet(`${Cfx.Client.GetCurrentResourceName()}:force-showui`, (data) => {
+            this.onForceShowUI(data);
+        });
+        Cfx.Client.onNet(`${Cfx.Client.GetCurrentResourceName()}:force-hideui`, () => {
+            this.onForceHideUI();
+        });
+    }
+}
+exports.ClientWithUIController = ClientWithUIController;

package/dist/cjs/client/client.base.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientBase = void 0;
+// TODO: Remove
+const fivem_framework_common_1 = require("@armoury/fivem-framework-common");
+class ClientBase {
+    constructor() {
+        this.tickInstance = null;
+        this.tickFunctions = [];
+        this.routingBucket = 0;
+        this.assignBaseListeners();
+    }
+    /** ATTENTION! The ID of a tick function needs to be UNIQUE! */
+    addToTick(...functions) {
+        functions.forEach((func) => {
+            if (this.tickFunctions.findIndex((_func) => _func.id === func.id) !== -1) {
+                console.error(`[ClientBase]: A tick function with the id ${func.id} already exists in the stack! The newly added tick function will not be executed.`);
+            }
+        });
+        this.tickFunctions.push(...functions);
+        this.removeTickDuplicates();
+        this.refreshTicks();
+    }
+    addToTickUnique(...functions) {
+        functions.forEach((func) => {
+            this.removeFromTick(func.id);
+        });
+        this.addToTick(...functions);
+    }
+    /** Removes tick function with the provided id. */
+    removeFromTick(id) {
+        this.tickFunctions = this.tickFunctions.filter((func) => func.id != id);
+    }
+    refreshTicks() {
+        if (this.tickInstance) {
+            Cfx.Client.clearTick(this.tickInstance);
+            this.tickInstance = null;
+        }
+        if (this.tickFunctions.length > 0) {
+            this.tickInstance = Cfx.Client.setTick(() => {
+                if (!this.tickFunctions.length) {
+                    Cfx.Client.clearTick(this.tickInstance);
+                    this.tickInstance = null;
+                    return;
+                }
+                this.tickFunctions.forEach((tick) => {
+                    tick.function();
+                });
+            });
+        }
+    }
+    removeTickDuplicates() {
+        this.tickFunctions = this.tickFunctions.filter((func) => this.tickFunctions.findIndex((_func) => _func.id == func.id) == this.tickFunctions.indexOf(func));
+    }
+    assignBaseListeners() {
+        Cfx.Client.onNet(`${Cfx.Client.GetCurrentResourceName()}:set-routing-bucket`, (routingBucket) => {
+            this.routingBucket = routingBucket;
+        });
+    }
+    setEntityRoutingBucket(routingBucket) {
+        Cfx.Client.TriggerServerEvent(`${Cfx.Client.GetCurrentResourceName()}:set-client-routing-bucket`, routingBucket);
+        this.routingBucket = routingBucket;
+    }
+    getPlayerInfo(stat, playerId) {
+        let value = Cfx.Client.GetConvar(`${playerId || Cfx.Client.GetPlayerServerId(Cfx.Client.PlayerId())}_PI_${stat}`, '-1');
+        if ((0, fivem_framework_common_1.isJSON)(value.toString())) {
+            value = JSON.parse(value.toString(), function (_k, v) { return (typeof v === "object" || isNaN(v)) ? v : Number(v); });
+        }
+        return value;
+    }
+}
+exports.ClientBase = ClientBase;

package/dist/cjs/client/client.controller.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientController = void 0;
+// TODO: Remove
+const client_hud_controller_1 = require("./client-hud.controller");
+class ClientController extends client_hud_controller_1.ClientHudController {
+    constructor() {
+        super(...arguments);
+        this._translationLanguage = 'en';
+    }
+    get translationLanguage() {
+        return this._translationLanguage;
+    }
+    translate(key, params) {
+        // @ts-ignore
+        let content = this.translationFile[this._translationLanguage][key];
+        if (params) {
+            Object.keys(params).forEach((param) => {
+                content = content.replace(`{${param}}`, params[param]);
+            });
+        }
+        return content;
+    }
+    setTranslationLanguage(language) {
+        this._translationLanguage = language;
+    }
+}
+exports.ClientController = ClientController;