Initial release for SPT 3.9

types/helpers/BotHelper.d.ts

@@ -0,0 +1,80 @@
+import { MinMax } from "@spt/models/common/MinMax";
+import { Difficulty, IBotType } from "@spt/models/eft/common/tables/IBotType";
+import { EquipmentFilters, IBotConfig, RandomisationDetails } from "@spt/models/spt/config/IBotConfig";
+import { IPmcConfig } from "@spt/models/spt/config/IPmcConfig";
+import { ILogger } from "@spt/models/spt/utils/ILogger";
+import { ConfigServer } from "@spt/servers/ConfigServer";
+import { DatabaseService } from "@spt/services/DatabaseService";
+import { RandomUtil } from "@spt/utils/RandomUtil";
+export declare class BotHelper {
+    protected logger: ILogger;
+    protected databaseService: DatabaseService;
+    protected randomUtil: RandomUtil;
+    protected configServer: ConfigServer;
+    protected botConfig: IBotConfig;
+    protected pmcConfig: IPmcConfig;
+    constructor(logger: ILogger, databaseService: DatabaseService, randomUtil: RandomUtil, configServer: ConfigServer);
+    /**
+     * Get a template object for the specified botRole from bots.types db
+     * @param role botRole to get template for
+     * @returns IBotType object
+     */
+    getBotTemplate(role: string): IBotType;
+    /**
+     * Is the passed in bot role a PMC (usec/bear/pmc)
+     * @param botRole bot role to check
+     * @returns true if is pmc
+     */
+    isBotPmc(botRole: string): boolean;
+    isBotBoss(botRole: string): boolean;
+    isBotFollower(botRole: string): boolean;
+    /**
+     * Add a bot to the FRIENDLY_BOT_TYPES array
+     * @param difficultySettings bot settings to alter
+     * @param typeToAdd bot type to add to friendly list
+     */
+    addBotToFriendlyList(difficultySettings: Difficulty, typeToAdd: string): void;
+    /**
+     * Add a bot to the REVENGE_BOT_TYPES array
+     * @param difficultySettings bot settings to alter
+     * @param typesToAdd bot type to add to revenge list
+     */
+    addBotToRevengeList(difficultySettings: Difficulty, typesToAdd: string[]): void;
+    /**
+     * 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
+     */
+    shouldBotBePmc(botRole: string): boolean;
+    rollChanceToBePmc(role: string, botConvertMinMax: MinMax): boolean;
+    /**
+     * is the provided role a PMC, case-agnostic
+     * @param botRole Role to check
+     * @returns True if role is PMC
+     */
+    botRoleIsPmc(botRole: string): boolean;
+    /**
+     * Get randomization settings for bot from config/bot.json
+     * @param botLevel level of bot
+     * @param botEquipConfig bot equipment json
+     * @returns RandomisationDetails
+     */
+    getBotRandomizationDetails(botLevel: number, botEquipConfig: EquipmentFilters): RandomisationDetails | undefined;
+    /**
+     * Choose between pmcBEAR and pmcUSEC at random based on the % defined in pmcConfig.isUsec
+     * @returns pmc role
+     */
+    getRandomizedPmcRole(): string;
+    /**
+     * Get the corresponding side when pmcBEAR or pmcUSEC is passed in
+     * @param botRole role to get side for
+     * @returns side (usec/bear)
+     */
+    getPmcSideByRole(botRole: string): string;
+    /**
+     * Get a randomized PMC side based on bot config value 'isUsec'
+     * @returns pmc side as string
+     */
+    protected getRandomizedPmcSide(): string;
+    getPmcNicknameOfMaxLength(userId: string, maxLength: number): string;
+}