@armoury/fivem-roleplay-gamemode-common 1.0.71 → 1.0.73

package/dist/cjs/shared/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./models"), exports);
+__exportStar(require("./services"), exports);
 __exportStar(require("./stub"), exports);

package/dist/cjs/shared/services/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** Vehicle */
+__exportStar(require("./vehicles/vehicle.service"), exports);

package/dist/cjs/shared/services/vehicles/vehicle.service.js

@@ -0,0 +1,144 @@
+"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.Vehicles = void 0;
+const injection_js_1 = require("injection-js");
+// TODO: "Attached stashes" functionality should be available for any type of entity, not only vehicles
+let Vehicles = class Vehicles {
+    constructor() {
+        // TODO: Move this to armoury framework
+        if (!IsDuplicityVersion()) {
+            AddStateBagChangeHandler(IDENTIFIER_VEHICLE_TRUNK_OPEN, null, (bagName, key, value, reserved, replicated) => {
+                const vehicle = GetEntityFromStateBagName(bagName);
+                if (!vehicle || !DoesEntityExist(vehicle)) {
+                    return;
+                }
+                if (GetEntityType(vehicle) !== 2) {
+                    return;
+                }
+                if (value === 1) {
+                    console.log('REMOVEME! Trunk is now open.');
+                    SetVehicleDoorOpen(vehicle, 5, false, false);
+                }
+                else if (value === 0) {
+                    console.log('REMOVEME! Trunk is now shut.');
+                    SetVehicleDoorShut(vehicle, 5, false);
+                }
+            });
+        }
+    }
+    static setTrunkOpen(entityId, open) {
+        if (!IsDuplicityVersion()) {
+            throw new Error('Can\'t do this inside a client script.');
+        }
+        if (!Number.isSafeInteger(entityId)) {
+            return;
+        }
+        const state = Entity(entityId).state;
+        if (!state) {
+            throw new Error('Invalid entity.');
+        }
+        state.set(IDENTIFIER_VEHICLE_TRUNK_OPEN, +open, true);
+    }
+    static getOwningPersistableId(entityId) {
+        if (!Number.isSafeInteger(entityId)) {
+            return null;
+        }
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        const owningPersistableId = Entity(entityId).state[IDENTIFIER_PERSISTABLE_OWNINGID];
+        if (owningPersistableId == null || !Number.isSafeInteger(owningPersistableId)) {
+            return null;
+        }
+        return Number(owningPersistableId);
+    }
+    static setOwningPersistableId(entityId, owningPersistableId) {
+        if (!IsDuplicityVersion()) {
+            throw new Error('Can\'t do this inside a client script.');
+        }
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        Entity(entityId).state.set(IDENTIFIER_PERSISTABLE_OWNINGID, owningPersistableId, true);
+    }
+    static attachStash(entityId, stashId, type) {
+        if (!IsDuplicityVersion()) {
+            throw new Error('Can\'t do this inside a client script.');
+        }
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        let count = Entity(entityId).state[IDENTIFIER_ATTACHED_STASHES_COUNT];
+        if (count != null && !Number.isSafeInteger(count)) {
+            throw new Error('Corrupted attached stash count data.');
+        }
+        count ?? (count = 0);
+        const data = this.getStashData(entityId, count);
+        if (data) {
+            throw new Error('Attempted to attach stash data to existing state.');
+        }
+        Entity(entityId).state.set(IDENTIFIER_ATTACHED_STASH_BYINDEX(count), stashId, true);
+        Entity(entityId).state.set(IDENTIFIER_ATTACHED_STASH_TYPE(count), type, true);
+        Entity(entityId).state.set(IDENTIFIER_ATTACHED_STASHES_COUNT, count + 1, true);
+        return true;
+    }
+    static getAttachedStashIdsByType(entityId, type) {
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        const count = Entity(entityId).state[IDENTIFIER_ATTACHED_STASHES_COUNT] ?? 0;
+        if (!count) {
+            return null;
+        }
+        const stashIds = [];
+        for (let i = 0; i < count; i++) {
+            const data = this.getStashData(entityId, i);
+            if (!data) {
+                continue;
+            }
+            if (data.type == type) {
+                stashIds.push(Number(data.stashId));
+            }
+        }
+        return stashIds;
+    }
+    static getStashData(entityId, index) {
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        const stashId = Entity(entityId).state[IDENTIFIER_ATTACHED_STASH_BYINDEX(index)];
+        if (stashId == null || !Number.isSafeInteger(stashId)) {
+            return null;
+        }
+        const type = Entity(entityId).state[IDENTIFIER_ATTACHED_STASH_TYPE(index)];
+        if (type == null) {
+            return null;
+        }
+        return { stashId: Number(stashId), type };
+    }
+};
+exports.Vehicles = Vehicles;
+exports.Vehicles = Vehicles = __decorate([
+    (0, injection_js_1.Injectable)(),
+    __metadata("design:paramtypes", [])
+], Vehicles);
+/** Entities */
+const PERSISTABLE_PREFIX = 'armoury:entity:owning-persistable';
+const IDENTIFIER_PERSISTABLE_OWNINGID = PERSISTABLE_PREFIX + ':owningId';
+/** Trunk (TODO: Move applicable to main framework)*/
+const VEHICLE_TRUNK_PREFIX = 'armoury:vehicle:trunk';
+const IDENTIFIER_VEHICLE_TRUNK_OPEN = VEHICLE_TRUNK_PREFIX + ':open';
+/** Attached Stashes */
+const ATTACHED_STASHES_PREFIX = 'armoury:entity:attached-stashes';
+const IDENTIFIER_ATTACHED_STASHES_COUNT = ATTACHED_STASHES_PREFIX + ':count';
+const IDENTIFIER_ATTACHED_STASH_BYINDEX = (index) => `${ATTACHED_STASHES_PREFIX}:[${index}]`;
+const IDENTIFIER_ATTACHED_STASH_TYPE = (index) => `${IDENTIFIER_ATTACHED_STASH_BYINDEX(index)}:type`;

package/dist/esm/shared/index.js

@@ -1,2 +1,3 @@
 export * from './models';
+export * from './services';
 export * from './stub';

package/dist/esm/shared/services/index.js

@@ -0,0 +1,2 @@
+/** Vehicle */
+export * from './vehicles/vehicle.service';

package/dist/esm/shared/services/vehicles/vehicle.service.js

@@ -0,0 +1,141 @@
+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);
+};
+import { Injectable } from 'injection-js';
+// TODO: "Attached stashes" functionality should be available for any type of entity, not only vehicles
+let Vehicles = class Vehicles {
+    constructor() {
+        // TODO: Move this to armoury framework
+        if (!IsDuplicityVersion()) {
+            AddStateBagChangeHandler(IDENTIFIER_VEHICLE_TRUNK_OPEN, null, (bagName, key, value, reserved, replicated) => {
+                const vehicle = GetEntityFromStateBagName(bagName);
+                if (!vehicle || !DoesEntityExist(vehicle)) {
+                    return;
+                }
+                if (GetEntityType(vehicle) !== 2) {
+                    return;
+                }
+                if (value === 1) {
+                    console.log('REMOVEME! Trunk is now open.');
+                    SetVehicleDoorOpen(vehicle, 5, false, false);
+                }
+                else if (value === 0) {
+                    console.log('REMOVEME! Trunk is now shut.');
+                    SetVehicleDoorShut(vehicle, 5, false);
+                }
+            });
+        }
+    }
+    static setTrunkOpen(entityId, open) {
+        if (!IsDuplicityVersion()) {
+            throw new Error('Can\'t do this inside a client script.');
+        }
+        if (!Number.isSafeInteger(entityId)) {
+            return;
+        }
+        const state = Entity(entityId).state;
+        if (!state) {
+            throw new Error('Invalid entity.');
+        }
+        state.set(IDENTIFIER_VEHICLE_TRUNK_OPEN, +open, true);
+    }
+    static getOwningPersistableId(entityId) {
+        if (!Number.isSafeInteger(entityId)) {
+            return null;
+        }
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        const owningPersistableId = Entity(entityId).state[IDENTIFIER_PERSISTABLE_OWNINGID];
+        if (owningPersistableId == null || !Number.isSafeInteger(owningPersistableId)) {
+            return null;
+        }
+        return Number(owningPersistableId);
+    }
+    static setOwningPersistableId(entityId, owningPersistableId) {
+        if (!IsDuplicityVersion()) {
+            throw new Error('Can\'t do this inside a client script.');
+        }
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        Entity(entityId).state.set(IDENTIFIER_PERSISTABLE_OWNINGID, owningPersistableId, true);
+    }
+    static attachStash(entityId, stashId, type) {
+        if (!IsDuplicityVersion()) {
+            throw new Error('Can\'t do this inside a client script.');
+        }
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        let count = Entity(entityId).state[IDENTIFIER_ATTACHED_STASHES_COUNT];
+        if (count != null && !Number.isSafeInteger(count)) {
+            throw new Error('Corrupted attached stash count data.');
+        }
+        count ?? (count = 0);
+        const data = this.getStashData(entityId, count);
+        if (data) {
+            throw new Error('Attempted to attach stash data to existing state.');
+        }
+        Entity(entityId).state.set(IDENTIFIER_ATTACHED_STASH_BYINDEX(count), stashId, true);
+        Entity(entityId).state.set(IDENTIFIER_ATTACHED_STASH_TYPE(count), type, true);
+        Entity(entityId).state.set(IDENTIFIER_ATTACHED_STASHES_COUNT, count + 1, true);
+        return true;
+    }
+    static getAttachedStashIdsByType(entityId, type) {
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        const count = Entity(entityId).state[IDENTIFIER_ATTACHED_STASHES_COUNT] ?? 0;
+        if (!count) {
+            return null;
+        }
+        const stashIds = [];
+        for (let i = 0; i < count; i++) {
+            const data = this.getStashData(entityId, i);
+            if (!data) {
+                continue;
+            }
+            if (data.type == type) {
+                stashIds.push(Number(data.stashId));
+            }
+        }
+        return stashIds;
+    }
+    static getStashData(entityId, index) {
+        if (!Entity(entityId).state) {
+            throw new Error('Invalid entity.');
+        }
+        const stashId = Entity(entityId).state[IDENTIFIER_ATTACHED_STASH_BYINDEX(index)];
+        if (stashId == null || !Number.isSafeInteger(stashId)) {
+            return null;
+        }
+        const type = Entity(entityId).state[IDENTIFIER_ATTACHED_STASH_TYPE(index)];
+        if (type == null) {
+            return null;
+        }
+        return { stashId: Number(stashId), type };
+    }
+};
+Vehicles = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [])
+], Vehicles);
+export { Vehicles };
+/** Entities */
+const PERSISTABLE_PREFIX = 'armoury:entity:owning-persistable';
+const IDENTIFIER_PERSISTABLE_OWNINGID = PERSISTABLE_PREFIX + ':owningId';
+/** Trunk (TODO: Move applicable to main framework)*/
+const VEHICLE_TRUNK_PREFIX = 'armoury:vehicle:trunk';
+const IDENTIFIER_VEHICLE_TRUNK_OPEN = VEHICLE_TRUNK_PREFIX + ':open';
+/** Attached Stashes */
+const ATTACHED_STASHES_PREFIX = 'armoury:entity:attached-stashes';
+const IDENTIFIER_ATTACHED_STASHES_COUNT = ATTACHED_STASHES_PREFIX + ':count';
+const IDENTIFIER_ATTACHED_STASH_BYINDEX = (index) => `${ATTACHED_STASHES_PREFIX}:[${index}]`;
+const IDENTIFIER_ATTACHED_STASH_TYPE = (index) => `${IDENTIFIER_ATTACHED_STASH_BYINDEX(index)}:type`;

package/dist/types/shared/index.d.ts

@@ -1,2 +1,3 @@
 export * from './models';
+export * from './services';
 export * from './stub';

package/dist/types/shared/services/index.d.ts

@@ -0,0 +1,2 @@
+/** Vehicle */
+export * from './vehicles/vehicle.service';

package/dist/types/shared/services/vehicles/vehicle.service.d.ts

@@ -0,0 +1,9 @@
+export declare class Vehicles {
+    constructor();
+    static setTrunkOpen(entityId: number, open: boolean): void;
+    static getOwningPersistableId(entityId: number): number | null;
+    static setOwningPersistableId(entityId: number, owningPersistableId: number): void;
+    static attachStash(entityId: number, stashId: number, type: string): boolean;
+    static getAttachedStashIdsByType(entityId: number, type: string): number[] | null;
+    private static getStashData;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armoury/fivem-roleplay-gamemode-common",
-  "version": "1.0.71",
+  "version": "1.0.73",
   "description": "Shared APIs for the Armoury FiveM roleplay gamemode",
   "main": "dist/cjs/shared/index.js",
   "module": "dist/esm/shared/index.js",
@@ -18,8 +18,8 @@
   },
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:types",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "node ../../tools/build.js tsconfig.cjs.json",
+    "build:esm": "node ../../tools/build.js tsconfig.esm.json",
     "build:types": "tsc -p tsconfig.types.json"
   },
   "publishConfig": {