Server/project/src/helpers/InventoryHelper.ts
Dev 825db77b1f Move trader purchases over to new system
Fix callback errors not being propigated into client error message
FIx incorrect offer id being passed into `buyItem`
Update callbacks to accept a `buyCount` parameter - solves trader purchase limits being exeeded prematurely
Exit addItemToStash early if warning/error found in output
2024-01-15 14:25:17 +00:00

1530 lines
59 KiB
TypeScript

import { inject, injectable } from "tsyringe";
import { ContainerHelper } from "@spt-aki/helpers/ContainerHelper";
import { DialogueHelper } from "@spt-aki/helpers/DialogueHelper";
import { ItemHelper } from "@spt-aki/helpers/ItemHelper";
import { PaymentHelper } from "@spt-aki/helpers/PaymentHelper";
import { PresetHelper } from "@spt-aki/helpers/PresetHelper";
import { ProfileHelper } from "@spt-aki/helpers/ProfileHelper";
import { TraderAssortHelper } from "@spt-aki/helpers/TraderAssortHelper";
import { IPmcData } from "@spt-aki/models/eft/common/IPmcData";
import { Inventory } from "@spt-aki/models/eft/common/tables/IBotBase";
import { Item, Location, Upd } from "@spt-aki/models/eft/common/tables/IItem";
import { IAddItemDirectRequest } from "@spt-aki/models/eft/inventory/IAddItemDirectRequest";
import { AddItem, IAddItemRequestData } from "@spt-aki/models/eft/inventory/IAddItemRequestData";
import { IAddItemTempObject } from "@spt-aki/models/eft/inventory/IAddItemTempObject";
import { IInventoryMergeRequestData } from "@spt-aki/models/eft/inventory/IInventoryMergeRequestData";
import { IInventoryMoveRequestData } from "@spt-aki/models/eft/inventory/IInventoryMoveRequestData";
import { IInventoryRemoveRequestData } from "@spt-aki/models/eft/inventory/IInventoryRemoveRequestData";
import { IInventorySplitRequestData } from "@spt-aki/models/eft/inventory/IInventorySplitRequestData";
import { IItemEventRouterResponse } from "@spt-aki/models/eft/itemEvent/IItemEventRouterResponse";
import { BaseClasses } from "@spt-aki/models/enums/BaseClasses";
import { ConfigTypes } from "@spt-aki/models/enums/ConfigTypes";
import { Traders } from "@spt-aki/models/enums/Traders";
import { IInventoryConfig, RewardDetails } from "@spt-aki/models/spt/config/IInventoryConfig";
import { ILogger } from "@spt-aki/models/spt/utils/ILogger";
import { ConfigServer } from "@spt-aki/servers/ConfigServer";
import { DatabaseServer } from "@spt-aki/servers/DatabaseServer";
import { FenceService } from "@spt-aki/services/FenceService";
import { LocalisationService } from "@spt-aki/services/LocalisationService";
import { HashUtil } from "@spt-aki/utils/HashUtil";
import { HttpResponseUtil } from "@spt-aki/utils/HttpResponseUtil";
import { JsonUtil } from "@spt-aki/utils/JsonUtil";
export interface OwnerInventoryItems
{
/** Inventory items from source */
from: Item[];
/** Inventory items at destination */
to: Item[];
sameInventory: boolean;
isMail: boolean;
}
@injectable()
export class InventoryHelper
{
protected inventoryConfig: IInventoryConfig;
constructor(
@inject("WinstonLogger") protected logger: ILogger,
@inject("JsonUtil") protected jsonUtil: JsonUtil,
@inject("HashUtil") protected hashUtil: HashUtil,
@inject("HttpResponseUtil") protected httpResponse: HttpResponseUtil,
@inject("FenceService") protected fenceService: FenceService,
@inject("DatabaseServer") protected databaseServer: DatabaseServer,
@inject("PaymentHelper") protected paymentHelper: PaymentHelper,
@inject("TraderAssortHelper") protected traderAssortHelper: TraderAssortHelper,
@inject("DialogueHelper") protected dialogueHelper: DialogueHelper,
@inject("ItemHelper") protected itemHelper: ItemHelper,
@inject("ContainerHelper") protected containerHelper: ContainerHelper,
@inject("ProfileHelper") protected profileHelper: ProfileHelper,
@inject("PresetHelper") protected presetHelper: PresetHelper,
@inject("LocalisationService") protected localisationService: LocalisationService,
@inject("ConfigServer") protected configServer: ConfigServer,
)
{
this.inventoryConfig = this.configServer.getConfig(ConfigTypes.INVENTORY);
}
/**
* Add whatever is passed in `request.itemWithModsToAdd` into player inventory (if it fits)
* @param sessionId Session id
* @param request addItemDirect request
* @param pmcData Player profile
* @param output Client response object
* @returns IItemEventRouterResponse
*/
public addItemToStash(sessionId: string, request: IAddItemDirectRequest, pmcData: IPmcData, output: IItemEventRouterResponse): IItemEventRouterResponse
{
const itemWithModsToAddClone = this.jsonUtil.clone(request.itemWithModsToAdd);
// Get stash layouts ready for use
const stashFS2D = this.getStashSlotMap(pmcData, sessionId);
const sortingTableFS2D = this.getSortingTableSlotMap(pmcData);
// Find empty slot in stash for item being added - adds 'location' + parentid + slotId properties to root item
const errorOutput = this.placeItemInInventory(
stashFS2D,
sortingTableFS2D,
itemWithModsToAddClone,
pmcData.Inventory,
request.useSortingTable,
output,
);
if (errorOutput)
{
// Failed to place, error out
return errorOutput;
}
// Apply/remove FiR to item + mods
this.setFindInRaidStatusForItem(itemWithModsToAddClone, request.foundInRaid);
// Remove trader properties from root item
this.removeTraderRagfairRelatedUpdProperties(itemWithModsToAddClone[0].upd);
// Run callback
try
{
if (typeof request.callback === "function")
{
request.callback(itemWithModsToAddClone[0].upd.StackObjectsCount);
}
}
catch (err)
{
// Callback failed
const message = typeof err?.message === "string"
? err.message
: this.localisationService.getText("http-unknown_error");
return this.httpResponse.appendErrorToOutput(output, message);
}
// Add item + mods to output and profile inventory
output.profileChanges[sessionId].items.new.push(...itemWithModsToAddClone);
pmcData.Inventory.items.push(...itemWithModsToAddClone);
this.logger.debug(`Added ${itemWithModsToAddClone[0].upd?.StackObjectsCount} item: ${itemWithModsToAddClone[0]._tpl} with: ${itemWithModsToAddClone.length - 1} mods to inventory`);
return output;
}
/**
* Set FiR status for an item + its children
* @param itemWithChildren An item
* @param foundInRaid Item was found in raid
*/
private setFindInRaidStatusForItem(itemWithChildren: Item[], foundInRaid: boolean)
{
for (const item of itemWithChildren)
{
// Ensure item has upd object
if (!item.upd)
{
item.upd = {};
}
if (foundInRaid)
{
item.upd.SpawnedInSession = foundInRaid;
}
else
{
if (delete item.upd.SpawnedInSession)
{
delete item.upd.SpawnedInSession;
}
}
}
}
/**
* @deprecated - use addItemToStash()
*
* BUG: Passing the same item multiple times with a count of 1 will cause multiples of that item to be added (e.g. x3 separate objects of tar cola with count of 1 = 9 tarcolas being added to inventory)
* @param pmcData Profile to add items to
* @param request request data to add items
* @param output response to send back to client
* @param sessionID Session id
* @param callback Code to execute later (function)
* @param foundInRaid Item added will be flagged as found in raid
* @param addUpd Additional upd properties for items being added to inventory
* @param useSortingTable Allow items to go into sorting table when stash has no space
* @returns IItemEventRouterResponse
*/
public addItem(
pmcData: IPmcData,
request: IAddItemRequestData,
output: IItemEventRouterResponse,
sessionID: string,
callback: () => void,
foundInRaid = false,
addUpd = null,
useSortingTable = false,
): IItemEventRouterResponse
{
/** All items to add + their children */
const itemsToAddPool: Item[] = [];
/** Root items to add to inventory */
const rootItemsToAdd: IAddItemTempObject[] = [];
for (const requestItem of request.items)
{
if (this.presetHelper.isPreset(requestItem.item_id))
{
const preset = this.jsonUtil.clone(this.presetHelper.getPreset(requestItem.item_id));
const presetItems = preset._items;
// Add FiR status to preset if needed
if (foundInRaid || this.inventoryConfig.newItemsMarkedFound)
{
for (const item of presetItems)
{
if (!item.upd)
{
item.upd = {};
}
if (foundInRaid)
{
item.upd.SpawnedInSession = true;
}
}
}
// Push preset data into pool array
itemsToAddPool.push(...presetItems);
requestItem.sptIsPreset = true;
// Remap requests item id to preset root items id
requestItem.item_id = presetItems[0]._id;
}
else if (this.paymentHelper.isMoneyTpl(requestItem.item_id))
{
itemsToAddPool.push({ _id: requestItem.item_id, _tpl: requestItem.item_id });
}
else if (request.tid === Traders.FENCE)
{
const fenceItems = this.fenceService.getRawFenceAssorts().items;
const itemIndex = fenceItems.findIndex((i) => i._id === requestItem.item_id);
if (itemIndex === -1)
{
this.logger.debug(`Tried to buy item ${requestItem.item_id} from fence that no longer exists`);
const message = this.localisationService.getText("ragfair-offer_no_longer_exists");
return this.httpResponse.appendErrorToOutput(output, message);
}
const purchasedItemWithChildren = this.itemHelper.findAndReturnChildrenAsItems(
fenceItems,
requestItem.item_id,
);
addUpd = purchasedItemWithChildren[0].upd; // Must persist the fence upd properties (e.g. durability/currentHp)
itemsToAddPool.push(...purchasedItemWithChildren);
}
else if (request.tid === "RandomLootContainer")
{
itemsToAddPool.push({ _id: requestItem.item_id, _tpl: requestItem.item_id });
}
else
{
// Only grab the relevant trader items and add unique values
const traderItems = this.traderAssortHelper.getAssort(sessionID, request.tid).items;
const relevantItems = this.itemHelper.findAndReturnChildrenAsItems(traderItems, requestItem.item_id);
const toAdd = relevantItems.filter((traderItem) =>
!itemsToAddPool.some((item) => traderItem._id === item._id)
); // what's this
itemsToAddPool.push(...toAdd);
}
// Split stacks into allowed sizes if needed
// e.g. when buying 300 ammo from flea but max stack size is 50
this.splitStackIntoSmallerStacks(itemsToAddPool, requestItem, rootItemsToAdd);
}
// Find an empty slot in stash for each of the items being added
const stashFS2D = this.getStashSlotMap(pmcData, sessionID);
const sortingTableFS2D = this.getSortingTableSlotMap(pmcData);
for (const itemToAdd of rootItemsToAdd)
{
// Update Items `location` properties
const itemWithChildren = this.itemHelper.findAndReturnChildrenAsItems(itemsToAddPool, itemToAdd.itemRef._id);
const errorOutput = this.placeItemInInventoryLegacy(
itemToAdd,
stashFS2D,
sortingTableFS2D,
itemWithChildren,
pmcData.Inventory,
useSortingTable,
output,
);
if (errorOutput)
{
return errorOutput;
}
}
// Found slot for every item (stash or sorting table), run callback and catch failure (e.g. payMoney() as player doesnt have enough)
try
{
if (typeof callback === "function")
{
callback();
}
}
catch (err)
{
// Callback failed
const message = typeof err === "string" ? err : this.localisationService.getText("http-unknown_error");
return this.httpResponse.appendErrorToOutput(output, message);
}
// Update UPD properties and add to output.profileChanges/pmcData.Inventory.items arrays
for (const rootItemToAdd of rootItemsToAdd)
{
let newIdForItem = this.hashUtil.generate();
const originalKeyToNewKeyMap: string[][] = [[rootItemToAdd.itemRef._id, newIdForItem]]; // Every item id + randomly generated id
let rootItemUpd: Upd = { StackObjectsCount: rootItemToAdd.count };
// If item being added is preset, load preset's upd data too.
if (rootItemToAdd.isPreset)
{
// Iterate over properties in upd and add them
for (const updID in rootItemToAdd.itemRef.upd)
{
rootItemUpd[updID] = rootItemToAdd.itemRef.upd[updID];
}
if (addUpd)
{
// Iterate over properties in addUpd and add them
for (const updID in addUpd)
{
rootItemUpd[updID] = addUpd[updID];
}
}
}
// Item has buff, add to item being sent to player
if (rootItemToAdd.itemRef.upd?.Buff)
{
rootItemUpd.Buff = this.jsonUtil.clone(rootItemToAdd.itemRef.upd.Buff);
}
// Add ragfair upd properties
if (addUpd)
{
rootItemUpd = { ...addUpd, ...rootItemUpd };
}
// Hideout items need to be marked as found in raid
// Or in case people want all items to be marked as found in raid
if (foundInRaid || this.inventoryConfig.newItemsMarkedFound)
{
rootItemUpd.SpawnedInSession = true;
}
// Remove invalid properties prior to adding to inventory
this.removeTraderRagfairRelatedUpdProperties(rootItemUpd);
// Add root item to client return object
output.profileChanges[sessionID].items.new.push({
_id: newIdForItem,
_tpl: rootItemToAdd.itemRef._tpl,
parentId: rootItemToAdd.containerId,
slotId: "hideout",
location: { x: rootItemToAdd.location.x, y: rootItemToAdd.location.y, r: rootItemToAdd.location.rotation ? 1 : 0 },
upd: this.jsonUtil.clone(rootItemUpd),
});
// Add root item to player inventory
pmcData.Inventory.items.push({
_id: newIdForItem,
_tpl: rootItemToAdd.itemRef._tpl,
parentId: rootItemToAdd.containerId,
slotId: "hideout",
location: { x: rootItemToAdd.location.x, y: rootItemToAdd.location.y, r: rootItemToAdd.location.rotation ? 1 : 0 },
upd: this.jsonUtil.clone(rootItemUpd), // Clone upd to prevent multi-purchases of same item referencing same upd object in memory
});
// Edge case - ammo boxes need cartridges added to result
if (this.itemHelper.isOfBaseclass(rootItemToAdd.itemRef._tpl, BaseClasses.AMMO_BOX))
{
this.hydrateAmmoBoxWithAmmo(pmcData, rootItemToAdd, originalKeyToNewKeyMap[0][1], sessionID, output, foundInRaid);
}
// Loop over item + children
while (originalKeyToNewKeyMap.length > 0)
{
// Iterate item + children being added
for (const arrayIndex in itemsToAddPool)
{
const itemDetails = itemsToAddPool[arrayIndex];
// Does parent match original key
if (itemDetails?.parentId !== originalKeyToNewKeyMap[0][0])
{
// Skip when items parent isnt on remap (root item)
continue;
}
// Create new id for child item
newIdForItem = this.hashUtil.generate();
const itemSlotId = itemDetails.slotId;
// If its from ItemPreset, load presets upd data too.
if (rootItemToAdd.isPreset)
{
rootItemUpd = { StackObjectsCount: rootItemToAdd.count };
for (const updID in itemDetails.upd)
{
rootItemUpd[updID] = itemDetails.upd[updID];
}
if (foundInRaid || this.inventoryConfig.newItemsMarkedFound)
{
rootItemUpd.SpawnedInSession = true;
}
}
// Is root item
if (itemSlotId === "hideout")
{
// Add child item to client return object
output.profileChanges[sessionID].items.new.push({
_id: newIdForItem,
_tpl: itemDetails._tpl,
parentId: originalKeyToNewKeyMap[0][1],
slotId: itemSlotId,
location: { x: rootItemToAdd.location.x, y: rootItemToAdd.location.y, r: "Horizontal" },
upd: this.jsonUtil.clone(rootItemUpd),
});
// Add child item to player inventory
pmcData.Inventory.items.push({
_id: newIdForItem,
_tpl: itemDetails._tpl,
parentId: originalKeyToNewKeyMap[0][1],
slotId: itemDetails.slotId,
location: { x: rootItemToAdd.location.x, y: rootItemToAdd.location.y, r: "Horizontal" },
upd: this.jsonUtil.clone(rootItemUpd),
});
}
else
{
// Child of item being added
// Item already has location property, use it
const itemLocation = {};
if (itemDetails.location !== undefined)
{
itemLocation["location"] = itemDetails.location;
}
// Clone upd so we dont adjust the underlying data
const upd = this.jsonUtil.clone(itemDetails.upd);
output.profileChanges[sessionID].items.new.push({
_id: newIdForItem,
_tpl: itemDetails._tpl,
parentId: originalKeyToNewKeyMap[0][1],
slotId: itemSlotId,
...itemLocation,
upd: upd,
});
pmcData.Inventory.items.push({
_id: newIdForItem,
_tpl: itemDetails._tpl,
parentId: originalKeyToNewKeyMap[0][1],
slotId: itemDetails.slotId,
...itemLocation,
upd: upd,
});
this.logger.debug(`Added: ${itemDetails._tpl} with id: ${newIdForItem} to inventory`);
}
// Add mapping of child item to new id
originalKeyToNewKeyMap.push([itemDetails._id, newIdForItem]);
}
// Remove mapping now we're done with it
originalKeyToNewKeyMap.splice(0, 1);
}
}
return output;
}
/**
* Remove properties from a Upd object used by a trader/ragfair
* @param upd Object to update
*/
protected removeTraderRagfairRelatedUpdProperties(upd: Upd): void
{
if (upd.UnlimitedCount !== undefined)
{
delete upd.UnlimitedCount;
}
if (upd.BuyRestrictionCurrent !== undefined)
{
delete upd.BuyRestrictionCurrent;
}
if (upd.BuyRestrictionMax !== undefined)
{
delete upd.BuyRestrictionMax;
}
}
protected placeItemInInventory(
stashFS2D: number[][],
sortingTableFS2D: number[][],
itemWithChildren: Item[],
playerInventory: Inventory,
useSortingTable: boolean,
output: IItemEventRouterResponse): IItemEventRouterResponse
{
// Get x/y size of item
const rootItem = itemWithChildren[0];
const itemSize = this.getItemSize(rootItem._tpl, rootItem._id, itemWithChildren);
// Look for a place to slot item into
const findSlotResult = this.containerHelper.findSlotForItem(stashFS2D, itemSize[0], itemSize[1]);
if (findSlotResult.success)
{
/* Fill in the StashFS_2D with an imaginary item, to simulate it already being added
* so the next item to search for a free slot won't find the same one */
const itemSizeX = findSlotResult.rotation ? itemSize[1] : itemSize[0];
const itemSizeY = findSlotResult.rotation ? itemSize[0] : itemSize[1];
try
{
stashFS2D = this.containerHelper.fillContainerMapWithItem(
stashFS2D,
findSlotResult.x,
findSlotResult.y,
itemSizeX,
itemSizeY,
false,
); // TODO: rotation not passed in, bad?
}
catch (err)
{
const errorText = (typeof err === "string")
? ` -> ${err}`
: "";
this.logger.error(this.localisationService.getText("inventory-fill_container_failed", errorText));
return this.httpResponse.appendErrorToOutput(
output,
this.localisationService.getText("inventory-no_stash_space"),
);
}
// Store details for object, incuding container item will be placed in
rootItem.parentId = playerInventory.stash;
rootItem.slotId = "hideout";
rootItem.location = {
x: findSlotResult.x,
y: findSlotResult.y,
r: findSlotResult.rotation ? 1 : 0,
rotation: findSlotResult.rotation,
};
// Success! exit
return;
}
// Space not found in main stash, use sorting table
if (useSortingTable)
{
const findSortingSlotResult = this.containerHelper.findSlotForItem(
sortingTableFS2D,
itemSize[0],
itemSize[1],
);
const itemSizeX = findSortingSlotResult.rotation ? itemSize[1] : itemSize[0];
const itemSizeY = findSortingSlotResult.rotation ? itemSize[0] : itemSize[1];
try
{
sortingTableFS2D = this.containerHelper.fillContainerMapWithItem(
sortingTableFS2D,
findSortingSlotResult.x,
findSortingSlotResult.y,
itemSizeX,
itemSizeY,
false,
); // TODO: rotation not passed in, bad?
}
catch (err)
{
const errorText = typeof err === "string" ? ` -> ${err}` : "";
this.logger.error(this.localisationService.getText("inventory-fill_container_failed", errorText));
return this.httpResponse.appendErrorToOutput(
output,
this.localisationService.getText("inventory-no_stash_space"),
);
}
// Store details for object, incuding container item will be placed in
itemWithChildren[0].parentId = playerInventory.sortingTable;
itemWithChildren[0].location = {
x: findSortingSlotResult.x,
y: findSortingSlotResult.y,
r: findSortingSlotResult.rotation ? 1 : 0,
rotation: findSortingSlotResult.rotation,
};
}
else
{
return this.httpResponse.appendErrorToOutput(
output,
this.localisationService.getText("inventory-no_stash_space"),
);
}
}
/**
* Take the given item, find a free slot in passed in inventory and place it there
* If no space in inventory, place in sorting table
* @param itemToAdd Item to add to inventory
* @param stashFS2D Two dimentional stash map
* @param sortingTableFS2D Two dimentional sorting table stash map
* @param itemLib
* @param pmcData Player profile
* @param useSortingTable Should sorting table be used for overflow items when no inventory space for item
* @param output Client output object
* @returns Client error output if placing item failed
*/
protected placeItemInInventoryLegacy(
itemToAdd: IAddItemTempObject,
stashFS2D: number[][],
sortingTableFS2D: number[][],
itemLib: Item[],
playerInventory: Inventory,
useSortingTable: boolean,
output: IItemEventRouterResponse,
): IItemEventRouterResponse
{
const itemSize = this.getItemSize(itemToAdd.itemRef._tpl, itemToAdd.itemRef._id, itemLib);
const findSlotResult = this.containerHelper.findSlotForItem(stashFS2D, itemSize[0], itemSize[1]);
if (findSlotResult.success)
{
/* Fill in the StashFS_2D with an imaginary item, to simulate it already being added
* so the next item to search for a free slot won't find the same one */
const itemSizeX = findSlotResult.rotation ? itemSize[1] : itemSize[0];
const itemSizeY = findSlotResult.rotation ? itemSize[0] : itemSize[1];
try
{
stashFS2D = this.containerHelper.fillContainerMapWithItem(
stashFS2D,
findSlotResult.x,
findSlotResult.y,
itemSizeX,
itemSizeY,
false,
); // TODO: rotation not passed in, bad?
}
catch (err)
{
const errorText = typeof err === "string" ? ` -> ${err}` : "";
this.logger.error(this.localisationService.getText("inventory-fill_container_failed", errorText));
return this.httpResponse.appendErrorToOutput(
output,
this.localisationService.getText("inventory-no_stash_space"),
);
}
// Store details for object, incuding container item will be placed in
itemToAdd.containerId = playerInventory.stash;
itemToAdd.location = {
x: findSlotResult.x,
y: findSlotResult.y,
r: findSlotResult.rotation ? 1 : 0,
rotation: findSlotResult.rotation,
};
// Success! exit
return;
}
// Space not found in main stash, use sorting table
if (useSortingTable)
{
const findSortingSlotResult = this.containerHelper.findSlotForItem(
sortingTableFS2D,
itemSize[0],
itemSize[1],
);
const itemSizeX = findSortingSlotResult.rotation ? itemSize[1] : itemSize[0];
const itemSizeY = findSortingSlotResult.rotation ? itemSize[0] : itemSize[1];
try
{
sortingTableFS2D = this.containerHelper.fillContainerMapWithItem(
sortingTableFS2D,
findSortingSlotResult.x,
findSortingSlotResult.y,
itemSizeX,
itemSizeY,
false,
); // TODO: rotation not passed in, bad?
}
catch (err)
{
const errorText = typeof err === "string" ? ` -> ${err}` : "";
this.logger.error(this.localisationService.getText("inventory-fill_container_failed", errorText));
return this.httpResponse.appendErrorToOutput(
output,
this.localisationService.getText("inventory-no_stash_space"),
);
}
// Store details for object, incuding container item will be placed in
itemToAdd.containerId = playerInventory.sortingTable;
itemToAdd.location = {
x: findSortingSlotResult.x,
y: findSortingSlotResult.y,
r: findSortingSlotResult.rotation ? 1 : 0,
rotation: findSortingSlotResult.rotation,
};
}
else
{
return this.httpResponse.appendErrorToOutput(
output,
this.localisationService.getText("inventory-no_stash_space"),
);
}
}
/**
* Add ammo to ammo boxes
* @param itemToAdd Item to check is ammo box
* @param parentId Ammo box parent id
* @param output IItemEventRouterResponse object
* @param sessionID Session id
* @param pmcData Profile to add ammobox to
* @param output object to send to client
* @param foundInRaid should ammo be FiR
*/
protected hydrateAmmoBoxWithAmmo(
pmcData: IPmcData,
itemToAdd: IAddItemTempObject,
parentId: string,
sessionID: string,
output: IItemEventRouterResponse,
foundInRaid: boolean,
): void
{
const itemInfo = this.itemHelper.getItem(itemToAdd.itemRef._tpl)[1];
const stackSlots = itemInfo._props.StackSlots;
if (stackSlots !== undefined)
{
// Cartridge info seems to be an array of size 1 for some reason... (See AmmoBox constructor in client code)
let maxCount = stackSlots[0]._max_count;
const ammoTpl = stackSlots[0]._props.filters[0].Filter[0];
const ammoStackMaxSize = this.itemHelper.getItem(ammoTpl)[1]._props.StackMaxSize;
const ammos = [];
let location = 0;
// Place stacks in ammo box no larger than StackMaxSize, prevents player when opening item getting stack of ammo > StackMaxSize
while (maxCount > 0)
{
const ammoStackSize = maxCount <= ammoStackMaxSize ? maxCount : ammoStackMaxSize;
const ammoItem: Item = {
_id: this.hashUtil.generate(),
_tpl: ammoTpl,
parentId: parentId,
slotId: "cartridges",
location: location,
upd: { StackObjectsCount: ammoStackSize },
};
if (foundInRaid)
{
ammoItem.upd.SpawnedInSession = true;
}
ammos.push(ammoItem);
location++;
maxCount -= ammoStackMaxSize;
}
for (const item of [output.profileChanges[sessionID].items.new, pmcData.Inventory.items])
{
item.push(...ammos);
}
}
}
/**
* @param assortItems Items to add to inventory
* @param requestItem Details of purchased item to add to inventory
* @param result Array split stacks are added to
*/
protected splitStackIntoSmallerStacks(assortItems: Item[], requestItem: AddItem, result: IAddItemTempObject[]): void
{
for (const item of assortItems)
{
// Iterated item matches root item
if (item._id === requestItem.item_id)
{
// Get item details from db
const itemDetails = this.itemHelper.getItem(item._tpl)[1];
const itemToAdd: IAddItemTempObject = {
itemRef: item,
count: requestItem.count,
isPreset: !!requestItem.sptIsPreset,
};
// Split stacks if the size is higher than allowed by items StackMaxSize property
let maxStackCount = 1;
if (requestItem.count > itemDetails._props.StackMaxSize)
{
let remainingCountOfItemToAdd = requestItem.count;
const calc = requestItem.count
- (Math.floor(requestItem.count / itemDetails._props.StackMaxSize)
* itemDetails._props.StackMaxSize);
maxStackCount = (calc > 0)
? maxStackCount + Math.floor(remainingCountOfItemToAdd / itemDetails._props.StackMaxSize)
: Math.floor(remainingCountOfItemToAdd / itemDetails._props.StackMaxSize);
// Iterate until totalCountOfPurchasedItem is 0
for (let i = 0; i < maxStackCount; i++)
{
// Keep splitting items into stacks until none left
if (remainingCountOfItemToAdd > 0)
{
const newChildItemToAdd = this.jsonUtil.clone(itemToAdd);
if (remainingCountOfItemToAdd > itemDetails._props.StackMaxSize)
{
// Reduce total count of item purchased by stack size we're going to add to inventory
remainingCountOfItemToAdd -= itemDetails._props.StackMaxSize;
newChildItemToAdd.count = itemDetails._props.StackMaxSize;
}
else
{
newChildItemToAdd.count = remainingCountOfItemToAdd;
}
result.push(newChildItemToAdd);
}
}
}
else
{
// Item count is within allowed stack size, just add it
result.push(itemToAdd);
}
}
}
}
/**
* Handle Remove event
* Remove item from player inventory + insured items array
* Also deletes child items
* @param profile Profile to remove item from (pmc or scav)
* @param itemId Items id to remove
* @param sessionID Session id
* @param output Existing IItemEventRouterResponse object to append data to, creates new one by default if not supplied
* @returns IItemEventRouterResponse
*/
public removeItem(
profile: IPmcData,
itemId: string,
sessionID: string,
output: IItemEventRouterResponse = undefined,
): IItemEventRouterResponse
{
if (!itemId)
{
this.logger.warning("No itemId supplied, unable to remove item from inventory");
return output;
}
// Get children of item, they get deleted too
const itemToRemoveWithChildren = this.itemHelper.findAndReturnChildrenByItems(profile.Inventory.items, itemId);
const inventoryItems = profile.Inventory.items;
const insuredItems = profile.InsuredItems;
// We have output object, inform client of item deletion
if (output)
{
output.profileChanges[sessionID].items.del.push({ _id: itemId });
}
for (const childId of itemToRemoveWithChildren)
{
// We expect that each inventory item and each insured item has unique "_id", respective "itemId".
// Therefore we want to use a NON-Greedy function and escape the iteration as soon as we find requested item.
const inventoryIndex = inventoryItems.findIndex((item) => item._id === childId);
if (inventoryIndex > -1)
{
inventoryItems.splice(inventoryIndex, 1);
}
if (inventoryIndex === -1)
{
this.logger.warning(
`Unable to remove item with Id: ${childId} as it was not found in inventory ${profile._id}`,
);
}
const insuredIndex = insuredItems.findIndex((item) => item.itemId === childId);
if (insuredIndex > -1)
{
insuredItems.splice(insuredIndex, 1);
}
}
return output;
}
public removeItemAndChildrenFromMailRewards(
sessionId: string,
removeRequest: IInventoryRemoveRequestData,
output: IItemEventRouterResponse,
): IItemEventRouterResponse
{
const fullProfile = this.profileHelper.getFullProfile(sessionId);
// Iterate over all dialogs and look for mesasage with key from request, that has item (and maybe its children) we want to remove
const dialogs = Object.values(fullProfile.dialogues);
for (const dialog of dialogs)
{
const messageWithReward = dialog.messages.find((x) => x._id === removeRequest.fromOwner.id);
if (messageWithReward)
{
// Find item + any possible children and remove them from mails items array
const itemWithChildern = this.itemHelper.findAndReturnChildrenAsItems(
messageWithReward.items.data,
removeRequest.item,
);
for (const itemToDelete of itemWithChildern)
{
// Get index of item to remove from reward array + remove it
const indexOfItemToRemove = messageWithReward.items.data.indexOf(itemToDelete);
if (indexOfItemToRemove === -1)
{
this.logger.error(
`Unable to remove item: ${removeRequest.item} from mail: ${removeRequest.fromOwner.id} as item could not be found, restart client immediately to prevent data corruption`,
);
continue;
}
messageWithReward.items.data.splice(indexOfItemToRemove, 1);
}
// Flag message as having no rewards if all removed
const hasRewardItemsRemaining = messageWithReward?.items.data?.length > 0;
messageWithReward.hasRewards = hasRewardItemsRemaining;
messageWithReward.rewardCollected = !hasRewardItemsRemaining;
}
}
return output;
}
public removeItemByCount(
pmcData: IPmcData,
itemId: string,
count: number,
sessionID: string,
output: IItemEventRouterResponse = undefined,
): IItemEventRouterResponse
{
if (!itemId)
{
return output;
}
const itemsToReduce = this.itemHelper.findAndReturnChildrenAsItems(pmcData.Inventory.items, itemId);
let remainingCount = count;
for (const itemToReduce of itemsToReduce)
{
const itemCount = this.itemHelper.getItemStackSize(itemToReduce);
// remove whole stack
if (remainingCount >= itemCount)
{
remainingCount -= itemCount;
this.removeItem(pmcData, itemToReduce._id, sessionID, output);
}
else
{
itemToReduce.upd.StackObjectsCount -= remainingCount;
remainingCount = 0;
if (output)
{
output.profileChanges[sessionID].items.change.push(itemToReduce);
}
}
if (remainingCount === 0)
{
break;
}
}
return output;
}
/* Calculate Size of item input
* inputs Item template ID, Item Id, InventoryItem (item from inventory having _id and _tpl)
* outputs [width, height]
*/
public getItemSize(itemTpl: string, itemID: string, inventoryItems: Item[]): number[]
{
// -> Prepares item Width and height returns [sizeX, sizeY]
return this.getSizeByInventoryItemHash(itemTpl, itemID, this.getInventoryItemHash(inventoryItems));
}
// note from 2027: there IS a thing i didn't explore and that is Merges With Children
// -> Prepares item Width and height returns [sizeX, sizeY]
protected getSizeByInventoryItemHash(
itemTpl: string,
itemID: string,
inventoryItemHash: InventoryHelper.InventoryItemHash,
): number[]
{
const toDo = [itemID];
const result = this.itemHelper.getItem(itemTpl);
const tmpItem = result[1];
// Invalid item or no object
if (!(result[0] && result[1]))
{
this.logger.error(this.localisationService.getText("inventory-invalid_item_missing_from_db", itemTpl));
}
// Item found but no _props property
if (tmpItem && !tmpItem._props)
{
this.localisationService.getText("inventory-item_missing_props_property", {
itemTpl: itemTpl,
itemName: tmpItem?._name,
});
}
// No item object or getItem() returned false
if (!(tmpItem && result[0]))
{
// return default size of 1x1
this.logger.error(this.localisationService.getText("inventory-return_default_size", itemTpl));
return [1, 1];
}
const rootItem = inventoryItemHash.byItemId[itemID];
const foldableWeapon = tmpItem._props.Foldable;
const foldedSlot = tmpItem._props.FoldedSlot;
let sizeUp = 0;
let sizeDown = 0;
let sizeLeft = 0;
let sizeRight = 0;
let forcedUp = 0;
let forcedDown = 0;
let forcedLeft = 0;
let forcedRight = 0;
let outX = tmpItem._props.Width;
const outY = tmpItem._props.Height;
const skipThisItems: string[] = [
BaseClasses.BACKPACK,
BaseClasses.SEARCHABLE_ITEM,
BaseClasses.SIMPLE_CONTAINER,
];
const rootFolded = rootItem.upd?.Foldable && rootItem.upd.Foldable.Folded === true;
// The item itself is collapsible
if (foldableWeapon && (foldedSlot === undefined || foldedSlot === "") && rootFolded)
{
outX -= tmpItem._props.SizeReduceRight;
}
if (!skipThisItems.includes(tmpItem._parent))
{
while (toDo.length > 0)
{
if (toDo[0] in inventoryItemHash.byParentId)
{
for (const item of inventoryItemHash.byParentId[toDo[0]])
{
// Filtering child items outside of mod slots, such as those inside containers, without counting their ExtraSize attribute
if (item.slotId.indexOf("mod_") < 0)
{
continue;
}
toDo.push(item._id);
// If the barrel is folded the space in the barrel is not counted
const itemResult = this.itemHelper.getItem(item._tpl);
if (!itemResult[0])
{
this.logger.error(
this.localisationService.getText(
"inventory-get_item_size_item_not_found_by_tpl",
item._tpl,
),
);
}
const itm = itemResult[1];
const childFoldable = itm._props.Foldable;
const childFolded = item.upd?.Foldable && item.upd.Foldable.Folded === true;
if (foldableWeapon && foldedSlot === item.slotId && (rootFolded || childFolded))
{
continue;
}
else if (childFoldable && rootFolded && childFolded)
{
continue;
}
// Calculating child ExtraSize
if (itm._props.ExtraSizeForceAdd === true)
{
forcedUp += itm._props.ExtraSizeUp;
forcedDown += itm._props.ExtraSizeDown;
forcedLeft += itm._props.ExtraSizeLeft;
forcedRight += itm._props.ExtraSizeRight;
}
else
{
sizeUp = sizeUp < itm._props.ExtraSizeUp ? itm._props.ExtraSizeUp : sizeUp;
sizeDown = sizeDown < itm._props.ExtraSizeDown ? itm._props.ExtraSizeDown : sizeDown;
sizeLeft = sizeLeft < itm._props.ExtraSizeLeft ? itm._props.ExtraSizeLeft : sizeLeft;
sizeRight = sizeRight < itm._props.ExtraSizeRight ? itm._props.ExtraSizeRight : sizeRight;
}
}
}
toDo.splice(0, 1);
}
}
return [
outX + sizeLeft + sizeRight + forcedLeft + forcedRight,
outY + sizeUp + sizeDown + forcedUp + forcedDown,
];
}
protected getInventoryItemHash(inventoryItem: Item[]): InventoryHelper.InventoryItemHash
{
const inventoryItemHash: InventoryHelper.InventoryItemHash = { byItemId: {}, byParentId: {} };
for (const item of inventoryItem)
{
inventoryItemHash.byItemId[item._id] = item;
if (!("parentId" in item))
{
continue;
}
if (!(item.parentId in inventoryItemHash.byParentId))
{
inventoryItemHash.byParentId[item.parentId] = [];
}
inventoryItemHash.byParentId[item.parentId].push(item);
}
return inventoryItemHash;
}
public getContainerMap(containerW: number, containerH: number, itemList: Item[], containerId: string): number[][]
{
const container2D: number[][] = Array(containerH).fill(0).map(() => Array(containerW).fill(0));
const inventoryItemHash = this.getInventoryItemHash(itemList);
const containerItemHash = inventoryItemHash.byParentId[containerId];
if (!containerItemHash)
{
// No items in the container
return container2D;
}
for (const item of containerItemHash)
{
if (!("location" in item))
{
continue;
}
const tmpSize = this.getSizeByInventoryItemHash(item._tpl, item._id, inventoryItemHash);
const iW = tmpSize[0]; // x
const iH = tmpSize[1]; // y
const fH =
((item.location as Location).r === 1 || (item.location as Location).r === "Vertical"
|| (item.location as Location).rotation === "Vertical")
? iW
: iH;
const fW =
((item.location as Location).r === 1 || (item.location as Location).r === "Vertical"
|| (item.location as Location).rotation === "Vertical")
? iH
: iW;
const fillTo = (item.location as Location).x + fW;
for (let y = 0; y < fH; y++)
{
try
{
container2D[(item.location as Location).y + y].fill(1, (item.location as Location).x, fillTo);
}
catch (e)
{
this.logger.error(
this.localisationService.getText("inventory-unable_to_fill_container", {
id: item._id,
error: e,
}),
);
}
}
}
return container2D;
}
/**
* Return the inventory that needs to be modified (scav/pmc etc)
* Changes made to result apply to character inventory
* Based on the item action, determine whose inventories we should be looking at for from and to.
* @param request Item interaction request
* @param sessionId Session id / playerid
* @returns OwnerInventoryItems with inventory of player/scav to adjust
*/
public getOwnerInventoryItems(
request: IInventoryMoveRequestData | IInventorySplitRequestData | IInventoryMergeRequestData,
sessionId: string,
): OwnerInventoryItems
{
let isSameInventory = false;
const pmcItems = this.profileHelper.getPmcProfile(sessionId).Inventory.items;
const scavData = this.profileHelper.getScavProfile(sessionId);
let fromInventoryItems = pmcItems;
let fromType = "pmc";
if (request.fromOwner)
{
if (request.fromOwner.id === scavData._id)
{
fromInventoryItems = scavData.Inventory.items;
fromType = "scav";
}
else if (request.fromOwner.type.toLocaleLowerCase() === "mail")
{
// Split requests dont use 'use' but 'splitItem' property
const item = "splitItem" in request ? request.splitItem : request.item;
fromInventoryItems = this.dialogueHelper.getMessageItemContents(request.fromOwner.id, sessionId, item);
fromType = "mail";
}
}
// Don't need to worry about mail for destination because client doesn't allow
// users to move items back into the mail stash.
let toInventoryItems = pmcItems;
let toType = "pmc";
// Destination is scav inventory, update values
if (request.toOwner?.id === scavData._id)
{
toInventoryItems = scavData.Inventory.items;
toType = "scav";
}
// From and To types match, same inventory
if (fromType === toType)
{
isSameInventory = true;
}
return {
from: fromInventoryItems,
to: toInventoryItems,
sameInventory: isSameInventory,
isMail: fromType === "mail",
};
}
/**
* Made a 2d array table with 0 - free slot and 1 - used slot
* @param {Object} pmcData
* @param {string} sessionID
* @returns Array
*/
protected getStashSlotMap(pmcData: IPmcData, sessionID: string): number[][]
{
const playerStashSize = this.getPlayerStashSize(sessionID);
return this.getContainerMap(
playerStashSize[0],
playerStashSize[1],
pmcData.Inventory.items,
pmcData.Inventory.stash,
);
}
protected getSortingTableSlotMap(pmcData: IPmcData): number[][]
{
return this.getContainerMap(10, 45, pmcData.Inventory.items, pmcData.Inventory.sortingTable);
}
/**
* Get Player Stash Proper Size
* @param sessionID Playerid
* @returns Array of 2 values, x and y stash size
*/
protected getPlayerStashSize(sessionID: string): Record<number, number>
{
// this sets automatically a stash size from items.json (its not added anywhere yet cause we still use base stash)
const stashTPL = this.getStashType(sessionID);
if (!stashTPL)
{
this.logger.error(this.localisationService.getText("inventory-missing_stash_size"));
}
const stashItemDetails = this.itemHelper.getItem(stashTPL);
if (!stashItemDetails[0])
{
this.logger.error(this.localisationService.getText("inventory-stash_not_found", stashTPL));
}
const stashX = stashItemDetails[1]._props.Grids[0]._props.cellsH !== 0
? stashItemDetails[1]._props.Grids[0]._props.cellsH
: 10;
const stashY = stashItemDetails[1]._props.Grids[0]._props.cellsV !== 0
? stashItemDetails[1]._props.Grids[0]._props.cellsV
: 66;
return [stashX, stashY];
}
/**
* Get the players stash items tpl
* @param sessionID Player id
* @returns Stash tpl
*/
protected getStashType(sessionID: string): string
{
const pmcData = this.profileHelper.getPmcProfile(sessionID);
const stashObj = pmcData.Inventory.items.find((item) => item._id === pmcData.Inventory.stash);
if (!stashObj)
{
this.logger.error(this.localisationService.getText("inventory-unable_to_find_stash"));
}
return stashObj?._tpl;
}
/**
* Internal helper function to transfer an item from one profile to another.
* @param fromItems Inventory of the source (can be non-player)
* @param toItems Inventory of the destination
* @param body Move request
*/
public moveItemToProfile(fromItems: Item[], toItems: Item[], body: IInventoryMoveRequestData): void
{
this.handleCartridges(fromItems, body);
// Get all children item has, they need to move with item
const idsToMove = this.itemHelper.findAndReturnChildrenByItems(fromItems, body.item);
for (const itemId of idsToMove)
{
const itemToMove = fromItems.find((x) => x._id === itemId);
if (!itemToMove)
{
this.logger.error(`Unable to find item to move: ${itemId}`);
}
// Only adjust the values for parent item, not children (their values are already correctly tied to parent)
if (itemId === body.item)
{
itemToMove.parentId = body.to.id;
itemToMove.slotId = body.to.container;
if (body.to.location)
{
// Update location object
itemToMove.location = body.to.location;
}
else
{
// No location in request, delete it
if (itemToMove.location)
{
delete itemToMove.location;
}
}
}
toItems.push(itemToMove);
fromItems.splice(fromItems.indexOf(itemToMove), 1);
}
}
/**
* Internal helper function to move item within the same profile_f.
* @param pmcData profile to edit
* @param inventoryItems
* @param moveRequest
* @returns True if move was successful
*/
public moveItemInternal(
pmcData: IPmcData,
inventoryItems: Item[],
moveRequest: IInventoryMoveRequestData,
): { success: boolean; errorMessage?: string; }
{
this.handleCartridges(inventoryItems, moveRequest);
// Find item we want to 'move'
const matchingInventoryItem = inventoryItems.find((x) => x._id === moveRequest.item);
if (!matchingInventoryItem)
{
const errorMesage = `Unable to move item: ${moveRequest.item}, cannot find in inventory`;
this.logger.error(errorMesage);
return { success: false, errorMessage: errorMesage };
}
this.logger.debug(
`${moveRequest.Action} item: ${moveRequest.item} from slotid: ${matchingInventoryItem.slotId} to container: ${moveRequest.to.container}`,
);
// don't move shells from camora to cartridges (happens when loading shells into mts-255 revolver shotgun)
if (matchingInventoryItem.slotId.includes("camora_") && moveRequest.to.container === "cartridges")
{
this.logger.warning(
this.localisationService.getText("inventory-invalid_move_to_container", {
slotId: matchingInventoryItem.slotId,
container: moveRequest.to.container,
}),
);
return { success: true };
}
// Edit items details to match its new location
matchingInventoryItem.parentId = moveRequest.to.id;
matchingInventoryItem.slotId = moveRequest.to.container;
this.updateFastPanelBinding(pmcData, matchingInventoryItem);
if ("location" in moveRequest.to)
{
matchingInventoryItem.location = moveRequest.to.location;
}
else
{
if (matchingInventoryItem.location)
{
delete matchingInventoryItem.location;
}
}
return { success: true };
}
/**
* Update fast panel bindings when an item is moved into a container that doesnt allow quick slot access
* @param pmcData Player profile
* @param itemBeingMoved item being moved
*/
protected updateFastPanelBinding(pmcData: IPmcData, itemBeingMoved: Item): void
{
// Find matching itemid in fast panel
for (const itemKey in pmcData.Inventory.fastPanel)
{
if (pmcData.Inventory.fastPanel[itemKey] === itemBeingMoved._id)
{
// Get moved items parent
const itemParent = pmcData.Inventory.items.find((x) => x._id === itemBeingMoved.parentId);
// Empty out id if item is moved to a container other than pocket/rig
if (itemParent && !(itemParent.slotId?.startsWith("Pockets") || itemParent.slotId === "TacticalVest"))
{
pmcData.Inventory.fastPanel[itemKey] = "";
}
break;
}
}
}
/**
* Internal helper function to handle cartridges in inventory if any of them exist.
*/
protected handleCartridges(items: Item[], body: IInventoryMoveRequestData): void
{
// -> Move item to different place - counts with equipping filling magazine etc
if (body.to.container === "cartridges")
{
let tmpCounter = 0;
for (const itemAmmo in items)
{
if (body.to.id === items[itemAmmo].parentId)
{
tmpCounter++;
}
}
// wrong location for first cartridge
body.to.location = tmpCounter;
}
}
/**
* Get details for how a random loot container should be handled, max rewards, possible reward tpls
* @param itemTpl Container being opened
* @returns Reward details
*/
public getRandomLootContainerRewardDetails(itemTpl: string): RewardDetails
{
return this.inventoryConfig.randomLootContainers[itemTpl];
}
public getInventoryConfig(): IInventoryConfig
{
return this.inventoryConfig;
}
}
namespace InventoryHelper
{
export interface InventoryItemHash
{
byItemId: Record<string, Item>;
byParentId: Record<string, Item[]>;
}
}