Inventory Item Conversions

CHANGELOG.md

@@ -46,6 +46,10 @@ Overrides -> src/core/client/menus/object
 Overrides -> src/core/client/menus/player
 Overrides -> src/core/client/menus/vehicle
 
+Athena.systems.inventory.convert.toBaseItem
+Athena.systems.inventory.convert.toItem
+Athena.systems.inventory.convert.toStoredItem
+
 --------------------------------------
 --- Everything Below is Before April 2
 --------------------------------------

src/core/server/systems/inventory/convert.ts

@@ -0,0 +1,53 @@
+import * as Athena from '@AthenaServer/api';
+import { BaseItemEx, ItemEx, StoredItemEx } from '@AthenaShared/interfaces/item';
+
+/**
+ * Converts a stored item into a full item.
+ *
+ * Does not perform any inventory changes.
+ *
+ * Returns undefined if base item was not found.
+ *
+ * @export
+ * @template CustomData
+ * @param {StoredItemEx<CustomData>} storedItem
+ */
+export function toItem<CustomData = {}>(storedItem: StoredItemEx<CustomData>): ItemEx<CustomData> | undefined {
+ const results = Athena.systems.inventory.manager.convertFromStored<CustomData>([storedItem]);
+
+ if (results.length <= 0) {
+ return undefined;
+ }
+
+ return results[0];
+}
+
+/**
+ * Convert a stored Item to a base item
+ *
+ * Does not perform any inventory changes.
+ *
+ * @export
+ * @template CustomData
+ * @param {StoredItemEx<CustomData>} storedItem
+ * @return {BaseItemEx<CustomData>}
+ */
+export function toBaseItem<CustomData = {}>(storedItem: StoredItemEx<CustomData>): BaseItemEx<CustomData> {
+ return Athena.systems.inventory.factory.getBaseItem<CustomData>(storedItem.dbName, storedItem.version);
+}
+
+/**
+ * Convert a Base Item to a stored item
+ *
+ * Does not perform any inventory changes.
+ *
+ * @export
+ * @template CustomData
+ * @param {BaseItemEx<CustomData>} baseItem
+ * @param {number} quantity
+ * @return {*}
+ */
+export function toStoredItem<CustomData = {}>(baseItem: BaseItemEx<CustomData>, quantity: number) {
+ return Athena.systems.inventory.factory.fromBaseToStored(baseItem, quantity);
+}
+

src/core/server/systems/inventory/index.ts

@@ -1,5 +1,6 @@
 export * as clothing from './clothing';
 export * as config from './config';
+export * as convert from './convert';
 export * as crafting from './crafting';
 export * as drops from './drops';
 export * as effects from './effects';