Updates for APT 3.2.3

Author: refringe

package.json

@@ -1,10 +1,10 @@
 {
     "name": "CustomCameraRecoil",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "main": "src/mod.js",
     "license": "MIT",
-    "author": "Dinkadactyl",
-    "akiVersion": "3.2.2",
+    "author": "Refringe",
+    "akiVersion": "3.2.3",
     "scripts": {
         "setup": "npm i",
         "build": "node ./packageBuild.ts"

packageBuild.ts

@@ -32,6 +32,7 @@ const ignoreList = [
     "types/",
     ".git/",
     ".gitea/",
+    ".github/",
     ".eslintignore",
     ".eslintrc.json",
     ".gitignore",

types/context/ContextVariable.d.ts

@@ -4,7 +4,7 @@ export declare class ContextVariable {
     private timestamp;
     private type;
     constructor(value: any, type: ContextVariableType);
-    getValue(): any;
+    getValue<T>(): T;
     getTimestamp(): Date;
     getType(): ContextVariableType;
 }

types/controllers/BotController.d.ts

@@ -5,15 +5,21 @@ import { IBotBase } from "../models/eft/common/tables/IBotBase";
 import { IBotCore } from "../models/eft/common/tables/IBotCore";
 import { Difficulty } from "../models/eft/common/tables/IBotType";
 import { IBotConfig } from "../models/spt/config/IBotConfig";
+import { ILogger } from "../models/spt/utils/ILogger";
 import { ConfigServer } from "../servers/ConfigServer";
 import { DatabaseServer } from "../servers/DatabaseServer";
+import { BotGenerationCacheService } from "../services/BotGenerationCacheService";
+import { PmcAiService } from "../services/PmcAiService";
 export declare class BotController {
+    protected logger: ILogger;
     protected databaseServer: DatabaseServer;
     protected botGenerator: BotGenerator;
     protected botHelper: BotHelper;
+    protected pmcAiService: PmcAiService;
+    protected botGenerationCacheService: BotGenerationCacheService;
     protected configServer: ConfigServer;
     protected botConfig: IBotConfig;
-    constructor(databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, configServer: ConfigServer);
+    constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, pmcAiService: PmcAiService, botGenerationCacheService: BotGenerationCacheService, configServer: ConfigServer);
     /**
      * Return the number of bot loadout varieties to be generated
      * @param type bot Type we want the loadout gen count for
@@ -29,7 +35,7 @@ export declare class BotController {
      * @returns Difficulty object
      */
     getBotDifficulty(type: string, difficulty: string): Difficulty;
-    protected getPmcDifficultySettings(pmcType: "bear" | "usec", difficulty: string): Difficulty;
+    protected getPmcDifficultySettings(pmcType: "bear" | "usec", difficulty: string, usecType: string, bearType: string): Difficulty;
     generate(sessionId: string, info: IGenerateBotsRequestData): IBotBase[];
     getBotCap(): number;
 }

types/controllers/MatchController.d.ts

@@ -15,8 +15,10 @@ import { IMatchConfig } from "../models/spt/config/IMatchConfig";
 import { ILogger } from "../models/spt/utils/ILogger";
 import { ConfigServer } from "../servers/ConfigServer";
 import { SaveServer } from "../servers/SaveServer";
+import { BotGenerationCacheService } from "../services/BotGenerationCacheService";
 import { BotLootCacheService } from "../services/BotLootCacheService";
 import { MatchLocationService } from "../services/MatchLocationService";
+import { PmcAiService } from "../services/PmcAiService";
 import { ProfileSnapshotService } from "../services/ProfileSnapshotService";
 export declare class MatchController {
     protected logger: ILogger;
@@ -27,11 +29,13 @@ export declare class MatchController {
     protected botLootCacheService: BotLootCacheService;
     protected configServer: ConfigServer;
     protected profileSnapshotService: ProfileSnapshotService;
+    protected pmcAiService: PmcAiService;
+    protected botGenerationCacheService: BotGenerationCacheService;
     protected applicationContext: ApplicationContext;
     protected matchConfig: IMatchConfig;
     protected inraidConfig: IInRaidConfig;
     protected botConfig: IBotConfig;
-    constructor(logger: ILogger, saveServer: SaveServer, profileHelper: ProfileHelper, matchLocationService: MatchLocationService, traderHelper: TraderHelper, botLootCacheService: BotLootCacheService, configServer: ConfigServer, profileSnapshotService: ProfileSnapshotService, applicationContext: ApplicationContext);
+    constructor(logger: ILogger, saveServer: SaveServer, profileHelper: ProfileHelper, matchLocationService: MatchLocationService, traderHelper: TraderHelper, botLootCacheService: BotLootCacheService, configServer: ConfigServer, profileSnapshotService: ProfileSnapshotService, pmcAiService: PmcAiService, botGenerationCacheService: BotGenerationCacheService, applicationContext: ApplicationContext);
     getEnabled(): boolean;
     getProfile(info: IGetProfileRequestData): IPmcData[];
     createGroup(sessionID: string, info: ICreateGroupRequestData): any;

types/generators/BotGenerator.d.ts

@@ -9,6 +9,7 @@ import { ILogger } from "../models/spt/utils/ILogger";
 import { ConfigServer } from "../servers/ConfigServer";
 import { DatabaseServer } from "../servers/DatabaseServer";
 import { BotEquipmentFilterService } from "../services/BotEquipmentFilterService";
+import { PmcAiService } from "../services/PmcAiService";
 import { HashUtil } from "../utils/HashUtil";
 import { JsonUtil } from "../utils/JsonUtil";
 import { RandomUtil } from "../utils/RandomUtil";
@@ -30,9 +31,10 @@ export declare class BotGenerator {
     protected botEquipmentFilterService: BotEquipmentFilterService;
     protected botHelper: BotHelper;
     protected gameEventHelper: GameEventHelper;
+    protected pmcAiService: PmcAiService;
     protected configServer: ConfigServer;
     protected botConfig: IBotConfig;
-    constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, jsonUtil: JsonUtil, profileHelper: ProfileHelper, databaseServer: DatabaseServer, botInventoryGenerator: BotInventoryGenerator, botEquipmentFilterService: BotEquipmentFilterService, botHelper: BotHelper, gameEventHelper: GameEventHelper, configServer: ConfigServer);
+    constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, jsonUtil: JsonUtil, profileHelper: ProfileHelper, databaseServer: DatabaseServer, botInventoryGenerator: BotInventoryGenerator, botEquipmentFilterService: BotEquipmentFilterService, botHelper: BotHelper, gameEventHelper: GameEventHelper, pmcAiService: PmcAiService, configServer: ConfigServer);
     /**
      * Generate a player scav bot object
      * @param role e.g. assault / pmcbot
@@ -41,13 +43,13 @@ export declare class BotGenerator {
      * @returns
      */
     generatePlayerScav(sessionId: string, role: string, difficulty: string, botTemplate: IBotType): IBotBase;
-    generate(sessionId: string, info: IGenerateBotsRequestData): IBotBase[];
     /**
-     * Choose if a bot should become a PMC by checking if bot type is allowed to become a Pmc in botConfig.convertFromChances and doing a random int check
-     * @param botRole the bot role to check if should be a pmc
-     * @returns true if should be a pmc
+     * Generate an array of bot objects for populate a raid with
+     * @param sessionId session id
+     * @param info request object
+     * @returns bot array
      */
-    protected shouldBotBePmc(botRole: string): boolean;
+    generate(sessionId: string, info: IGenerateBotsRequestData): IBotBase[];
     /**
      * Get a randomised PMC side based on bot config value 'isUsec'
      * @returns pmc side as string
@@ -58,12 +60,30 @@ export declare class BotGenerator {
      * @returns IBotBase object
      */
     protected getCloneOfBotBase(): IBotBase;
+    /**
+     * Create a IBotBase object with equipment/loot/exp etc
+     * @param sessionId Session id
+     * @param bot bots base file
+     * @param role botRole bot will use
+     * @param node Bot template from db/bots/x.json
+     * @param isPmc Is bot to be a PMC
+     * @param isPlayerScav is bot to be a p scav bot
+     * @returns IBotBase object
+     */
     protected generateBot(sessionId: string, bot: IBotBase, role: string, node: IBotType, isPmc: boolean, isPlayerScav?: boolean): IBotBase;
     /**
      * Log the number of PMCs generated to the debug console
+     * @param output Generated bot array, ready to send to client
      */
     protected logPmcGeneratedCount(output: IBotBase[]): void;
-    protected generateRandomLevel(min: number, max: number): BotGenerator.IRandomisedBotLevelResult;
+    /**
+     * Return a randomised bot level and exp value
+     * @param role botRole being generated for
+     * @param min Min exp value
+     * @param max Max exp value
+     * @returns IRandomisedBotLevelResult object
+     */
+    protected generateRandomLevel(role: string, min: number, max: number): BotGenerator.IRandomisedBotLevelResult;
     /**
      * Converts health object to the required format
      * @param healthObj health object from bot json
@@ -72,19 +92,23 @@ export declare class BotGenerator {
      */
     protected generateHealth(healthObj: Health, playerScav?: boolean): PmcHealth;
     protected generateSkills(skillsObj: Skills): Skills;
-    /**
-     * Convert from pmc side (usec/bear) to the side as defined in the bot config (usecType/bearType)
-     * @param pmcSide eft side (usec/bear)
-     * @returns pmc side as defined in config
-     */
-    protected getPmcRole(pmcSide: string): string;
     /**
      * Iterate through bots inventory and loot to find and remove christmas items (as defined in GameEventHelper)
      * @param nodeInventory Bots inventory to iterate over
      */
     protected removeChristmasItemsFromBotInventory(nodeInventory: Inventory): void;
+    /**
+     * Generate a random Id for a bot and apply to bots _id and aid value
+     * @param bot bot to update
+     * @returns updated IBotBase object
+     */
     protected generateId(bot: IBotBase): IBotBase;
     protected generateInventoryID(profile: IBotBase): IBotBase;
+    /**
+     * Get the difficulty passed in, if its not "asoline", get selected difficulty from config
+     * @param requestedDifficulty
+     * @returns
+     */
     protected getPMCDifficulty(requestedDifficulty: string): string;
     /**
      * Add a side-specific (usec/bear) dogtag item to a bots inventory

types/generators/BotInventoryGenerator.d.ts

@@ -1,13 +1,16 @@
+import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper";
+import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper";
 import { Inventory as PmcInventory } from "../models/eft/common/tables/IBotBase";
-import { Inventory, Chances, Generation, Mods } from "../models/eft/common/tables/IBotType";
+import { Chances, Generation, Inventory, Mods } from "../models/eft/common/tables/IBotType";
+import { EquipmentSlots } from "../models/enums/EquipmentSlots";
+import { IBotConfig } from "../models/spt/config/IBotConfig";
+import { ILogger } from "../models/spt/utils/ILogger";
+import { ConfigServer } from "../servers/ConfigServer";
+import { DatabaseServer } from "../servers/DatabaseServer";
 import { HashUtil } from "../utils/HashUtil";
 import { RandomUtil } from "../utils/RandomUtil";
-import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper";
-import { BotWeaponGenerator } from "./BotWeaponGenerator";
 import { BotLootGenerator } from "./BotLootGenerator";
-import { ILogger } from "../models/spt/utils/ILogger";
-import { DatabaseServer } from "../servers/DatabaseServer";
-import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper";
+import { BotWeaponGenerator } from "./BotWeaponGenerator";
 export declare class BotInventoryGenerator {
     protected logger: ILogger;
     protected hashUtil: HashUtil;
@@ -17,8 +20,14 @@ export declare class BotInventoryGenerator {
     protected botLootGenerator: BotLootGenerator;
     protected botGeneratorHelper: BotGeneratorHelper;
     protected weightedRandomHelper: WeightedRandomHelper;
-    constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, botWeaponGenerator: BotWeaponGenerator, botLootGenerator: BotLootGenerator, botGeneratorHelper: BotGeneratorHelper, weightedRandomHelper: WeightedRandomHelper);
-    generateInventory(sessionId: string, templateInventory: Inventory, equipmentChances: Chances, generation: Generation, botRole: string, isPmc: boolean): PmcInventory;
+    protected configServer: ConfigServer;
+    protected botConfig: IBotConfig;
+    constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, botWeaponGenerator: BotWeaponGenerator, botLootGenerator: BotLootGenerator, botGeneratorHelper: BotGeneratorHelper, weightedRandomHelper: WeightedRandomHelper, configServer: ConfigServer);
+    generateInventory(sessionId: string, templateInventory: Inventory, equipmentChances: Chances, itemGenerationLimitsMinMax: Generation, botRole: string, isPmc: boolean): PmcInventory;
+    protected addWeaponAndMagazinesToInventory(sessionId: string, weaponSlot: {
+        slot: EquipmentSlots;
+        shouldSpawn: boolean;
+    }, templateInventory: Inventory, botInventory: PmcInventory, equipmentChances: Chances, botRole: string, isPmc: boolean, itemGenerationLimitsMinMax: Generation): void;
     protected generateEquipment(equipmentSlot: string, equipmentPool: Record<string, number>, modPool: Mods, spawnChances: Chances, botRole: string, inventory: PmcInventory): void;
     protected generateInventoryBase(): PmcInventory;
 }

types/generators/BotLootGenerator.d.ts

@@ -1,4 +1,5 @@
 import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper";
+import { BotWeaponGeneratorHelper } from "../helpers/BotWeaponGeneratorHelper";
 import { HandbookHelper } from "../helpers/HandbookHelper";
 import { Inventory as PmcInventory } from "../models/eft/common/tables/IBotBase";
 import { Chances, Inventory, ItemMinMax, ModsChances } from "../models/eft/common/tables/IBotType";
@@ -20,10 +21,11 @@ export declare class BotLootGenerator {
     protected handbookHelper: HandbookHelper;
     protected botGeneratorHelper: BotGeneratorHelper;
     protected botWeaponGenerator: BotWeaponGenerator;
+    protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper;
     protected botLootCacheService: BotLootCacheService;
     protected configServer: ConfigServer;
     protected botConfig: IBotConfig;
-    constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, botGeneratorHelper: BotGeneratorHelper, botWeaponGenerator: BotWeaponGenerator, botLootCacheService: BotLootCacheService, configServer: ConfigServer);
+    constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, botGeneratorHelper: BotGeneratorHelper, botWeaponGenerator: BotWeaponGenerator, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botLootCacheService: BotLootCacheService, configServer: ConfigServer);
     generateLoot(sessionId: string, templateInventory: Inventory, itemCounts: ItemMinMax, isPmc: boolean, botRole: string, botInventory: PmcInventory, equipmentChances: Chances): void;
     protected getRandomisedCount(min: number, max: number, nValue: number): number;
     /**