@armoury/fivem-framework-common 1.0.62 → 1.0.66

package/dist/cjs/decorators/decorator.utils.js

@@ -6,6 +6,7 @@ const command_decorator_1 = require("./command.decorator");
 const event_listener_decorator_1 = require("./event-listener.decorator");
 const export_decorator_1 = require("./export.decorator");
 const key_binding_decorator_1 = require("./key-binding.decorator");
+const interaction_decorator_1 = require("./interaction.decorator");
 const ui_listener_decorator_1 = require("./ui-listener.decorator");
 const decoratedTargets = new WeakSet();
 class DecoratorUtils {
@@ -41,6 +42,7 @@ function Decorate(instance, _prototype, providers, decorationType = DecorationTy
     (0, export_decorator_1.Exports)(instance, _prototype, relevantProvidersForClass);
     (0, key_binding_decorator_1.KeyBindings)(instance, _prototype, relevantProvidersForClass);
     if (decorationType === DecorationType.CLIENT) {
+        (0, interaction_decorator_1.Interactions)(instance, _prototype, relevantProvidersForClass);
         (0, ui_listener_decorator_1.UIListeners)(instance, _prototype, relevantProvidersForClass);
     }
 }

package/dist/cjs/decorators/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UIListener = exports.KeyBinding = exports.Export = exports.EVENT_DIRECTIONS = exports.EventListener = exports.Controller = exports.Command = void 0;
+exports.UIListener = exports.Interaction = exports.KeyBinding = exports.Export = exports.EVENT_DIRECTIONS = exports.EventListener = exports.Controller = exports.Command = void 0;
 var command_decorator_1 = require("./command.decorator");
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_decorator_1.Command; } });
 var controller_decorator_1 = require("./controller.decorator");
@@ -12,5 +12,7 @@ var export_decorator_1 = require("./export.decorator");
 Object.defineProperty(exports, "Export", { enumerable: true, get: function () { return export_decorator_1.Export; } });
 var key_binding_decorator_1 = require("./key-binding.decorator");
 Object.defineProperty(exports, "KeyBinding", { enumerable: true, get: function () { return key_binding_decorator_1.KeyBinding; } });
+var interaction_decorator_1 = require("./interaction.decorator");
+Object.defineProperty(exports, "Interaction", { enumerable: true, get: function () { return interaction_decorator_1.Interaction; } });
 var ui_listener_decorator_1 = require("./ui-listener.decorator");
 Object.defineProperty(exports, "UIListener", { enumerable: true, get: function () { return ui_listener_decorator_1.UIListener; } });

package/dist/cjs/decorators/interaction.decorator.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Interaction = Interaction;
+exports.Interactions = Interactions;
+const decorator_utils_1 = require("./decorator.utils");
+const ui_listener_decorator_1 = require("./ui-listener.decorator");
+function Interaction(data) {
+    return function (target, propertyKey, descriptor) {
+        Reflect.defineMetadata(`arm_interaction_${data.interactableType}_${Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)}`, data, target);
+        (0, ui_listener_decorator_1.UIListener)({ eventName: `getAvailableInteractions:${data.interactableType}` })(target, propertyKey, descriptor);
+    };
+}
+function Interactions(target, _prototype, providers) {
+    const mappings = decorator_utils_1.DecoratorUtils.map(target, _prototype, providers ?? []);
+    const isServer = Cfx.Client.IsDuplicityVersion();
+    if (isServer) {
+        return;
+    }
+    for (const mapping of mappings) {
+        if (!mapping.key.startsWith('arm_interaction_')) {
+            continue;
+        }
+        Cfx.exports['armoury'].sendUIMessage({
+            type: 'game:interactable:prompt:register',
+            interactableType: mapping.value?.interactableType,
+            resource: Cfx.Client.GetCurrentResourceName(),
+        });
+    }
+}

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

@@ -20,6 +20,8 @@ __exportStar(require("./stub"), exports);
 __exportStar(require("./session"), exports);
 __exportStar(require("./session-update-type"), exports);
 __exportStar(require("./session-claim"), exports);
+/** Interactable */
+__exportStar(require("./interactable"), exports);
 /** Zones */
 __exportStar(require("./zone"), exports);
 /** Pickups */

package/dist/cjs/shared/models/interactable.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INTERACTABLE_TYPE_VEHICLE = exports.INTERACTABLE_TYPE_PLAYER_PED = exports.INTERACTABLE_TYPE_NPC_PED = void 0;
+exports.INTERACTABLE_TYPE_NPC_PED = 0;
+exports.INTERACTABLE_TYPE_PLAYER_PED = 1;
+exports.INTERACTABLE_TYPE_VEHICLE = 2;

package/dist/esm/decorators/decorator.utils.js

@@ -1,8 +1,9 @@
-import { Commands } from "./command.decorator";
-import { EventListeners } from "./event-listener.decorator";
-import { Exports } from "./export.decorator";
-import { KeyBindings } from "./key-binding.decorator";
-import { UIListeners } from "./ui-listener.decorator";
+import { Commands } from './command.decorator';
+import { EventListeners } from './event-listener.decorator';
+import { Exports } from './export.decorator';
+import { KeyBindings } from './key-binding.decorator';
+import { Interactions } from './interaction.decorator';
+import { UIListeners } from './ui-listener.decorator';
 const decoratedTargets = new WeakSet();
 export class DecoratorUtils {
     static map(target, _prototype, providers) {
@@ -36,6 +37,7 @@ export function Decorate(instance, _prototype, providers, decorationType = Decor
     Exports(instance, _prototype, relevantProvidersForClass);
     KeyBindings(instance, _prototype, relevantProvidersForClass);
     if (decorationType === DecorationType.CLIENT) {
+        Interactions(instance, _prototype, relevantProvidersForClass);
         UIListeners(instance, _prototype, relevantProvidersForClass);
     }
 }

package/dist/esm/decorators/index.js

@@ -3,4 +3,5 @@ export { Controller } from './controller.decorator';
 export { EventListener, EVENT_DIRECTIONS } from './event-listener.decorator';
 export { Export } from './export.decorator';
 export { KeyBinding } from './key-binding.decorator';
+export { Interaction } from './interaction.decorator';
 export { UIListener } from './ui-listener.decorator';

package/dist/esm/decorators/interaction.decorator.js

@@ -0,0 +1,25 @@
+import { DecoratorUtils } from './decorator.utils';
+import { UIListener } from './ui-listener.decorator';
+export function Interaction(data) {
+    return function (target, propertyKey, descriptor) {
+        Reflect.defineMetadata(`arm_interaction_${data.interactableType}_${Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)}`, data, target);
+        UIListener({ eventName: `getAvailableInteractions:${data.interactableType}` })(target, propertyKey, descriptor);
+    };
+}
+export function Interactions(target, _prototype, providers) {
+    const mappings = DecoratorUtils.map(target, _prototype, providers ?? []);
+    const isServer = Cfx.Client.IsDuplicityVersion();
+    if (isServer) {
+        return;
+    }
+    for (const mapping of mappings) {
+        if (!mapping.key.startsWith('arm_interaction_')) {
+            continue;
+        }
+        Cfx.exports['armoury'].sendUIMessage({
+            type: 'game:interactable:prompt:register',
+            interactableType: mapping.value?.interactableType,
+            resource: Cfx.Client.GetCurrentResourceName(),
+        });
+    }
+}

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

@@ -4,6 +4,8 @@ export * from './stub';
 export * from './session';
 export * from './session-update-type';
 export * from './session-claim';
+/** Interactable */
+export * from './interactable';
 /** Zones */
 export * from './zone';
 /** Pickups */

package/dist/esm/shared/models/interactable.js

@@ -0,0 +1,3 @@
+export const INTERACTABLE_TYPE_NPC_PED = 0;
+export const INTERACTABLE_TYPE_PLAYER_PED = 1;
+export const INTERACTABLE_TYPE_VEHICLE = 2;

package/dist/types/decorators/decorator.utils.d.ts

@@ -1,4 +1,4 @@
-import { Provider } from "injection-js";
+import { Provider } from 'injection-js';
 export declare class DecoratorUtils {
     static map(target: any, _prototype: any, providers: Object[]): {
         key: any;

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

@@ -3,4 +3,5 @@ export { Controller } from './controller.decorator';
 export { EventListener, EVENT_DIRECTIONS } from './event-listener.decorator';
 export { Export } from './export.decorator';
 export { KeyBinding } from './key-binding.decorator';
+export { Interaction } from './interaction.decorator';
 export { UIListener } from './ui-listener.decorator';

package/dist/types/decorators/interaction.decorator.d.ts

@@ -0,0 +1,4 @@
+export declare function Interaction(data: {
+    interactableType: number;
+}): <T extends (...args: any[]) => any>(target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<T> & (Parameters<T> extends [object, ...unknown[]] ? unknown : never)) => void;
+export declare function Interactions(target: any, _prototype: any, providers?: Object[]): void;

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

@@ -4,6 +4,8 @@ export * from './stub';
 export * from './session';
 export * from './session-update-type';
 export * from './session-claim';
+/** Interactable */
+export * from './interactable';
 /** Zones */
 export * from './zone';
 /** Pickups */

package/dist/types/shared/models/interactable.d.ts

@@ -0,0 +1,3 @@
+export declare const INTERACTABLE_TYPE_NPC_PED = 0;
+export declare const INTERACTABLE_TYPE_PLAYER_PED = 1;
+export declare const INTERACTABLE_TYPE_VEHICLE = 2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armoury/fivem-framework-common",
-  "version": "1.0.62",
+  "version": "1.0.66",
   "description": "Shared APIs for the Armoury FiveM framework",
   "main": "dist/cjs/common/index.js",
   "module": "dist/esm/common/index.js",