@armoury/fivem-roleplay-gamemode-common 1.0.46 → 1.0.49

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

@@ -0,0 +1 @@
+export {};

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

@@ -8,7 +8,7 @@ export interface House {
     readonly sellingPrice: number;
     readonly rentPrice: number;
     readonly requiredLevel: number;
-    readonly metadata?: HouseMetadata;
+    metadata?: HouseMetadata;
 }
 export declare class House {
     readonly id: number;
@@ -20,7 +20,7 @@ export declare class House {
     readonly sellingPrice: number;
     readonly rentPrice: number;
     readonly requiredLevel: number;
-    readonly metadata?: HouseMetadata;
+    metadata?: HouseMetadata;
     constructor(id: number, owner: number | null, entrance: Position, exit: Position, originalValue: number, address: string, sellingPrice?: number, rentPrice?: number, requiredLevel?: number, metadata?: HouseMetadata);
     static toStub(house: House): Stub<House>;
 }

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

@@ -4,9 +4,11 @@ export * from './account';
 export * from './character';
 /** Persistable */
 export * from './persistable/persistable';
+/** Stash */
+export * from './stash/stash';
+/** Item */
+export * from './items/item';
 /** House */
 export * from './house/house';
-/** Item (Deprecated) */
-export * from './items';
 /** Business (Deprecated) */
 export * from './businesses';

package/dist/types/shared/models/items/deprecated/clothing/clothing-item.d.ts

@@ -0,0 +1,25 @@
+import { IItem, IItemBase, Item } from "../item.model";
+export declare abstract class Clothing extends Item<IClothingItem> implements IItem<IClothingItem> {
+    amount: number;
+    get weight(): number;
+    constructor(_name: string, _value?: IClothingItem);
+    add(_amount: number): Clothing;
+    consume(_amount: number): Clothing;
+    empty(): Clothing;
+    serialize(): {
+        [key: string]: IClothingItem;
+    };
+    deserialize(serialized: {
+        [key: string]: IClothingItem;
+    }): Clothing;
+}
+export interface IClothingItem extends IItemBase {
+    components: {
+        [key: number]: IClothingComponent;
+    };
+}
+export interface IClothingComponent {
+    drawableId: number;
+    textureId: number;
+    paletteId: number;
+}

package/dist/types/shared/models/items/deprecated/clothing/index.d.ts

@@ -0,0 +1 @@
+export * from './clothing-item';

package/dist/types/shared/models/items/deprecated/errors/index.d.ts

@@ -0,0 +1 @@
+export * from './item-errors';

package/dist/types/shared/models/items/deprecated/errors/item-error-base.d.ts

@@ -0,0 +1,3 @@
+export declare class ItemError<T extends ItemError<T>> extends Error {
+    constructor(msg: string);
+}

package/dist/types/shared/models/items/deprecated/errors/item-errors.d.ts

@@ -0,0 +1,7 @@
+import { ItemStashError } from "./item-stash-error-base";
+export declare class ItemStashSlotsInsuficientError extends ItemStashError<ItemStashSlotsInsuficientError> {
+    constructor(msg?: string);
+}
+export declare class ItemStashGenericError extends ItemStashError<ItemStashGenericError> {
+    constructor(msg?: string);
+}

package/dist/types/shared/models/items/deprecated/errors/item-stash-error-base.d.ts

@@ -0,0 +1,3 @@
+export declare class ItemStashError<T extends ItemStashError<T>> extends Error {
+    constructor(msg: string);
+}

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

@@ -0,0 +1,8 @@
+export * from './item-stash.model';
+export * from './item.model';
+export * from './item-transfer.model';
+export * from './items-base';
+export * from './stashes-base';
+export * from './errors';
+export * from './clothing';
+export * from './weapons';

package/dist/types/shared/models/items/deprecated/item-stash.model.d.ts

@@ -0,0 +1,53 @@
+import { IItemBase } from "./item.model";
+export declare class ItemStash<T extends IItemBase> {
+    readonly name: string;
+    readonly slots: number;
+    readonly weightPerSlot: number;
+    _items: Map<number, T>;
+    get items(): ReadonlyArray<T>;
+    constructor(name: string, slots: number, weightPerSlot: number);
+    add(item: T, slot?: number): boolean;
+    consume(item: T, amount: number): void;
+    has(itemIdentifier: string): boolean;
+    serialize(): {
+        [key: string]: any;
+    };
+    toUI(): {
+        title: string;
+        items: import("./item.model").IItemUIMapping[];
+    };
+    /**
+     * Adds an item to a stash.
+     * @param stash Stash to add the item to
+     * @param item Item to add to the stash
+     * @param slot The slot where the item should be placed into
+     * @returns Weight added to the stash
+     */
+    static addToSlot<T extends IItemBase>(stash: ItemStash<T>, item: T, slot: number): number;
+    /**
+     * Removes an X amount of whichever item lies in the specified slot
+     * @param stash Stash to remove the amount of the item from
+     * @param slot Slot of the stash which will have this amount of the item removed
+     * @param amount The amount of the item to be removed
+     * @returns The amount that has been removed (the amount in the slot can be lower than the provided amount-to-be-removed)
+     */
+    static removeFromSlot<T extends IItemBase>(stash: ItemStash<T>, slot: number, amount: number): number;
+    static clone<T extends IItemBase>(stash: ItemStash<T>): ItemStash<T>;
+}
+export interface IItemStashBase {
+    name: string;
+    slots: number;
+    weightPerSlot: number;
+    has(itemIdentifier: string): boolean;
+    serialize(): {
+        [key: string]: any;
+    };
+    deserialize(serialized: {
+        [key: string]: any;
+    }): void;
+}
+export interface IItemStash<T extends IItemBase> extends IItemStashBase {
+    items: ReadonlyArray<T>;
+    add(item: T, slot?: number): boolean;
+    consume(item: T, amount: number): boolean;
+}

package/dist/types/shared/models/items/deprecated/item-transfer.model.d.ts

@@ -0,0 +1,5 @@
+import { IItemStashBase } from "./item-stash.model";
+export interface IItemTransfer {
+    from: IItemStashBase;
+    to: IItemStashBase;
+}

package/dist/types/shared/models/items/deprecated/item.model.d.ts

@@ -0,0 +1,50 @@
+export declare abstract class Item<T> {
+    identifier: string;
+    weightPerUnit: number;
+    fullyOccupiesSlot: boolean;
+    value: T;
+    constructor(identifier: string, weightPerUnit: number, fullyOccupiesSlot: boolean, value: T);
+    toUI(slot?: number): IItemUIMapping;
+}
+export interface IItem<T> extends IItemBase {
+    value: T;
+    add(amount: number): IItem<T>;
+    consume(amount: number): IItem<T>;
+    empty(): IItem<T>;
+    serialize(): {
+        [key: string]: T;
+    };
+    deserialize(serialized: {
+        [key: string]: T;
+    }): IItem<T>;
+}
+export interface IItemBase {
+    identifier: string;
+    amount: number;
+    weight: number;
+    weightPerUnit: number;
+    fullyOccupiesSlot: boolean;
+    add(amount: number): IItemBase;
+    consume(amount: number): IItemBase;
+    empty(): IItemBase;
+    serialize(): {
+        [key: string]: any;
+    };
+    deserialize(serialized: {
+        [key: string]: any;
+    }): IItemBase;
+    toUI(currentSlot?: number): IItemUIMapping;
+}
+export interface IItemUIMapping {
+    image: string;
+    bottomRight: string;
+    type: string;
+    description: string;
+    topLeft: string;
+    _piKey: string;
+    outline: string;
+    width: number;
+    metadata?: {
+        [key: string]: any;
+    };
+}

package/dist/types/shared/models/items/deprecated/items-base/index.d.ts

@@ -0,0 +1 @@
+export * from './number-item';

package/dist/types/shared/models/items/deprecated/items-base/number-item.d.ts

@@ -0,0 +1,14 @@
+import { IItem, Item } from "../item.model";
+export declare abstract class NumberItem extends Item<number> implements IItem<number> {
+    get amount(): number;
+    get weight(): number;
+    add(amount: number): NumberItem;
+    consume(amount: number): NumberItem;
+    empty(): NumberItem;
+    serialize(): {
+        [key: string]: number;
+    };
+    deserialize(serialized: {
+        [key: string]: number;
+    }): NumberItem;
+}

package/dist/types/shared/models/items/deprecated/stashes-base/generic-stash.d.ts

@@ -0,0 +1,7 @@
+import { ItemStash } from "../item-stash.model";
+import { IItemBase } from "../item.model";
+export declare class GenericStash extends ItemStash<IItemBase> {
+    deserialize(serialized: {
+        [key: string]: any;
+    }): void;
+}

package/dist/types/shared/models/items/deprecated/stashes-base/index.d.ts

@@ -0,0 +1,2 @@
+export * from './generic-stash';
+export * from './infinite-stash';

package/dist/types/shared/models/items/deprecated/stashes-base/infinite-stash.d.ts

@@ -0,0 +1,10 @@
+import { ItemStash } from "../item-stash.model";
+import { IItemBase } from "../item.model";
+export declare class InfiniteStash extends ItemStash<IItemBase> {
+    add(_item: IItemBase, slot?: number): boolean;
+    consume(_item: IItemBase, _amount: number): void;
+    has(_itemIdentifier: string): boolean;
+    deserialize(serialized: {
+        [key: string]: any;
+    }): void;
+}

package/dist/types/shared/models/items/deprecated/weapons/index.d.ts

@@ -0,0 +1 @@
+export * from './weapon-item';

package/dist/types/shared/models/items/deprecated/weapons/weapon-item.d.ts

@@ -0,0 +1,18 @@
+import { IItem, IItemBase, Item } from "../item.model";
+export declare abstract class WeaponItem extends Item<IWeaponItem> implements IItem<IWeaponItem> {
+    get amount(): number;
+    get weight(): number;
+    add(amount: number): WeaponItem;
+    consume(amount: number): WeaponItem;
+    empty(): WeaponItem;
+    serialize(): {
+        [key: string]: IWeaponItem;
+    };
+    deserialize(serialized: {
+        [key: string]: IWeaponItem;
+    }): WeaponItem;
+}
+export interface IWeaponItem extends IItemBase {
+    ammo: number;
+    id: string;
+}

package/dist/types/shared/models/items/item.d.ts

@@ -0,0 +1,2 @@
+export interface Item {
+}

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

@@ -0,0 +1,13 @@
+export interface Stash {
+    readonly id: number;
+    readonly owningPersistableId: number | null;
+    readonly maxSlots: number;
+    readonly maxWeight: number;
+    slots?: Array<StashSlot>;
+}
+export interface StashSlot {
+    itemIdentifier: string;
+    amount: number;
+    slotIndex: number;
+    readonly stashId: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@armoury/fivem-roleplay-gamemode-common",
-  "version": "1.0.46",
+  "version": "1.0.49",
   "description": "Shared APIs for the Armoury FiveM roleplay gamemode",
   "main": "dist/cjs/shared/index.js",
   "module": "dist/esm/shared/index.js",
@@ -14,7 +14,7 @@
   },
   "files": ["dist"],
   "peerDependencies": {
-    "@armoury/fivem-framework-common": "^1.0.46"
+    "@armoury/fivem-framework-common": "^1.0.49"
   },
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:types",