From 7a5877034ab0a47570ce0b4203c973d69244edf5 Mon Sep 17 00:00:00 2001 From: Valens Date: Sun, 25 Dec 2022 18:45:30 -0500 Subject: [PATCH] Upate types for 3.4.0 --- types/ErrorHandler.d.ts | 6 + types/Program.d.ts | 1 + types/callbacks/BotCallbacks.d.ts | 21 ++ types/callbacks/BundleCallbacks.d.ts | 6 +- types/callbacks/CustomizationCallbacks.d.ts | 14 +- types/callbacks/DataCallbacks.d.ts | 35 ++- types/callbacks/DialogueCallbacks.d.ts | 19 +- types/callbacks/GameCallbacks.d.ts | 39 ++- types/callbacks/HandbookCallbacks.d.ts | 2 +- types/callbacks/HealthCallbacks.d.ts | 12 + types/callbacks/HideoutCallbacks.d.ts | 65 ++++- types/callbacks/HttpCallbacks.d.ts | 8 +- types/callbacks/InraidCallbacks.d.ts | 48 +++- types/callbacks/InsuranceCallbacks.d.ts | 10 +- types/callbacks/InventoryCallbacks.d.ts | 2 + types/callbacks/ItemEventCallbacks.d.ts | 2 + types/callbacks/MatchCallbacks.d.ts | 4 + types/callbacks/ModCallbacks.d.ts | 10 +- types/callbacks/NotifierCallbacks.d.ts | 7 +- types/callbacks/PresetCallbacks.d.ts | 2 +- types/callbacks/QuestCallbacks.d.ts | 7 + types/callbacks/RagfairCallbacks.d.ts | 10 +- types/callbacks/RepairCallbacks.d.ts | 14 ++ types/callbacks/SaveCallbacks.d.ts | 4 +- types/callbacks/TraderCallbacks.d.ts | 8 +- types/callbacks/WeatherCallbacks.d.ts | 7 +- types/context/ApplicationContext.d.ts | 9 + types/context/ContextVariableType.d.ts | 8 +- types/controllers/BotController.d.ts | 42 +++- .../controllers/CustomizationController.d.ts | 8 +- types/controllers/DialogueController.d.ts | 68 +++++- types/controllers/GameController.d.ts | 43 +++- types/controllers/HealthController.d.ts | 27 ++- types/controllers/HideoutController.d.ts | 10 +- types/controllers/InraidController.d.ts | 71 +++++- types/controllers/InsuranceController.d.ts | 7 +- types/controllers/InventoryController.d.ts | 31 ++- types/controllers/LocationController.d.ts | 4 +- types/controllers/MatchController.d.ts | 15 +- types/controllers/NoteController.d.ts | 6 +- types/controllers/PresetBuildController.d.ts | 6 +- types/controllers/QuestController.d.ts | 34 ++- types/controllers/RagfairController.d.ts | 50 +++- types/controllers/RepairController.d.ts | 22 +- .../RepeatableQuestController.d.ts | 23 +- types/controllers/TradeController.d.ts | 8 +- types/controllers/TraderController.d.ts | 6 +- types/controllers/WeatherController.d.ts | 9 +- types/controllers/WishlistController.d.ts | 6 +- types/di/Container.d.ts | 1 + types/di/OnLoad.d.ts | 2 +- types/di/OnLoadOnUpdate.d.ts | 4 +- types/di/OnUpdate.d.ts | 2 +- types/di/Serializer.d.ts | 5 +- .../generators/BotEquipmentModGenerator.d.ts | 200 ++++++++++++++++ types/generators/BotGenerator.d.ts | 75 +++--- types/generators/BotInventoryGenerator.d.ts | 93 +++++++- types/generators/BotLevelGenerator.d.ts | 29 +++ types/generators/BotLootGenerator.d.ts | 21 +- types/generators/BotWeaponGenerator.d.ts | 12 +- .../generators/FenceBaseAssortGenerator.d.ts | 28 +++ types/generators/LocationGenerator.d.ts | 8 +- types/generators/LootGenerator.d.ts | 22 +- types/generators/PlayerScavGenerator.d.ts | 4 +- types/generators/RagfairOfferGenerator.d.ts | 75 +++++- types/generators/ScavCaseRewardGenerator.d.ts | 6 - types/generators/WeatherGenerator.d.ts | 40 +++- .../ExternalInventoryMagGen.d.ts | 4 +- types/helpers/AssortHelper.d.ts | 4 +- types/helpers/BotDifficultyHelper.d.ts | 46 ++++ types/helpers/BotGeneratorHelper.d.ts | 225 +++--------------- types/helpers/BotHelper.d.ts | 56 +++-- types/helpers/BotWeaponGeneratorHelper.d.ts | 4 +- types/helpers/DialogueHelper.d.ts | 11 +- types/helpers/GameEventHelper.d.ts | 10 +- types/helpers/HandbookHelper.d.ts | 52 ++-- types/helpers/HealthHelper.d.ts | 7 +- types/helpers/HideoutHelper.d.ts | 8 +- types/helpers/InRaidHelper.d.ts | 5 +- types/helpers/InventoryHelper.d.ts | 23 +- types/helpers/ItemHelper.d.ts | 29 ++- types/helpers/NotificationSendHelper.d.ts | 6 +- types/helpers/PresetHelper.d.ts | 2 + types/helpers/ProfileHelper.d.ts | 9 +- types/helpers/QuestHelper.d.ts | 113 +++++++-- types/helpers/RagfairOfferHelper.d.ts | 22 +- types/helpers/RagfairSellHelper.d.ts | 16 +- types/helpers/RagfairServerHelper.d.ts | 12 +- types/helpers/RagfairSortHelper.d.ts | 16 +- types/helpers/RepairHelper.d.ts | 15 +- types/helpers/TradeHelper.d.ts | 12 +- types/helpers/TraderAssortHelper.d.ts | 6 +- types/helpers/TraderHelper.d.ts | 47 +++- types/ide/Compiler.d.ts | 1 - types/loaders/PostDBModLoader.d.ts | 2 +- types/loaders/PreAkiModLoader.d.ts | 43 +++- .../eft/bot/IGenerateBotsRequestData.d.ts | 1 + .../eft/bot/IRandomisedBotLevelResult.d.ts | 4 + types/models/eft/common/IGlobals.d.ts | 2 + types/models/eft/common/tables/IBotBase.d.ts | 3 + types/models/eft/common/tables/IBotType.d.ts | 10 +- types/models/eft/common/tables/IQuest.d.ts | 7 +- .../eft/common/tables/IRepeatableQuests.d.ts | 2 +- .../eft/common/tables/ITemplateItem.d.ts | 6 +- types/models/eft/common/tables/ITrader.d.ts | 3 +- .../eft/customization/IGetSuitsResponse.d.ts | 4 + types/models/eft/dialog/IChatServer.d.ts | 16 ++ .../dialog/IGetFriendListDataResponse.d.ts | 4 +- .../eft/game/ICheckVersionResponse.d.ts | 4 + .../models/eft/game/IGameConfigResponse.d.ts | 2 + .../eft/game/IGameKeepAliveResponse.d.ts | 4 + .../eft/game/IGameLogoutResponseData.d.ts | 3 + types/models/eft/game/IGameStartResponse.d.ts | 3 + types/models/eft/game/IServerDetails.d.ts | 4 + .../eft/hideout/IHideoutProduction.d.ts | 2 +- .../IGetInsuranceCostResponseData.d.ts | 2 +- .../eft/inventory/IAddItemRequestData.d.ts | 7 +- .../IInventoryBaseActionRequestData.d.ts | 2 +- .../IOpenRandomLootContainerRequestData.d.ts | 11 + .../eft/itemEvent/IItemEventRouterBase.d.ts | 5 +- .../eft/launcher/IRemoveProfileData.d.ts | 2 +- .../match/IStartOffineRaidRequestData.d.ts | 4 +- .../eft/notifier/ISelectProfileResponse.d.ts | 6 + .../profile/GetProfileStatusResponseData.d.ts | 1 + types/models/eft/profile/IAkiProfile.d.ts | 23 +- types/models/eft/ragfair/IRagfairOffer.d.ts | 13 +- .../eft/ragfair/ISearchRequestData.d.ts | 3 +- types/models/eft/weather/IWeatherData.d.ts | 9 +- types/models/enums/BackendErrorCodes.d.ts | 67 ++++++ types/models/enums/BaseClasses.d.ts | 9 +- types/models/enums/ConfigTypes.d.ts | 3 +- types/models/enums/ExitStatis.d.ts | 7 + types/models/enums/HideoutEventActions.d.ts | 11 + types/models/enums/ItemEventActions.d.ts | 19 ++ types/models/enums/RagfairSort.d.ts | 7 + types/models/enums/WeatherType.d.ts | 19 ++ types/models/enums/WildSpawnTypeNumber.d.ts | 33 +++ types/models/enums/WindDirection.d.ts | 10 + types/models/external/HttpFramework.d.ts | 33 +++ .../models/spt/bots/BotGenerationDetails.d.ts | 18 ++ .../models/spt/callbacks/IDataCallbacks.d.ts | 3 +- types/models/spt/config/IAirdropConfig.d.ts | 1 + types/models/spt/config/IBotConfig.d.ts | 32 ++- types/models/spt/config/IHttpConfig.d.ts | 1 + types/models/spt/config/IInventoryConfig.d.ts | 6 + types/models/spt/config/ILocaleConfig.d.ts | 7 +- types/models/spt/config/ILocationConfig.d.ts | 8 + types/models/spt/config/IPmcConfig.d.ts | 5 +- types/models/spt/config/IQuestConfig.d.ts | 1 + types/models/spt/config/IRagfairConfig.d.ts | 20 +- .../spt/config/ISeasonalEventConfig.d.ts | 15 ++ types/models/spt/config/ITraderConfig.d.ts | 10 +- types/models/spt/config/IWeatherConfig.d.ts | 13 +- types/models/spt/server/IHttpServer.d.ts | 12 - types/models/spt/server/ILocaleBase.d.ts | 48 +--- types/models/spt/server/ISettingsBase.d.ts | 4 + types/models/spt/services/LootRequest.d.ts | 1 + types/routers/EventOutputHolder.d.ts | 11 + types/routers/ImageRouter.d.ts | 7 +- types/routers/ItemEventRouter.d.ts | 17 +- .../item_events/HideoutItemEventRouter.d.ts | 4 +- .../item_events/InventoryItemEventRouter.d.ts | 4 +- .../routers/serializers/BundleSerializer.d.ts | 9 +- .../routers/serializers/ImageSerializer.d.ts | 5 +- .../routers/serializers/NotifySerializer.d.ts | 5 +- types/servers/DatabaseServer.d.ts | 2 +- types/servers/HttpServer.d.ts | 45 +--- types/servers/RagfairServer.d.ts | 8 +- types/servers/SaveServer.d.ts | 8 +- types/servers/WebSocketServer.d.ts | 27 +++ types/servers/http/AkiHttpListener.d.ts | 28 +++ types/servers/http/HttpBufferHandler.d.ts | 6 + types/servers/http/HttpMethods.d.ts | 8 + types/servers/http/IHttpListener.d.ts | 6 + types/services/BotEquipmentFilterService.d.ts | 56 ++++- .../services/BotEquipmentModPoolService.d.ts | 65 +++++ types/services/BotGenerationCacheService.d.ts | 37 +-- types/services/BotLootCacheService.d.ts | 4 +- types/services/BotWeaponModLimitService.d.ts | 54 +++++ types/services/CustomLocationWaveService.d.ts | 42 ++++ types/services/FenceService.d.ts | 32 ++- types/services/InsuranceService.d.ts | 8 +- types/services/ItemBaseClassService.d.ts | 39 +++ types/services/ItemFilterService.d.ts | 2 +- types/services/LocaleService.d.ts | 33 ++- types/services/LocalisationService.d.ts | 21 ++ types/services/ModCompilerService.d.ts | 14 +- types/services/OpenZoneService.d.ts | 28 +++ types/services/PaymentService.d.ts | 12 +- types/services/PlayerService.d.ts | 4 +- types/services/PmcAiService.d.ts | 27 --- types/services/ProfileFixerService.d.ts | 26 +- types/services/RagfairOfferService.d.ts | 21 +- types/services/RagfairPriceService.d.ts | 72 +++++- .../services/RagfairRequiredItemsService.d.ts | 2 +- types/services/RepairService.d.ts | 73 ++++++ types/services/SeasonalEventService.d.ts | 72 ++++++ .../TraderPurchasePersisterService.d.ts | 34 +++ .../mod/httpListener/HttpListenerMod.d.ts | 10 + .../httpListener/HttpListenerModService.d.ts | 8 + types/services/mod/onLoad/OnLoadMod.d.ts | 2 +- types/services/mod/onUpdate/OnUpdateMod.d.ts | 2 +- types/utils/App.d.ts | 10 +- types/utils/DatabaseImporter.d.ts | 19 +- types/utils/HttpFileUtil.d.ts | 8 + types/utils/HttpResponseUtil.d.ts | 9 +- types/utils/JsonUtil.d.ts | 1 + types/utils/Logger.d.ts | 6 + types/utils/RagfairOfferHolder.d.ts | 24 ++ types/utils/RandomUtil.d.ts | 6 + types/utils/Watermark.d.ts | 28 +-- 211 files changed, 3121 insertions(+), 894 deletions(-) create mode 100644 types/ErrorHandler.d.ts create mode 100644 types/generators/BotEquipmentModGenerator.d.ts create mode 100644 types/generators/BotLevelGenerator.d.ts create mode 100644 types/generators/FenceBaseAssortGenerator.d.ts create mode 100644 types/helpers/BotDifficultyHelper.d.ts delete mode 100644 types/ide/Compiler.d.ts create mode 100644 types/models/eft/bot/IRandomisedBotLevelResult.d.ts create mode 100644 types/models/eft/customization/IGetSuitsResponse.d.ts create mode 100644 types/models/eft/dialog/IChatServer.d.ts create mode 100644 types/models/eft/game/ICheckVersionResponse.d.ts create mode 100644 types/models/eft/game/IGameKeepAliveResponse.d.ts create mode 100644 types/models/eft/game/IGameLogoutResponseData.d.ts create mode 100644 types/models/eft/game/IGameStartResponse.d.ts create mode 100644 types/models/eft/game/IServerDetails.d.ts create mode 100644 types/models/eft/inventory/IOpenRandomLootContainerRequestData.d.ts create mode 100644 types/models/eft/notifier/ISelectProfileResponse.d.ts create mode 100644 types/models/enums/BackendErrorCodes.d.ts create mode 100644 types/models/enums/ExitStatis.d.ts create mode 100644 types/models/enums/HideoutEventActions.d.ts create mode 100644 types/models/enums/ItemEventActions.d.ts create mode 100644 types/models/enums/RagfairSort.d.ts create mode 100644 types/models/enums/WeatherType.d.ts create mode 100644 types/models/enums/WildSpawnTypeNumber.d.ts create mode 100644 types/models/enums/WindDirection.d.ts create mode 100644 types/models/external/HttpFramework.d.ts create mode 100644 types/models/spt/bots/BotGenerationDetails.d.ts create mode 100644 types/models/spt/config/ISeasonalEventConfig.d.ts delete mode 100644 types/models/spt/server/IHttpServer.d.ts create mode 100644 types/routers/EventOutputHolder.d.ts create mode 100644 types/servers/WebSocketServer.d.ts create mode 100644 types/servers/http/AkiHttpListener.d.ts create mode 100644 types/servers/http/HttpBufferHandler.d.ts create mode 100644 types/servers/http/HttpMethods.d.ts create mode 100644 types/servers/http/IHttpListener.d.ts create mode 100644 types/services/BotEquipmentModPoolService.d.ts create mode 100644 types/services/BotWeaponModLimitService.d.ts create mode 100644 types/services/CustomLocationWaveService.d.ts create mode 100644 types/services/ItemBaseClassService.d.ts create mode 100644 types/services/LocalisationService.d.ts create mode 100644 types/services/OpenZoneService.d.ts delete mode 100644 types/services/PmcAiService.d.ts create mode 100644 types/services/RepairService.d.ts create mode 100644 types/services/SeasonalEventService.d.ts create mode 100644 types/services/TraderPurchasePersisterService.d.ts create mode 100644 types/services/mod/httpListener/HttpListenerMod.d.ts create mode 100644 types/services/mod/httpListener/HttpListenerModService.d.ts create mode 100644 types/utils/HttpFileUtil.d.ts create mode 100644 types/utils/RagfairOfferHolder.d.ts diff --git a/types/ErrorHandler.d.ts b/types/ErrorHandler.d.ts new file mode 100644 index 0000000..69b0bcd --- /dev/null +++ b/types/ErrorHandler.d.ts @@ -0,0 +1,6 @@ +export declare class ErrorHandler { + private logger; + private readLine; + constructor(); + handleCriticalError(err: any): void; +} diff --git a/types/Program.d.ts b/types/Program.d.ts index d4b71b9..afe5216 100644 --- a/types/Program.d.ts +++ b/types/Program.d.ts @@ -1,4 +1,5 @@ export declare class Program { + private errorHandler; constructor(); start(): void; } diff --git a/types/callbacks/BotCallbacks.d.ts b/types/callbacks/BotCallbacks.d.ts index 2db60dc..827015e 100644 --- a/types/callbacks/BotCallbacks.d.ts +++ b/types/callbacks/BotCallbacks.d.ts @@ -8,8 +8,29 @@ export declare class BotCallbacks { protected botController: BotController; protected httpResponse: HttpResponseUtil; constructor(botController: BotController, httpResponse: HttpResponseUtil); + /** + * Handle singleplayer/settings/bot/limit + * @returns string + */ getBotLimit(url: string, info: IEmptyRequestData, sessionID: string): string; + /** + * Handle singleplayer/settings/bot/difficulty + * @returns string + */ getBotDifficulty(url: string, info: IEmptyRequestData, sessionID: string): string; + /** + * Handle client/game/bot/generate + * @returns IGetBodyResponseData + */ generateBots(url: string, info: IGenerateBotsRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle singleplayer/settings/bot/maxCap + * @returns string + */ getBotCap(): string; + /** + * Handle singleplayer/settings/bot/getBotBehaviours + * @returns string + */ + getBotBehaviours(): string; } diff --git a/types/callbacks/BundleCallbacks.d.ts b/types/callbacks/BundleCallbacks.d.ts index b28abe1..b7e1703 100644 --- a/types/callbacks/BundleCallbacks.d.ts +++ b/types/callbacks/BundleCallbacks.d.ts @@ -1,17 +1,17 @@ import { BundleLoader } from "../loaders/BundleLoader"; import { IHttpConfig } from "../models/spt/config/IHttpConfig"; -import { IHttpServer } from "../models/spt/server/IHttpServer"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; +import { HttpFileUtil } from "../utils/HttpFileUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; export declare class BundleCallbacks { protected logger: ILogger; protected httpResponse: HttpResponseUtil; - protected httpServer: IHttpServer; + protected httpFileUtil: HttpFileUtil; protected bundleLoader: BundleLoader; protected configServer: ConfigServer; protected httpConfig: IHttpConfig; - constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpServer: IHttpServer, bundleLoader: BundleLoader, configServer: ConfigServer); + constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpFileUtil: HttpFileUtil, bundleLoader: BundleLoader, configServer: ConfigServer); sendBundle(sessionID: string, req: any, resp: any, body: any): any; getBundles(url: string, info: any, sessionID: string): string; getBundle(url: string, info: any, sessionID: string): string; diff --git a/types/callbacks/CustomizationCallbacks.d.ts b/types/callbacks/CustomizationCallbacks.d.ts index 3bab8c0..75d5701 100644 --- a/types/callbacks/CustomizationCallbacks.d.ts +++ b/types/callbacks/CustomizationCallbacks.d.ts @@ -3,6 +3,7 @@ import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IPmcData } from "../models/eft/common/IPmcData"; import { ISuit } from "../models/eft/common/tables/ITrader"; import { IBuyClothingRequestData } from "../models/eft/customization/IBuyClothingRequestData"; +import { IGetSuitsResponse } from "../models/eft/customization/IGetSuitsResponse"; import { IWearClothingRequestData } from "../models/eft/customization/IWearClothingRequestData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; @@ -13,10 +14,15 @@ export declare class CustomizationCallbacks { protected saveServer: SaveServer; protected httpResponse: HttpResponseUtil; constructor(customizationController: CustomizationController, saveServer: SaveServer, httpResponse: HttpResponseUtil); - getSuits(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData<{ - _id: string; - suites: string[]; - }>; + /** + * Handles client/trading/customization/storage + * @returns + */ + getSuits(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/trading/customization + * @returns ISuit[] + */ getTraderSuits(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; wearClothing(pmcData: IPmcData, body: IWearClothingRequestData, sessionID: string): IItemEventRouterResponse; buyClothing(pmcData: IPmcData, body: IBuyClothingRequestData, sessionID: string): IItemEventRouterResponse; diff --git a/types/callbacks/DataCallbacks.d.ts b/types/callbacks/DataCallbacks.d.ts index cfb1c16..1f359e5 100644 --- a/types/callbacks/DataCallbacks.d.ts +++ b/types/callbacks/DataCallbacks.d.ts @@ -1,32 +1,59 @@ import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IGlobals } from "../models/eft/common/IGlobals"; import { ICustomizationItem } from "../models/eft/common/tables/ICustomizationItem"; +import { IHandbookBase } from "../models/eft/common/tables/IHandbookBase"; import { IQuest } from "../models/eft/common/tables/IQuest"; import { IHideoutArea } from "../models/eft/hideout/IHideoutArea"; import { IHideoutProduction } from "../models/eft/hideout/IHideoutProduction"; import { IHideoutScavCase } from "../models/eft/hideout/IHideoutScavCase"; import { IHideoutSettingsBase } from "../models/eft/hideout/IHideoutSettingsBase"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; -import { ILanguageBase } from "../models/spt/server/ILocaleBase"; import { ISettingsBase } from "../models/spt/server/ISettingsBase"; import { DatabaseServer } from "../servers/DatabaseServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +/** + * Handle client requests + */ export declare class DataCallbacks { protected httpResponse: HttpResponseUtil; protected databaseServer: DatabaseServer; constructor(httpResponse: HttpResponseUtil, databaseServer: DatabaseServer); + /** + * Handles client/settings + * @returns ISettingsBase + */ getSettings(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/globals + * @returns IGlobals + */ getGlobals(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/items + * @returns string + */ getTemplateItems(url: string, info: IEmptyRequestData, sessionID: string): string; - getTemplateHandbook(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/handbook/templates + * @returns IHandbookBase + */ + getTemplateHandbook(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/customization + * @returns Record>; + /** + * Handles client/account/customization + * @returns string[] + */ getTemplateCharacter(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getTemplateQuests(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getHideoutSettings(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getHideoutAreas(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; gethideoutProduction(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getHideoutScavcase(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - getLocalesLanguages(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - getLocalesMenu(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + getLocalesLanguages(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData>; + getLocalesMenu(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getLocalesGlobal(url: string, info: IEmptyRequestData, sessionID: string): string; } diff --git a/types/callbacks/DialogueCallbacks.d.ts b/types/callbacks/DialogueCallbacks.d.ts index 634f90b..862c029 100644 --- a/types/callbacks/DialogueCallbacks.d.ts +++ b/types/callbacks/DialogueCallbacks.d.ts @@ -1,6 +1,7 @@ import { DialogueController } from "../controllers/DialogueController"; import { OnUpdate } from "../di/OnUpdate"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; +import { IChatServer } from "../models/eft/dialog/IChatServer"; import { IFriendRequestData } from "../models/eft/dialog/IFriendRequestData"; import { IGetAllAttachmentsRequestData } from "../models/eft/dialog/IGetAllAttachmentsRequestData"; import { IGetAllAttachmentsResponse } from "../models/eft/dialog/IGetAllAttachmentsResponse"; @@ -26,20 +27,32 @@ export declare class DialogueCallbacks extends OnUpdate { protected httpResponse: HttpResponseUtil; protected dialogueController: DialogueController; constructor(hashUtil: HashUtil, timeUtil: TimeUtil, httpResponse: HttpResponseUtil, dialogueController: DialogueController); + /** + * Handles client/friend/list + * @returns IGetFriendListDataResponse + */ getFriendList(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - getChatServerList(url: string, info: IGetChatServerListRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/chatServer/list + * @returns + */ + getChatServerList(url: string, info: IGetChatServerListRequestData, sessionID: string): IGetBodyResponseData; getMailDialogList(url: string, info: IGetMailDialogListRequestData, sessionID: string): IGetBodyResponseData; getMailDialogView(url: string, info: IGetMailDialogViewRequestData, sessionID: string): IGetBodyResponseData; - getMailDialogInfo(url: string, info: IGetMailDialogInfoRequestData, sessionID: string): IGetBodyResponseData; + getMailDialogInfo(url: string, info: IGetMailDialogInfoRequestData, sessionID: string): IGetBodyResponseData; removeDialog(url: string, info: IRemoveDialogRequestData, sessionID: string): IGetBodyResponseData; pinDialog(url: string, info: IPinDialogRequestData, sessionID: string): IGetBodyResponseData; unpinDialog(url: string, info: IPinDialogRequestData, sessionID: string): IGetBodyResponseData; setRead(url: string, info: ISetDialogReadRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handles client/mail/dialog/getAllAttachments + * @returns IGetAllAttachmentsResponse + */ getAllAttachments(url: string, info: IGetAllAttachmentsRequestData, sessionID: string): IGetBodyResponseData; listOutbox(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; listInbox(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; friendRequest(url: string, request: IFriendRequestData, sessionID: string): INullResponseData; sendMessage(url: string, request: ISendMessageRequest, sessionID: string): IGetBodyResponseData; - onUpdate(timeSinceLastRun: number): boolean; + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/callbacks/GameCallbacks.d.ts b/types/callbacks/GameCallbacks.d.ts index 06da1b5..3a6b7e6 100644 --- a/types/callbacks/GameCallbacks.d.ts +++ b/types/callbacks/GameCallbacks.d.ts @@ -1,8 +1,13 @@ import { GameController } from "../controllers/GameController"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; +import { ICheckVersionResponse } from "../models/eft/game/ICheckVersionResponse"; import { IGameConfigResponse } from "../models/eft/game/IGameConfigResponse"; import { IGameEmptyCrcRequestData } from "../models/eft/game/IGameEmptyCrcRequestData"; +import { IGameKeepAliveResponse } from "../models/eft/game/IGameKeepAliveResponse"; +import { IGameLogoutResponseData } from "../models/eft/game/IGameLogoutResponseData"; +import { IGameStartResponse } from "../models/eft/game/IGameStartResponse"; import { IReportNicknameRequestData } from "../models/eft/game/IReportNicknameRequestData"; +import { IServerDetails } from "../models/eft/game/IServerDetails"; import { IVersionValidateRequestData } from "../models/eft/game/IVersionValidateRequestData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { INullResponseData } from "../models/eft/httpResponse/INullResponseData"; @@ -13,13 +18,37 @@ declare class GameCallbacks { protected watermark: Watermark; protected gameController: GameController; constructor(httpResponse: HttpResponseUtil, watermark: Watermark, gameController: GameController); + /** + * Handle client/game/version/validate + * @returns INullResponseData + */ versionValidate(url: string, info: IVersionValidateRequestData, sessionID: string): INullResponseData; - gameStart(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - gameLogout(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/game/start + * @returns IGameStartResponse + */ + gameStart(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/game/logout + * @returns IGameLogoutResponseData + */ + gameLogout(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/game/config + * @returns IGameConfigResponse + */ getGameConfig(url: string, info: IGameEmptyCrcRequestData, sessionID: string): IGetBodyResponseData; - getServer(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - validateGameVersion(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - gameKeepalive(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + getServer(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + validateGameVersion(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/game/keepalive + * @returns IGameKeepAliveResponse + */ + gameKeepalive(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle singleplayer/settings/version + * @returns string + */ getVersion(url: string, info: IEmptyRequestData, sessionID: string): string; reportNickname(url: string, info: IReportNicknameRequestData, sessionID: string): INullResponseData; } diff --git a/types/callbacks/HandbookCallbacks.d.ts b/types/callbacks/HandbookCallbacks.d.ts index 891e375..1bb6241 100644 --- a/types/callbacks/HandbookCallbacks.d.ts +++ b/types/callbacks/HandbookCallbacks.d.ts @@ -3,6 +3,6 @@ import { OnLoad } from "../di/OnLoad"; export declare class HandbookCallbacks extends OnLoad { protected handbookController: HandbookController; constructor(handbookController: HandbookController); - onLoad(): void; + onLoad(): Promise; getRoute(): string; } diff --git a/types/callbacks/HealthCallbacks.d.ts b/types/callbacks/HealthCallbacks.d.ts index 8672be7..7edf03e 100644 --- a/types/callbacks/HealthCallbacks.d.ts +++ b/types/callbacks/HealthCallbacks.d.ts @@ -21,7 +21,19 @@ export declare class HealthCallbacks { * @returns empty response, no data sent back to client */ syncHealth(url: string, info: ISyncHealthRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle Eat + * @returns IItemEventRouterResponse + */ offraidEat(pmcData: IPmcData, body: IOffraidEatRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle Heal + * @returns IItemEventRouterResponse + */ offraidHeal(pmcData: IPmcData, body: IOffraidHealRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle RestoreHealth + * @returns IItemEventRouterResponse + */ healthTreatment(pmcData: IPmcData, info: IHealthTreatmentRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/callbacks/HideoutCallbacks.d.ts b/types/callbacks/HideoutCallbacks.d.ts index 99ab4c9..56450a9 100644 --- a/types/callbacks/HideoutCallbacks.d.ts +++ b/types/callbacks/HideoutCallbacks.d.ts @@ -19,15 +19,78 @@ export declare class HideoutCallbacks extends OnUpdate { protected hideoutConfig: IHideoutConfig; constructor(hideoutController: HideoutController, // TODO: delay needed configServer: ConfigServer); + /** + * Handle HideoutUpgrade + * @param pmcData + * @param body + * @param sessionID + * @returns + */ upgrade(pmcData: IPmcData, body: IHideoutUpgradeRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutUpgradeComplete + * @param pmcData + * @param body + * @param sessionID + * @returns + */ upgradeComplete(pmcData: IPmcData, body: IHideoutUpgradeCompleteRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutPutItemsInAreaSlots + * @param pmcData + * @param body + * @param sessionID + * @returns + */ putItemsInAreaSlots(pmcData: IPmcData, body: IHideoutPutItemInRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutTakeItemsFromAreaSlots + * @param pmcData + * @param body + * @param sessionID + * @returns + */ takeItemsFromAreaSlots(pmcData: IPmcData, body: IHideoutTakeItemOutRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutToggleArea + * @param pmcData + * @param body + * @param sessionID + * @returns + */ toggleArea(pmcData: IPmcData, body: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutSingleProductionStart + * @param pmcData + * @param body + * @param sessionID + * @returns + */ singleProductionStart(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutScavCaseProductionStart + * @param pmcData + * @param body + * @param sessionID + * @returns + */ scavCaseProductionStart(pmcData: IPmcData, body: IHideoutScavCaseStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutContinuousProductionStart + * @param pmcData + * @param body + * @param sessionID + * @returns + */ continuousProductionStart(pmcData: IPmcData, body: IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutTakeProduction + * @param pmcData + * @param body + * @param sessionID + * @returns + */ takeProduction(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; - onUpdate(timeSinceLastRun: number): boolean; + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/callbacks/HttpCallbacks.d.ts b/types/callbacks/HttpCallbacks.d.ts index 94c97bd..299a32c 100644 --- a/types/callbacks/HttpCallbacks.d.ts +++ b/types/callbacks/HttpCallbacks.d.ts @@ -1,9 +1,9 @@ import { OnLoad } from "../di/OnLoad"; -import { IHttpServer } from "../models/spt/server/IHttpServer"; +import { HttpServer } from "../servers/HttpServer"; export declare class HttpCallbacks extends OnLoad { - protected httpServer: IHttpServer; - constructor(httpServer: IHttpServer); - onLoad(): void; + protected httpServer: HttpServer; + constructor(httpServer: HttpServer); + onLoad(): Promise; getRoute(): string; getImage(): string; } diff --git a/types/callbacks/InraidCallbacks.d.ts b/types/callbacks/InraidCallbacks.d.ts index 05bcce4..918bfaf 100644 --- a/types/callbacks/InraidCallbacks.d.ts +++ b/types/callbacks/InraidCallbacks.d.ts @@ -1,23 +1,49 @@ import { InraidController } from "../controllers/InraidController"; -import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { INullResponseData } from "../models/eft/httpResponse/INullResponseData"; import { IRegisterPlayerRequestData } from "../models/eft/inRaid/IRegisterPlayerRequestData"; import { ISaveProgressRequestData } from "../models/eft/inRaid/ISaveProgressRequestData"; -import { IAirdropConfig } from "../models/spt/config/IAirdropConfig"; -import { IInRaidConfig } from "../models/spt/config/IInRaidConfig"; -import { ConfigServer } from "../servers/ConfigServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +/** + * Handle client requests + */ export declare class InraidCallbacks { protected inraidController: InraidController; protected httpResponse: HttpResponseUtil; - protected configServer: ConfigServer; - protected airdropConfig: IAirdropConfig; - protected inraidConfig: IInRaidConfig; - constructor(inraidController: InraidController, httpResponse: HttpResponseUtil, configServer: ConfigServer); + constructor(inraidController: InraidController, httpResponse: HttpResponseUtil); + /** + * Handle client/location/getLocalloot + * @param url + * @param info register player request + * @param sessionID Session id + * @returns Null http response + */ registerPlayer(url: string, info: IRegisterPlayerRequestData, sessionID: string): INullResponseData; + /** + * Handle raid/profile/save + * @param url + * @param info Save progress request + * @param sessionID Session id + * @returns Null http response + */ saveProgress(url: string, info: ISaveProgressRequestData, sessionID: string): INullResponseData; + /** + * Handle singleplayer/settings/raid/endstate + * @returns + */ getRaidEndState(): string; - getRaidMenuSettings(url: string, info: IEmptyRequestData, sessionID: string): string; - getWeaponDurability(url: string, info: any, sessionID: string): string; - getAirdropConfig(url: string, info: any, sessionID: string): string; + /** + * Handle singleplayer/settings/raid/menu + * @returns JSON as string + */ + getRaidMenuSettings(): string; + /** + * Handle singleplayer/settings/weapon/durability + * @returns + */ + getWeaponDurability(): string; + /** + * Handle singleplayer/airdrop/config + * @returns JSON as string + */ + getAirdropConfig(): string; } diff --git a/types/callbacks/InsuranceCallbacks.d.ts b/types/callbacks/InsuranceCallbacks.d.ts index 8835ba2..11aef4a 100644 --- a/types/callbacks/InsuranceCallbacks.d.ts +++ b/types/callbacks/InsuranceCallbacks.d.ts @@ -17,8 +17,16 @@ export declare class InsuranceCallbacks extends OnUpdate { protected configServer: ConfigServer; protected insuranceConfig: IInsuranceConfig; constructor(insuranceController: InsuranceController, insuranceService: InsuranceService, httpResponse: HttpResponseUtil, configServer: ConfigServer); + /** + * Handle client/insurance/items/list/cost + * @returns IGetInsuranceCostResponseData + */ getInsuranceCost(url: string, info: IGetInsuranceCostRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle Insure + * @returns IItemEventRouterResponse + */ insure(pmcData: IPmcData, body: IInsureRequestData, sessionID: string): IItemEventRouterResponse; - onUpdate(secondsSinceLastRun: number): boolean; + onUpdate(secondsSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/callbacks/InventoryCallbacks.d.ts b/types/callbacks/InventoryCallbacks.d.ts index 9ab1486..46bf6fd 100644 --- a/types/callbacks/InventoryCallbacks.d.ts +++ b/types/callbacks/InventoryCallbacks.d.ts @@ -16,6 +16,7 @@ import { IInventorySwapRequestData } from "../models/eft/inventory/IInventorySwa import { IInventoryTagRequestData } from "../models/eft/inventory/IInventoryTagRequestData"; import { IInventoryToggleRequestData } from "../models/eft/inventory/IInventoryToggleRequestData"; import { IInventoryTransferRequestData } from "../models/eft/inventory/IInventoryTransferRequestData"; +import { IOpenRandomLootContainerRequestData } from "../models/eft/inventory/IOpenRandomLootContainerRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; export declare class InventoryCallbacks { protected inventoryController: InventoryController; @@ -36,4 +37,5 @@ export declare class InventoryCallbacks { createMapMarker(pmcData: IPmcData, body: IInventoryCreateMarkerRequestData, sessionID: string): IItemEventRouterResponse; deleteMapMarker(pmcData: IPmcData, body: IInventoryDeleteMarkerRequestData, sessionID: string): IItemEventRouterResponse; editMapMarker(pmcData: IPmcData, body: IInventoryEditMarkerRequestData, sessionID: string): IItemEventRouterResponse; + openRandomLootContainer(pmcData: IPmcData, body: IOpenRandomLootContainerRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/callbacks/ItemEventCallbacks.d.ts b/types/callbacks/ItemEventCallbacks.d.ts index f4f04f9..fbb0b5f 100644 --- a/types/callbacks/ItemEventCallbacks.d.ts +++ b/types/callbacks/ItemEventCallbacks.d.ts @@ -1,4 +1,5 @@ import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; +import { Warning } from "../models/eft/itemEvent/IItemEventRouterBase"; import { IItemEventRouterRequest } from "../models/eft/itemEvent/IItemEventRouterRequest"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { ItemEventRouter } from "../routers/ItemEventRouter"; @@ -8,4 +9,5 @@ export declare class ItemEventCallbacks { protected itemEventRouter: ItemEventRouter; constructor(httpResponse: HttpResponseUtil, itemEventRouter: ItemEventRouter); handleEvents(url: string, info: IItemEventRouterRequest, sessionID: string): IGetBodyResponseData; + protected getErrorCode(warnings: Warning[]): number; } diff --git a/types/callbacks/MatchCallbacks.d.ts b/types/callbacks/MatchCallbacks.d.ts index 2a92ef5..10fbc44 100644 --- a/types/callbacks/MatchCallbacks.d.ts +++ b/types/callbacks/MatchCallbacks.d.ts @@ -34,6 +34,10 @@ export declare class MatchCallbacks { serverAvailable(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData | IGetBodyResponseData; joinMatch(url: string, info: IJoinMatchRequestData, sessionID: string): IGetBodyResponseData; getMetrics(url: string, info: any, sessionID: string): IGetBodyResponseData; + /** + * Handle client/match/group/status + * @returns + */ getGroupStatus(url: string, info: IGetGroupStatusRequestData, sessionID: string): IGetBodyResponseData; createGroup(url: string, info: ICreateGroupRequestData, sessionID: string): IGetBodyResponseData; deleteGroup(url: string, info: any, sessionID: string): INullResponseData; diff --git a/types/callbacks/ModCallbacks.d.ts b/types/callbacks/ModCallbacks.d.ts index 58342dc..9ebb750 100644 --- a/types/callbacks/ModCallbacks.d.ts +++ b/types/callbacks/ModCallbacks.d.ts @@ -1,19 +1,21 @@ import { OnLoad } from "../di/OnLoad"; import { PostAkiModLoader } from "../loaders/PostAkiModLoader"; import { IHttpConfig } from "../models/spt/config/IHttpConfig"; -import { IHttpServer } from "../models/spt/server/IHttpServer"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; +import { LocalisationService } from "../services/LocalisationService"; +import { HttpFileUtil } from "../utils/HttpFileUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; declare class ModCallbacks extends OnLoad { protected logger: ILogger; protected httpResponse: HttpResponseUtil; - protected httpServer: IHttpServer; + protected httpFileUtil: HttpFileUtil; protected postAkiModLoader: PostAkiModLoader; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected httpConfig: IHttpConfig; - constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpServer: IHttpServer, postAkiModLoader: PostAkiModLoader, configServer: ConfigServer); - onLoad(): void; + constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpFileUtil: HttpFileUtil, postAkiModLoader: PostAkiModLoader, localisationService: LocalisationService, configServer: ConfigServer); + onLoad(): Promise; getRoute(): string; sendBundle(sessionID: string, req: any, resp: any, body: any): void; getBundles(url: string, info: any, sessionID: string): string; diff --git a/types/callbacks/NotifierCallbacks.d.ts b/types/callbacks/NotifierCallbacks.d.ts index c42058f..fab325b 100644 --- a/types/callbacks/NotifierCallbacks.d.ts +++ b/types/callbacks/NotifierCallbacks.d.ts @@ -4,6 +4,7 @@ import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { INotifierChannel } from "../models/eft/notifier/INotifier"; import { ISelectProfileRequestData } from "../models/eft/notifier/ISelectProfileRequestData"; +import { ISelectProfileResponse } from "../models/eft/notifier/ISelectProfileResponse"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; export declare class NotifierCallbacks { protected httpServerHelper: HttpServerHelper; @@ -19,6 +20,10 @@ export declare class NotifierCallbacks { sendNotification(sessionID: string, req: any, resp: any, data: any): void; getNotifier(url: string, info: any, sessionID: string): IGetBodyResponseData; createNotifierChannel(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - selectProfile(url: string, info: ISelectProfileRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/game/profile/select + * @returns ISelectProfileResponse + */ + selectProfile(url: string, info: ISelectProfileRequestData, sessionID: string): IGetBodyResponseData; notify(url: string, info: any, sessionID: string): string; } diff --git a/types/callbacks/PresetCallbacks.d.ts b/types/callbacks/PresetCallbacks.d.ts index 4553f8f..681bb99 100644 --- a/types/callbacks/PresetCallbacks.d.ts +++ b/types/callbacks/PresetCallbacks.d.ts @@ -3,6 +3,6 @@ import { OnLoad } from "../di/OnLoad"; export declare class PresetCallbacks extends OnLoad { protected presetController: PresetController; constructor(presetController: PresetController); - onLoad(): void; + onLoad(): Promise; getRoute(): string; } diff --git a/types/callbacks/QuestCallbacks.d.ts b/types/callbacks/QuestCallbacks.d.ts index 559c29e..2a3eb20 100644 --- a/types/callbacks/QuestCallbacks.d.ts +++ b/types/callbacks/QuestCallbacks.d.ts @@ -21,6 +21,13 @@ export declare class QuestCallbacks { acceptQuest(pmcData: IPmcData, body: IAcceptQuestRequestData, sessionID: string): IItemEventRouterResponse; completeQuest(pmcData: IPmcData, body: ICompleteQuestRequestData, sessionID: string): IItemEventRouterResponse; handoverQuest(pmcData: IPmcData, body: IHandoverQuestRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle client/quest/list + * @param url + * @param info + * @param sessionID + * @returns + */ listQuests(url: string, info: IListQuestsRequestData, sessionID: string): IGetBodyResponseData; activityPeriods(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; } diff --git a/types/callbacks/RagfairCallbacks.d.ts b/types/callbacks/RagfairCallbacks.d.ts index c609f2f..15597bf 100644 --- a/types/callbacks/RagfairCallbacks.d.ts +++ b/types/callbacks/RagfairCallbacks.d.ts @@ -14,7 +14,6 @@ import { IRemoveOfferRequestData } from "../models/eft/ragfair/IRemoveOfferReque import { ISearchRequestData } from "../models/eft/ragfair/ISearchRequestData"; import { ISendRagfairReportRequestData } from "../models/eft/ragfair/ISendRagfairReportRequestData"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; -import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { RagfairServer } from "../servers/RagfairServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; @@ -24,21 +23,20 @@ import { JsonUtil } from "../utils/JsonUtil"; */ export declare class RagfairCallbacks extends OnLoadOnUpdate { protected httpResponse: HttpResponseUtil; - protected logger: ILogger; protected jsonUtil: JsonUtil; protected ragfairServer: RagfairServer; protected ragfairController: RagfairController; protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; - constructor(httpResponse: HttpResponseUtil, logger: ILogger, jsonUtil: JsonUtil, ragfairServer: RagfairServer, ragfairController: RagfairController, configServer: ConfigServer); - onLoad(): void; + constructor(httpResponse: HttpResponseUtil, jsonUtil: JsonUtil, ragfairServer: RagfairServer, ragfairController: RagfairController, configServer: ConfigServer); + onLoad(): Promise; getRoute(): string; search(url: string, info: ISearchRequestData, sessionID: string): IGetBodyResponseData; getMarketPrice(url: string, info: IGetMarketPriceRequestData, sessionID: string): IGetBodyResponseData; - getItemPrices(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + getItemPrices(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData>; addOffer(pmcData: IPmcData, info: IAddOfferRequestData, sessionID: string): IItemEventRouterResponse; removeOffer(pmcData: IPmcData, info: IRemoveOfferRequestData, sessionID: string): IItemEventRouterResponse; extendOffer(pmcData: IPmcData, info: IExtendOfferRequestData, sessionID: string): IItemEventRouterResponse; - onUpdate(timeSinceLastRun: number): boolean; + onUpdate(timeSinceLastRun: number): Promise; sendReport(url: string, info: ISendRagfairReportRequestData, sessionID: string): INullResponseData; } diff --git a/types/callbacks/RepairCallbacks.d.ts b/types/callbacks/RepairCallbacks.d.ts index 63733fa..14edeeb 100644 --- a/types/callbacks/RepairCallbacks.d.ts +++ b/types/callbacks/RepairCallbacks.d.ts @@ -6,6 +6,20 @@ import { ITraderRepairActionDataRequest } from "../models/eft/repair/ITraderRepa export declare class RepairCallbacks { protected repairController: RepairController; constructor(repairController: RepairController); + /** + * use trader to repair item + * @param pmcData + * @param body + * @param sessionID + * @returns + */ traderRepair(pmcData: IPmcData, body: ITraderRepairActionDataRequest, sessionID: string): IItemEventRouterResponse; + /** + * Use repair kit to repair item + * @param pmcData + * @param body + * @param sessionID + * @returns + */ repair(pmcData: IPmcData, body: IRepairActionDataRequest, sessionID: string): IItemEventRouterResponse; } diff --git a/types/callbacks/SaveCallbacks.d.ts b/types/callbacks/SaveCallbacks.d.ts index bbb6e53..ab29ddc 100644 --- a/types/callbacks/SaveCallbacks.d.ts +++ b/types/callbacks/SaveCallbacks.d.ts @@ -3,7 +3,7 @@ import { SaveServer } from "../servers/SaveServer"; export declare class SaveCallbacks extends OnLoadOnUpdate { protected saveServer: SaveServer; constructor(saveServer: SaveServer); - onLoad(): void; + onLoad(): Promise; getRoute(): string; - onUpdate(secondsSinceLastRun: number): boolean; + onUpdate(secondsSinceLastRun: number): Promise; } diff --git a/types/callbacks/TraderCallbacks.d.ts b/types/callbacks/TraderCallbacks.d.ts index e4fd099..1efde87 100644 --- a/types/callbacks/TraderCallbacks.d.ts +++ b/types/callbacks/TraderCallbacks.d.ts @@ -8,10 +8,14 @@ export declare class TraderCallbacks extends OnLoadOnUpdate { protected httpResponse: HttpResponseUtil; protected traderController: TraderController; constructor(httpResponse: HttpResponseUtil, traderController: TraderController); - onLoad(): void; - onUpdate(): boolean; + onLoad(): Promise; + onUpdate(): Promise; getRoute(): string; getTraderSettings(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/trading/api/getUserAssortPrice/trader + * @returns + */ getProfilePurchases(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData>; getTrader(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getAssort(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; diff --git a/types/callbacks/WeatherCallbacks.d.ts b/types/callbacks/WeatherCallbacks.d.ts index ae784c8..f9d2002 100644 --- a/types/callbacks/WeatherCallbacks.d.ts +++ b/types/callbacks/WeatherCallbacks.d.ts @@ -1,10 +1,15 @@ import { WeatherController } from "../controllers/WeatherController"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; +import { IWeatherData } from "../models/eft/weather/IWeatherData"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; export declare class WeatherCallbacks { protected httpResponse: HttpResponseUtil; protected weatherController: WeatherController; constructor(httpResponse: HttpResponseUtil, weatherController: WeatherController); - getWeather(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + /** + * Handle client/weather + * @returns IWeatherData + */ + getWeather(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; } diff --git a/types/context/ApplicationContext.d.ts b/types/context/ApplicationContext.d.ts index a155bcd..28bbdf7 100644 --- a/types/context/ApplicationContext.d.ts +++ b/types/context/ApplicationContext.d.ts @@ -3,6 +3,15 @@ import { ContextVariableType } from "./ContextVariableType"; export declare class ApplicationContext { private variables; private static holderMaxSize; + /** + * Called like: + * + * const registerPlayerInfo = this.applicationContext.getLatestValue(ContextVariableType.REGISTER_PLAYER_REQUEST).getValue(); + * + * const matchInfo = this.applicationContext.getLatestValue(ContextVariableType.MATCH_INFO).getValue(); + * @param type + * @returns + */ getLatestValue(type: ContextVariableType): ContextVariable; getValues(type: ContextVariableType): ContextVariable[]; addValue(type: ContextVariableType, value: any): void; diff --git a/types/context/ContextVariableType.d.ts b/types/context/ContextVariableType.d.ts index 5fc1704..fa5390f 100644 --- a/types/context/ContextVariableType.d.ts +++ b/types/context/ContextVariableType.d.ts @@ -1,4 +1,10 @@ export declare enum ContextVariableType { + /** Logged in users session id */ SESSION_ID = 0, - MATCH_INFO = 1 + /** Currently acive raid information */ + MATCH_INFO = 1, + /** Timestamp when client first connected */ + CLIENT_START_TIMESTAMP = 2, + /** When player is loading into map and loot is requested */ + REGISTER_PLAYER_REQUEST = 3 } diff --git a/types/controllers/BotController.d.ts b/types/controllers/BotController.d.ts index d6a8ae4..a80aaed 100644 --- a/types/controllers/BotController.d.ts +++ b/types/controllers/BotController.d.ts @@ -1,5 +1,9 @@ +import { ApplicationContext } from "../context/ApplicationContext"; import { BotGenerator } from "../generators/BotGenerator"; +import { BotDifficultyHelper } from "../helpers/BotDifficultyHelper"; import { BotHelper } from "../helpers/BotHelper"; +import { ProfileHelper } from "../helpers/ProfileHelper"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { IGenerateBotsRequestData } from "../models/eft/bot/IGenerateBotsRequestData"; import { IBotBase } from "../models/eft/common/tables/IBotBase"; import { IBotCore } from "../models/eft/common/tables/IBotCore"; @@ -9,23 +13,34 @@ 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"; +import { LocalisationService } from "../services/LocalisationService"; +import { JsonUtil } from "../utils/JsonUtil"; export declare class BotController { protected logger: ILogger; protected databaseServer: DatabaseServer; protected botGenerator: BotGenerator; protected botHelper: BotHelper; - protected pmcAiService: PmcAiService; + protected botDifficultyHelper: BotDifficultyHelper; protected botGenerationCacheService: BotGenerationCacheService; + protected localisationService: LocalisationService; + protected weightedRandomHelper: WeightedRandomHelper; + protected profileHelper: ProfileHelper; protected configServer: ConfigServer; + protected applicationContext: ApplicationContext; + protected jsonUtil: JsonUtil; protected botConfig: IBotConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, pmcAiService: PmcAiService, botGenerationCacheService: BotGenerationCacheService, configServer: ConfigServer); + static readonly pmcTypeLabel = "PMC"; + constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, botGenerationCacheService: BotGenerationCacheService, localisationService: LocalisationService, weightedRandomHelper: WeightedRandomHelper, profileHelper: ProfileHelper, configServer: ConfigServer, applicationContext: ApplicationContext, jsonUtil: JsonUtil); /** * Return the number of bot loadout varieties to be generated * @param type bot Type we want the loadout gen count for - * @returns + * @returns number of bots to generate */ getBotPresetGenerationLimit(type: string): number; + /** + * Get the core.json difficulty settings from database\bots + * @returns IBotCore + */ getBotCoreDifficulty(): IBotCore; /** * Get bot difficulty settings @@ -35,7 +50,24 @@ export declare class BotController { * @returns Difficulty object */ getBotDifficulty(type: string, difficulty: string): Difficulty; - protected getPmcDifficultySettings(pmcType: "bear" | "usec", difficulty: string, usecType: string, bearType: string): Difficulty; + /** + * Generate bot profiles and store in cache + * @param sessionId Session id + * @param info bot generation request info + * @returns IBotBase array + */ generate(sessionId: string, info: IGenerateBotsRequestData): IBotBase[]; + /** + * Get the difficulty passed in, if its not "asoline", get selected difficulty from config + * @param requestedDifficulty + * @returns + */ + getPMCDifficulty(requestedDifficulty: string): string; + /** + * Get the max number of bots allowed on a map + * Looks up location player is entering when getting cap value + * @returns cap number + */ getBotCap(): number; + getPmcBotTypes(): Record>>; } diff --git a/types/controllers/CustomizationController.d.ts b/types/controllers/CustomizationController.d.ts index a6c4730..a4ef8cf 100644 --- a/types/controllers/CustomizationController.d.ts +++ b/types/controllers/CustomizationController.d.ts @@ -5,16 +5,18 @@ import { IBuyClothingRequestData } from "../models/eft/customization/IBuyClothin import { IWearClothingRequestData } from "../models/eft/customization/IWearClothingRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; +import { LocalisationService } from "../services/LocalisationService"; export declare class CustomizationController { protected logger: ILogger; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected saveServer: SaveServer; + protected localisationService: LocalisationService; protected profileHelper: ProfileHelper; - constructor(logger: ILogger, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper); + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, databaseServer: DatabaseServer, saveServer: SaveServer, localisationService: LocalisationService, profileHelper: ProfileHelper); getTraderSuits(traderID: string, sessionID: string): ISuit[]; wearClothing(pmcData: IPmcData, body: IWearClothingRequestData, sessionID: string): IItemEventRouterResponse; buyClothing(pmcData: IPmcData, body: IBuyClothingRequestData, sessionID: string): IItemEventRouterResponse; diff --git a/types/controllers/DialogueController.d.ts b/types/controllers/DialogueController.d.ts index b15c4b6..98d3d52 100644 --- a/types/controllers/DialogueController.d.ts +++ b/types/controllers/DialogueController.d.ts @@ -2,24 +2,78 @@ import { DialogueHelper } from "../helpers/DialogueHelper"; import { IGetAllAttachmentsResponse } from "../models/eft/dialog/IGetAllAttachmentsResponse"; import { IGetFriendListDataResponse } from "../models/eft/dialog/IGetFriendListDataResponse"; import { IGetMailDialogViewResponseData } from "../models/eft/dialog/IGetMailDialogViewResponseData"; -import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { DialogueInfo, Message } from "../models/eft/profile/IAkiProfile"; import { SaveServer } from "../servers/SaveServer"; -import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +import { TimeUtil } from "../utils/TimeUtil"; export declare class DialogueController { - protected httpResponse: HttpResponseUtil; protected saveServer: SaveServer; + protected timeUtil: TimeUtil; protected dialogueHelper: DialogueHelper; - constructor(httpResponse: HttpResponseUtil, saveServer: SaveServer, dialogueHelper: DialogueHelper); + constructor(saveServer: SaveServer, timeUtil: TimeUtil, dialogueHelper: DialogueHelper); + update(): void; getFriendList(sessionID: string): IGetFriendListDataResponse; - generateDialogueList(sessionID: string): IGetBodyResponseData; + /** + * Create array holding trader dialogs and mail interactions with player + * Set the content of the dialogue on the list tab. + * @param sessionID Session Id + * @returns array of dialogs + */ + generateDialogueList(sessionID: string): DialogueInfo[]; + /** + * Get the content of a dialogue + * @param dialogueID Dialog id + * @param sessionID Session Id + * @returns DialogueInfo + */ getDialogueInfo(dialogueID: string, sessionID: string): DialogueInfo; + /** + * Handle player clicking 'messenger' and seeing all the messages they've recieved + * Set the content of the dialogue on the details panel, showing all the messages + * for the specified dialogue. + * @param dialogueID Dialog id + * @param sessionID Session id + * @returns IGetMailDialogViewResponseData object + */ generateDialogueView(dialogueID: string, sessionID: string): IGetMailDialogViewResponseData; + /** + * Get a count of messages with attachments from a particular dialog + * @param sessionID Session id + * @param dialogueID Dialog id + * @returns Count of messages with attachments + */ + protected getUnreadMessagesWithAttachmentsCount(sessionID: string, dialogueID: string): number; + /** + * Does array have messages with uncollected rewards (includes expired rewards) + * @param messages Messages to check + * @returns true if uncollected rewards found + */ + protected messagesHaveUncollectedRewards(messages: Message[]): boolean; removeDialogue(dialogueID: string, sessionID: string): void; setDialoguePin(dialogueID: string, shouldPin: boolean, sessionID: string): void; setRead(dialogueIDs: string[], sessionID: string): void; + /** + * Get all uncollected items attached to mail in a particular dialog + * @param dialogueID Dialog to get mail attachments from + * @param sessionID Session id + * @returns + */ getAllAttachments(dialogueID: string, sessionID: string): IGetAllAttachmentsResponse; - protected messagesHaveUncollectedRewards(messages: Message[]): boolean; + /** + * Get messages from a specific dialog that have items not expired + * @param sessionId Session id + * @param dialogueId Dialog to get mail attachments from + * @returns Message array + */ + protected getActiveMessagesFromDialog(sessionId: string, dialogueId: string): Message[]; + /** + * Return array of messages with uncollected items (includes expired) + * @param messages Messages to parse + * @returns messages with items to collect + */ + protected getMessagesWithAttachments(messages: Message[]): Message[]; + /** + * Delete expired items. triggers when updating traders. + * @param sessionID Session id + */ protected removeExpiredItems(sessionID: string): void; - update(): void; } diff --git a/types/controllers/GameController.d.ts b/types/controllers/GameController.d.ts index d374453..b23ccf7 100644 --- a/types/controllers/GameController.d.ts +++ b/types/controllers/GameController.d.ts @@ -1,29 +1,56 @@ +import { ApplicationContext } from "../context/ApplicationContext"; import { HttpServerHelper } from "../helpers/HttpServerHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; +import { PreAkiModLoader } from "../loaders/PreAkiModLoader"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; +import { IPmcData } from "../models/eft/common/IPmcData"; +import { ICheckVersionResponse } from "../models/eft/game/ICheckVersionResponse"; import { IGameConfigResponse } from "../models/eft/game/IGameConfigResponse"; +import { IServerDetails } from "../models/eft/game/IServerDetails"; import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { ICoreConfig } from "../models/spt/config/ICoreConfig"; import { IHttpConfig } from "../models/spt/config/IHttpConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; -import { LocaleService } from "../services/LocaleService"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { ProfileFixerService } from "../services/ProfileFixerService"; -import { Watermark } from "../utils/Watermark"; +import { SeasonalEventService } from "../services/SeasonalEventService"; export declare class GameController { protected logger: ILogger; - protected watermark: Watermark; + protected databaseServer: DatabaseServer; + protected preAkiModLoader: PreAkiModLoader; protected httpServerHelper: HttpServerHelper; - protected localeService: LocaleService; protected profileHelper: ProfileHelper; protected profileFixerService: ProfileFixerService; + protected localisationService: LocalisationService; + protected seasonalEventService: SeasonalEventService; + protected applicationContext: ApplicationContext; protected configServer: ConfigServer; protected httpConfig: IHttpConfig; protected coreConfig: ICoreConfig; - constructor(logger: ILogger, watermark: Watermark, httpServerHelper: HttpServerHelper, localeService: LocaleService, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, configServer: ConfigServer); - gameStart(_url: string, _info: IEmptyRequestData, sessionID: string): void; + constructor(logger: ILogger, databaseServer: DatabaseServer, preAkiModLoader: PreAkiModLoader, httpServerHelper: HttpServerHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, localisationService: LocalisationService, seasonalEventService: SeasonalEventService, applicationContext: ApplicationContext, configServer: ConfigServer); + gameStart(_url: string, _info: IEmptyRequestData, sessionID: string, startTimeStampMS: number): void; + /** + * Get a list of installed mods and save their details to the profile being used + * @param fullProfile Profile to add mod details to + */ + protected saveActiveModsToProfile(fullProfile: IAkiProfile): void; + /** + * Add the logged in players name to PMC name pool + * @param pmcProfile + */ + protected addPlayerToPMCNames(pmcProfile: IPmcData): void; + /** + * Blank out the "test" mail message from prapor + */ + protected removePraporTestMessage(): void; + /** + * Make non-trigger-spawned raiders spawn earlier + always + */ + protected adjustLabsRaiderSpawnRate(): void; protected logProfileDetails(fullProfile: IAkiProfile): void; getGameConfig(sessionID: string): IGameConfigResponse; - getServer(): any[]; - getValidGameVersion(): any; + getServer(): IServerDetails[]; + getValidGameVersion(): ICheckVersionResponse; } diff --git a/types/controllers/HealthController.d.ts b/types/controllers/HealthController.d.ts index cc13603..86f72e3 100644 --- a/types/controllers/HealthController.d.ts +++ b/types/controllers/HealthController.d.ts @@ -1,23 +1,25 @@ -import { ItemHelper } from "../helpers/ItemHelper"; -import { PaymentService } from "../services/PaymentService"; -import { InventoryHelper } from "../helpers/InventoryHelper"; import { HealthHelper } from "../helpers/HealthHelper"; +import { InventoryHelper } from "../helpers/InventoryHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IHealthTreatmentRequestData } from "../models/eft/health/IHealthTreatmentRequestData"; import { IOffraidEatRequestData } from "../models/eft/health/IOffraidEatRequestData"; import { IOffraidHealRequestData } from "../models/eft/health/IOffraidHealRequestData"; import { ISyncHealthRequestData } from "../models/eft/health/ISyncHealthRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; import { ILogger } from "../models/spt/utils/ILogger"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { LocalisationService } from "../services/LocalisationService"; +import { PaymentService } from "../services/PaymentService"; export declare class HealthController { protected logger: ILogger; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected itemHelper: ItemHelper; protected paymentService: PaymentService; protected inventoryHelper: InventoryHelper; + protected localisationService: LocalisationService; protected healthHelper: HealthHelper; - constructor(logger: ILogger, itemEventRouter: ItemEventRouter, itemHelper: ItemHelper, paymentService: PaymentService, inventoryHelper: InventoryHelper, healthHelper: HealthHelper); + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, itemHelper: ItemHelper, paymentService: PaymentService, inventoryHelper: InventoryHelper, localisationService: LocalisationService, healthHelper: HealthHelper); /** * stores in-raid player health * @param pmcData Player profile @@ -25,7 +27,7 @@ export declare class HealthController { * @param sessionID * @param addEffects Should effects found be added or removed from profile */ - saveVitality(pmcData: IPmcData, info: ISyncHealthRequestData, sessionID: string, addEffects?: boolean): void; + saveVitality(pmcData: IPmcData, info: ISyncHealthRequestData, sessionID: string, addEffects?: boolean, deleteExistingEffects?: boolean): void; /** * When healing in menu * @param pmcData @@ -38,9 +40,16 @@ export declare class HealthController { /** * Occurs on post-raid healing page * @param pmcData player profile - * @param info Request data from client + * @param healthTreatmentRequest Request data from client * @param sessionID Session id * @returns */ - healthTreatment(pmcData: IPmcData, info: IHealthTreatmentRequestData, sessionID: string): IItemEventRouterResponse; + healthTreatment(pmcData: IPmcData, healthTreatmentRequest: IHealthTreatmentRequestData, sessionID: string): IItemEventRouterResponse; + /** + * iterate over treatment request diff and find effects to remove from player limbs + * @param sessionId + * @param profile Profile to update + * @param treatmentRequest client request + */ + protected removeEffectsAfterPostRaidHeal(sessionId: string, profile: IPmcData, treatmentRequest: IHealthTreatmentRequestData): void; } diff --git a/types/controllers/HideoutController.d.ts b/types/controllers/HideoutController.d.ts index dcd8894..5b6507b 100644 --- a/types/controllers/HideoutController.d.ts +++ b/types/controllers/HideoutController.d.ts @@ -19,16 +19,17 @@ import { IHideoutUpgradeRequestData } from "../models/eft/hideout/IHideoutUpgrad import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IHideoutConfig } from "../models/spt/config/IHideoutConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; +import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; -import { JsonUtil } from "../utils/JsonUtil"; export declare class HideoutController { protected logger: ILogger; protected hashUtil: HashUtil; @@ -40,16 +41,17 @@ export declare class HideoutController { protected playerService: PlayerService; protected presetHelper: PresetHelper; protected paymentHelper: PaymentHelper; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected httpResponse: HttpResponseUtil; protected profileHelper: ProfileHelper; protected hideoutHelper: HideoutHelper; protected scavCaseRewardGenerator: ScavCaseRewardGenerator; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected jsonUtil: JsonUtil; protected static nameBackendCountersCrafting: string; protected hideoutConfig: IHideoutConfig; - constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, inventoryHelper: InventoryHelper, saveServer: SaveServer, playerService: PlayerService, presetHelper: PresetHelper, paymentHelper: PaymentHelper, itemEventRouter: ItemEventRouter, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, hideoutHelper: HideoutHelper, scavCaseRewardGenerator: ScavCaseRewardGenerator, configServer: ConfigServer, jsonUtil: JsonUtil); + constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, inventoryHelper: InventoryHelper, saveServer: SaveServer, playerService: PlayerService, presetHelper: PresetHelper, paymentHelper: PaymentHelper, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, hideoutHelper: HideoutHelper, scavCaseRewardGenerator: ScavCaseRewardGenerator, localisationService: LocalisationService, configServer: ConfigServer, jsonUtil: JsonUtil); upgrade(pmcData: IPmcData, body: IHideoutUpgradeRequestData, sessionID: string): IItemEventRouterResponse; upgradeComplete(pmcData: IPmcData, body: HideoutUpgradeCompleteRequestData, sessionID: string): IItemEventRouterResponse; /** diff --git a/types/controllers/InraidController.d.ts b/types/controllers/InraidController.d.ts index 102a2fb..f954eff 100644 --- a/types/controllers/InraidController.d.ts +++ b/types/controllers/InraidController.d.ts @@ -1,3 +1,4 @@ +import { ApplicationContext } from "../context/ApplicationContext"; import { PlayerScavGenerator } from "../generators/PlayerScavGenerator"; import { HealthHelper } from "../helpers/HealthHelper"; import { InRaidHelper } from "../helpers/InRaidHelper"; @@ -6,8 +7,10 @@ import { ProfileHelper } from "../helpers/ProfileHelper"; import { QuestHelper } from "../helpers/QuestHelper"; import { TraderHelper } from "../helpers/TraderHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; +import { Item } from "../models/eft/common/tables/IItem"; import { IRegisterPlayerRequestData } from "../models/eft/inRaid/IRegisterPlayerRequestData"; import { ISaveProgressRequestData } from "../models/eft/inRaid/ISaveProgressRequestData"; +import { IAirdropConfig } from "../models/spt/config/IAirdropConfig"; import { IInRaidConfig } from "../models/spt/config/IInRaidConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; @@ -16,6 +19,9 @@ import { SaveServer } from "../servers/SaveServer"; import { InsuranceService } from "../services/InsuranceService"; import { JsonUtil } from "../utils/JsonUtil"; import { TimeUtil } from "../utils/TimeUtil"; +/** + * Logic for handling In Raid callbacks + */ export declare class InraidController { protected logger: ILogger; protected saveServer: SaveServer; @@ -30,17 +36,47 @@ export declare class InraidController { protected traderHelper: TraderHelper; protected insuranceService: InsuranceService; protected inRaidHelper: InRaidHelper; + protected applicationContext: ApplicationContext; protected configServer: ConfigServer; + protected airdropConfig: IAirdropConfig; protected inraidConfig: IInRaidConfig; - constructor(logger: ILogger, saveServer: SaveServer, jsonUtil: JsonUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, questHelper: QuestHelper, itemHelper: ItemHelper, profileHelper: ProfileHelper, playerScavGenerator: PlayerScavGenerator, healthHelper: HealthHelper, traderHelper: TraderHelper, insuranceService: InsuranceService, inRaidHelper: InRaidHelper, configServer: ConfigServer); - addPlayer(sessionID: string, info: IRegisterPlayerRequestData): void; - saveProgress(offraidData: ISaveProgressRequestData, sessionID: string): void; + constructor(logger: ILogger, saveServer: SaveServer, jsonUtil: JsonUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, questHelper: QuestHelper, itemHelper: ItemHelper, profileHelper: ProfileHelper, playerScavGenerator: PlayerScavGenerator, healthHelper: HealthHelper, traderHelper: TraderHelper, insuranceService: InsuranceService, inRaidHelper: InRaidHelper, applicationContext: ApplicationContext, configServer: ConfigServer); /** - * Handle updating the profile post-pmc raid + * Save locationId to active profiles inraid object AND app context + * @param sessionID Session id + * @param info Register player request + */ + addPlayer(sessionID: string, info: IRegisterPlayerRequestData): void; + /** + * Save profile state to disk + * Handles pmc/pscav + * @param offraidData post-raid request data + * @param sessionID Session id + */ + savePostRaidProgress(offraidData: ISaveProgressRequestData, sessionID: string): void; + /** + * Handle updating player profile post-pmc raid * @param sessionID session id - * @param offraidData post-raid data of raid + * @param offraidData post-raid data */ protected savePmcProgress(sessionID: string, offraidData: ISaveProgressRequestData): void; + /** + * Make changes to pmc profile after they left raid dead, + * alter bodypart hp, handle insurance, delete inventory items, remove carried quest items + * @param postRaidSaveRequest post-raid save request + * @param pmcData pmc profile + * @param insuranceEnabled is insurance enabled + * @param preRaidGear gear player had before raid + * @param sessionID Session id + * @returns Updated profile object + */ + protected performPostRaidActionsWhenDead(postRaidSaveRequest: ISaveProgressRequestData, pmcData: IPmcData, insuranceEnabled: boolean, preRaidGear: Item[], sessionID: string): IPmcData; + /** + * Adjust player characters bodypart hp if they left raid early + * @param postRaidSaveRequest post raid data + * @param pmcData player profile + */ + protected updatePmcHealthPostRaid(postRaidSaveRequest: ISaveProgressRequestData, pmcData: IPmcData): void; /** * Reduce body part hp to % of max * @param pmcData profile to edit @@ -66,6 +102,31 @@ export declare class InraidController { * @param isPlayerScav Was the player a pScav */ protected markOrRemoveFoundInRaidItems(offraidData: ISaveProgressRequestData, pmcData: IPmcData, isPlayerScav: boolean): void; + /** + * Update profile after player completes scav raid + * @param scavData Scav profile + * @param sessionID Session id + * @param offraidData Post-raid save request + * @param pmcData Pmc profile + * @param isDead Is player dead + */ protected handlePostRaidPlayerScavProcess(scavData: IPmcData, sessionID: string, offraidData: ISaveProgressRequestData, pmcData: IPmcData, isDead: boolean): void; + /** + * Update profile with scav karma values based on in-raid actions + * @param pmcData Pmc profile + * @param offraidData Post-raid save request + * @param scavData Scav profile + * @param sessionID Session id + */ protected handlePostRaidPlayerScavKarmaChanges(pmcData: IPmcData, offraidData: ISaveProgressRequestData, scavData: IPmcData, sessionID: string): void; + /** + * Get the inraid config from configs/inraid.json + * @returns InRaid Config + */ + getInraidConfig(): IInRaidConfig; + /** + * Get airdrop config from configs/airdrop.json + * @returns Airdrop config + */ + getAirdropConfig(): IAirdropConfig; } diff --git a/types/controllers/InsuranceController.d.ts b/types/controllers/InsuranceController.d.ts index 6895383..54f31b5 100644 --- a/types/controllers/InsuranceController.d.ts +++ b/types/controllers/InsuranceController.d.ts @@ -8,7 +8,7 @@ import { IInsureRequestData } from "../models/eft/insurance/IInsureRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IInsuranceConfig } from "../models/spt/config/IInsuranceConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; @@ -19,7 +19,7 @@ import { TimeUtil } from "../utils/TimeUtil"; export declare class InsuranceController { protected logger: ILogger; protected randomUtil: RandomUtil; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected timeUtil: TimeUtil; protected saveServer: SaveServer; protected databaseServer: DatabaseServer; @@ -30,8 +30,7 @@ export declare class InsuranceController { protected insuranceService: InsuranceService; protected configServer: ConfigServer; protected insuranceConfig: IInsuranceConfig; - constructor(logger: ILogger, randomUtil: RandomUtil, itemEventRouter: ItemEventRouter, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileHelper: ProfileHelper, dialogueHelper: DialogueHelper, paymentService: PaymentService, // TODO: delay required - insuranceService: InsuranceService, configServer: ConfigServer); + constructor(logger: ILogger, randomUtil: RandomUtil, eventOutputHolder: EventOutputHolder, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileHelper: ProfileHelper, dialogueHelper: DialogueHelper, paymentService: PaymentService, insuranceService: InsuranceService, configServer: ConfigServer); processReturn(): void; insure(pmcData: IPmcData, body: IInsureRequestData, sessionID: string): IItemEventRouterResponse; /** diff --git a/types/controllers/InventoryController.d.ts b/types/controllers/InventoryController.d.ts index f564919..e1c08c0 100644 --- a/types/controllers/InventoryController.d.ts +++ b/types/controllers/InventoryController.d.ts @@ -2,6 +2,7 @@ import { InventoryHelper } from "../helpers/InventoryHelper"; import { PaymentHelper } from "../helpers/PaymentHelper"; import { PresetHelper } from "../helpers/PresetHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IAddItemRequestData } from "../models/eft/inventory/IAddItemRequestData"; import { IInventoryBindRequestData } from "../models/eft/inventory/IInventoryBindRequestData"; @@ -20,34 +21,46 @@ import { IInventorySwapRequestData } from "../models/eft/inventory/IInventorySwa import { IInventoryTagRequestData } from "../models/eft/inventory/IInventoryTagRequestData"; import { IInventoryToggleRequestData } from "../models/eft/inventory/IInventoryToggleRequestData"; import { IInventoryTransferRequestData } from "../models/eft/inventory/IInventoryTransferRequestData"; +import { IOpenRandomLootContainerRequestData } from "../models/eft/inventory/IOpenRandomLootContainerRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { DatabaseServer } from "../servers/DatabaseServer"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { RagfairOfferService } from "../services/RagfairOfferService"; import { HashUtil } from "../utils/HashUtil"; +import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; export declare class InventoryController { protected logger: ILogger; protected hashUtil: HashUtil; protected jsonUtil: JsonUtil; + protected randomUtil: RandomUtil; protected databaseServer: DatabaseServer; protected fenceService: FenceService; protected presetHelper: PresetHelper; protected inventoryHelper: InventoryHelper; protected ragfairOfferService: RagfairOfferService; protected profileHelper: ProfileHelper; + protected weightedRandomHelper: WeightedRandomHelper; protected paymentHelper: PaymentHelper; - protected itemEventRouter: ItemEventRouter; - constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, fenceService: FenceService, presetHelper: PresetHelper, inventoryHelper: InventoryHelper, ragfairOfferService: RagfairOfferService, profileHelper: ProfileHelper, paymentHelper: PaymentHelper, itemEventRouter: ItemEventRouter); + protected localisationService: LocalisationService; + protected eventOutputHolder: EventOutputHolder; + protected httpResponseUtil: HttpResponseUtil; + constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, fenceService: FenceService, presetHelper: PresetHelper, inventoryHelper: InventoryHelper, ragfairOfferService: RagfairOfferService, profileHelper: ProfileHelper, weightedRandomHelper: WeightedRandomHelper, paymentHelper: PaymentHelper, localisationService: LocalisationService, eventOutputHolder: EventOutputHolder, httpResponseUtil: HttpResponseUtil); /** * Move Item * change location of item with parentId and slotId * transfers items from one profile to another if fromOwner/toOwner is set in the body. * otherwise, move is contained within the same profile_f. - */ - moveItem(pmcData: IPmcData, body: IInventoryMoveRequestData, sessionID: string): IItemEventRouterResponse; + * @param pmcData Profile + * @param moveRequest Move request data + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + moveItem(pmcData: IPmcData, moveRequest: IInventoryMoveRequestData, sessionID: string): IItemEventRouterResponse; /** * Remove Item from Profile * Deep tree item deletion, also removes items from insurance list @@ -122,4 +135,12 @@ export declare class InventoryController { createMapMarker(pmcData: IPmcData, body: IInventoryCreateMarkerRequestData, sessionID: string): IItemEventRouterResponse; deleteMapMarker(pmcData: IPmcData, body: IInventoryDeleteMarkerRequestData, sessionID: string): IItemEventRouterResponse; editMapMarker(pmcData: IPmcData, body: IInventoryEditMarkerRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle event fired when a container is unpacked (currently only the halloween pumpkin) + * @param pmcData Profile data + * @param body open loot container request data + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + openRandomLootContainer(pmcData: IPmcData, body: IOpenRandomLootContainerRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/controllers/LocationController.d.ts b/types/controllers/LocationController.d.ts index 9db3205..b6feba8 100644 --- a/types/controllers/LocationController.d.ts +++ b/types/controllers/LocationController.d.ts @@ -7,6 +7,7 @@ import { LootItem } from "../models/spt/services/LootItem"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { TimeUtil } from "../utils/TimeUtil"; @@ -15,12 +16,13 @@ export declare class LocationController { protected hashUtil: HashUtil; protected logger: ILogger; protected locationGenerator: LocationGenerator; + protected localisationService: LocalisationService; protected lootGenerator: LootGenerator; protected databaseServer: DatabaseServer; protected timeUtil: TimeUtil; protected configServer: ConfigServer; protected airdropConfig: IAirdropConfig; - constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, logger: ILogger, locationGenerator: LocationGenerator, lootGenerator: LootGenerator, databaseServer: DatabaseServer, timeUtil: TimeUtil, configServer: ConfigServer); + constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, logger: ILogger, locationGenerator: LocationGenerator, localisationService: LocalisationService, lootGenerator: LootGenerator, databaseServer: DatabaseServer, timeUtil: TimeUtil, configServer: ConfigServer); get(location: string): ILocationBase; generate(name: string): ILocationBase; generateAll(): ILocationsGenerateAllResponse; diff --git a/types/controllers/MatchController.d.ts b/types/controllers/MatchController.d.ts index 07f6a89..2c78405 100644 --- a/types/controllers/MatchController.d.ts +++ b/types/controllers/MatchController.d.ts @@ -9,6 +9,7 @@ import { IGetProfileRequestData } from "../models/eft/match/IGetProfileRequestDa import { IJoinMatchRequestData } from "../models/eft/match/IJoinMatchRequestData"; import { IJoinMatchResult } from "../models/eft/match/IJoinMatchResult"; import { IStartOfflineRaidRequestData } from "../models/eft/match/IStartOffineRaidRequestData"; +import { BotDifficulty } from "../models/enums/BotDifficulty"; import { IBotConfig } from "../models/spt/config/IBotConfig"; import { IInRaidConfig } from "../models/spt/config/IInRaidConfig"; import { IMatchConfig } from "../models/spt/config/IMatchConfig"; @@ -17,8 +18,9 @@ import { ConfigServer } from "../servers/ConfigServer"; import { SaveServer } from "../servers/SaveServer"; import { BotGenerationCacheService } from "../services/BotGenerationCacheService"; import { BotLootCacheService } from "../services/BotLootCacheService"; +import { CustomLocationWaveService } from "../services/CustomLocationWaveService"; import { MatchLocationService } from "../services/MatchLocationService"; -import { PmcAiService } from "../services/PmcAiService"; +import { OpenZoneService } from "../services/OpenZoneService"; import { ProfileSnapshotService } from "../services/ProfileSnapshotService"; export declare class MatchController { protected logger: ILogger; @@ -29,13 +31,14 @@ export declare class MatchController { protected botLootCacheService: BotLootCacheService; protected configServer: ConfigServer; protected profileSnapshotService: ProfileSnapshotService; - protected pmcAiService: PmcAiService; + protected customLocationWaveService: CustomLocationWaveService; + protected openZoneService: OpenZoneService; 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, pmcAiService: PmcAiService, botGenerationCacheService: BotGenerationCacheService, applicationContext: ApplicationContext); + constructor(logger: ILogger, saveServer: SaveServer, profileHelper: ProfileHelper, matchLocationService: MatchLocationService, traderHelper: TraderHelper, botLootCacheService: BotLootCacheService, configServer: ConfigServer, profileSnapshotService: ProfileSnapshotService, customLocationWaveService: CustomLocationWaveService, openZoneService: OpenZoneService, botGenerationCacheService: BotGenerationCacheService, applicationContext: ApplicationContext); getEnabled(): boolean; getProfile(info: IGetProfileRequestData): IPmcData[]; createGroup(sessionID: string, info: ICreateGroupRequestData): any; @@ -44,5 +47,11 @@ export declare class MatchController { protected getMatch(location: string): any; getGroupStatus(info: IGetGroupStatusRequestData): any; startOfflineRaid(info: IStartOfflineRaidRequestData, sessionID: string): void; + /** + * Convert a difficulty value from pre-raid screen to a bot difficulty + * @param botDifficulty dropdown difficulty + * @returns bot difficulty + */ + protected convertDifficultyDropdownIntoBotDifficulty(botDifficulty: BotDifficulty): string; endOfflineRaid(info: IEndOfflineRaidRequestData, sessionID: string): void; } diff --git a/types/controllers/NoteController.d.ts b/types/controllers/NoteController.d.ts index ee70541..9e2e250 100644 --- a/types/controllers/NoteController.d.ts +++ b/types/controllers/NoteController.d.ts @@ -1,10 +1,10 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { INoteActionData } from "../models/eft/notes/INoteActionData"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; export declare class NoteController { - protected itemEventRouter: ItemEventRouter; - constructor(itemEventRouter: ItemEventRouter); + protected eventOutputHolder: EventOutputHolder; + constructor(eventOutputHolder: EventOutputHolder); addNote(pmcData: IPmcData, body: INoteActionData, sessionID: string): IItemEventRouterResponse; editNote(pmcData: IPmcData, body: INoteActionData, sessionID: string): IItemEventRouterResponse; deleteNote(pmcData: IPmcData, body: INoteActionData, sessionID: string): IItemEventRouterResponse; diff --git a/types/controllers/PresetBuildController.d.ts b/types/controllers/PresetBuildController.d.ts index adf4084..65ae0c4 100644 --- a/types/controllers/PresetBuildController.d.ts +++ b/types/controllers/PresetBuildController.d.ts @@ -3,15 +3,15 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IPresetBuildActionRequestData } from "../models/eft/presetBuild/IPresetBuildActionRequestData"; import { WeaponBuild } from "../models/eft/profile/IAkiProfile"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { SaveServer } from "../servers/SaveServer"; import { HashUtil } from "../utils/HashUtil"; export declare class PresetBuildController { protected hashUtil: HashUtil; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected itemHelper: ItemHelper; protected saveServer: SaveServer; - constructor(hashUtil: HashUtil, itemEventRouter: ItemEventRouter, itemHelper: ItemHelper, saveServer: SaveServer); + constructor(hashUtil: HashUtil, eventOutputHolder: EventOutputHolder, itemHelper: ItemHelper, saveServer: SaveServer); getUserBuilds(sessionID: string): WeaponBuild[]; saveBuild(pmcData: IPmcData, body: IPresetBuildActionRequestData, sessionID: string): IItemEventRouterResponse; removeBuild(pmcData: IPmcData, body: IPresetBuildActionRequestData, sessionID: string): IItemEventRouterResponse; diff --git a/types/controllers/QuestController.d.ts b/types/controllers/QuestController.d.ts index 282f50e..b57eb40 100644 --- a/types/controllers/QuestController.d.ts +++ b/types/controllers/QuestController.d.ts @@ -5,22 +5,26 @@ import { QuestConditionHelper } from "../helpers/QuestConditionHelper"; import { QuestHelper } from "../helpers/QuestHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IQuest, Reward } from "../models/eft/common/tables/IQuest"; +import { IRepeatableQuest } from "../models/eft/common/tables/IRepeatableQuests"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IAcceptQuestRequestData } from "../models/eft/quests/IAcceptQuestRequestData"; import { ICompleteQuestRequestData } from "../models/eft/quests/ICompleteQuestRequestData"; import { IHandoverQuestRequestData } from "../models/eft/quests/IHandoverQuestRequestData"; import { IQuestConfig } from "../models/spt/config/IQuestConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocaleService } from "../services/LocaleService"; +import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; +import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { TimeUtil } from "../utils/TimeUtil"; export declare class QuestController { protected logger: ILogger; protected timeUtil: TimeUtil; - protected itemEventRouter: ItemEventRouter; + protected httpResponseUtil: HttpResponseUtil; + protected eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected itemHelper: ItemHelper; protected dialogueHelper: DialogueHelper; @@ -29,9 +33,10 @@ export declare class QuestController { protected questConditionHelper: QuestConditionHelper; protected playerService: PlayerService; protected localeService: LocaleService; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected questConfig: IQuestConfig; - constructor(logger: ILogger, timeUtil: TimeUtil, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, itemHelper: ItemHelper, dialogueHelper: DialogueHelper, profileHelper: ProfileHelper, questHelper: QuestHelper, questConditionHelper: QuestConditionHelper, playerService: PlayerService, localeService: LocaleService, configServer: ConfigServer); + constructor(logger: ILogger, timeUtil: TimeUtil, httpResponseUtil: HttpResponseUtil, eventOutputHolder: EventOutputHolder, databaseServer: DatabaseServer, itemHelper: ItemHelper, dialogueHelper: DialogueHelper, profileHelper: ProfileHelper, questHelper: QuestHelper, questConditionHelper: QuestConditionHelper, playerService: PlayerService, localeService: LocaleService, localisationService: LocalisationService, configServer: ConfigServer); /** * Get all quests visible to player * Exclude quests with incomplete preconditions (level/loyalty) @@ -55,7 +60,30 @@ export declare class QuestController { * @returns client response */ acceptQuest(pmcData: IPmcData, acceptedQuest: IAcceptQuestRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Get a quests startedMessageText key from db, if no startedMessageText key found, use description key instead + * @param startedMessageTextId startedMessageText property from IQuest + * @param questDescriptionId description property from IQuest + * @returns message id + */ + protected getMessageIdForQuestStart(startedMessageTextId: string, questDescriptionId: string): string; + /** + * Handle the client accepting a repeatable quest and starting it + * Send starting rewards if any to player and + * Send start notification if any to player + * @param pmcData Profile to update with new quest + * @param acceptedQuest Quest being accepted + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ acceptRepeatableQuest(pmcData: IPmcData, acceptedQuest: IAcceptQuestRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Look for an accepted quest inside player profile, return matching + * @param pmcData Profile to search through + * @param acceptedQuest Quest to search for + * @returns IRepeatableQuest + */ + protected getRepeatableQuestFromProfile(pmcData: IPmcData, acceptedQuest: IAcceptQuestRequestData): IRepeatableQuest; /** * Update completed quest in profile * Add newly unlocked quests to profile diff --git a/types/controllers/RagfairController.d.ts b/types/controllers/RagfairController.d.ts index 06af740..36a919f 100644 --- a/types/controllers/RagfairController.d.ts +++ b/types/controllers/RagfairController.d.ts @@ -12,6 +12,7 @@ import { RagfairTaxHelper } from "../helpers/RagfairTaxHelper"; import { TraderHelper } from "../helpers/TraderHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { Item } from "../models/eft/common/tables/IItem"; +import { ITraderAssort } from "../models/eft/common/tables/ITrader"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { IAddOfferRequestData, Requirement } from "../models/eft/ragfair/IAddOfferRequestData"; @@ -23,11 +24,12 @@ import { IRagfairOffer } from "../models/eft/ragfair/IRagfairOffer"; import { ISearchRequestData } from "../models/eft/ragfair/ISearchRequestData"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { RagfairServer } from "../servers/RagfairServer"; import { SaveServer } from "../servers/SaveServer"; +import { LocalisationService } from "../services/LocalisationService"; import { PaymentService } from "../services/PaymentService"; import { RagfairOfferService } from "../services/RagfairOfferService"; import { RagfairPriceService } from "../services/RagfairPriceService"; @@ -41,7 +43,7 @@ export declare class RagfairController { protected logger: ILogger; protected timeUtil: TimeUtil; protected httpResponse: HttpResponseUtil; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected ragfairServer: RagfairServer; protected ragfairPriceService: RagfairPriceService; protected databaseServer: DatabaseServer; @@ -61,19 +63,55 @@ export declare class RagfairController { protected ragfairOfferService: RagfairOfferService; protected ragfairRequiredItemsService: RagfairRequiredItemsService; protected ragfairOfferGenerator: RagfairOfferGenerator; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; - constructor(logger: ILogger, timeUtil: TimeUtil, httpResponse: HttpResponseUtil, itemEventRouter: ItemEventRouter, ragfairServer: RagfairServer, ragfairPriceService: RagfairPriceService, databaseServer: DatabaseServer, itemHelper: ItemHelper, saveServer: SaveServer, ragfairSellHelper: RagfairSellHelper, ragfairTaxHelper: RagfairTaxHelper, ragfairSortHelper: RagfairSortHelper, ragfairOfferHelper: RagfairOfferHelper, profileHelper: ProfileHelper, paymentService: PaymentService, handbookHelper: HandbookHelper, paymentHelper: PaymentHelper, inventoryHelper: InventoryHelper, traderHelper: TraderHelper, ragfairHelper: RagfairHelper, ragfairOfferService: RagfairOfferService, ragfairRequiredItemsService: RagfairRequiredItemsService, ragfairOfferGenerator: RagfairOfferGenerator, configServer: ConfigServer); - getOffers(sessionID: string, info: ISearchRequestData): IGetOffersResult; + constructor(logger: ILogger, timeUtil: TimeUtil, httpResponse: HttpResponseUtil, eventOutputHolder: EventOutputHolder, ragfairServer: RagfairServer, ragfairPriceService: RagfairPriceService, databaseServer: DatabaseServer, itemHelper: ItemHelper, saveServer: SaveServer, ragfairSellHelper: RagfairSellHelper, ragfairTaxHelper: RagfairTaxHelper, ragfairSortHelper: RagfairSortHelper, ragfairOfferHelper: RagfairOfferHelper, profileHelper: ProfileHelper, paymentService: PaymentService, handbookHelper: HandbookHelper, paymentHelper: PaymentHelper, inventoryHelper: InventoryHelper, traderHelper: TraderHelper, ragfairHelper: RagfairHelper, ragfairOfferService: RagfairOfferService, ragfairRequiredItemsService: RagfairRequiredItemsService, ragfairOfferGenerator: RagfairOfferGenerator, localisationService: LocalisationService, configServer: ConfigServer); + getOffers(sessionID: string, searchRequest: ISearchRequestData): IGetOffersResult; + /** + * Get offers for the client based on type of search being performed + * @param searchRequest Client search request data + * @param itemsToAdd + * @param traderAssorts Trader assorts + * @param pmcProfile Player profile + * @returns array of offers + */ + protected getOffersForSearchType(searchRequest: ISearchRequestData, itemsToAdd: string[], traderAssorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + /** + * Get categories for the type of search being performed, linked/required/all + * @param searchRequest Client search request data + * @param offers ragfair offers to get categories for + * @returns record with tpls + counts + */ + protected getSpecificCategories(searchRequest: ISearchRequestData, offers: IRagfairOffer[]): Record; + /** + * Add Required offers to offers result + * @param searchRequest Client search request data + * @param assorts + * @param pmcProfile Player profile + * @param result Result object being sent back to client + */ + protected addRequiredOffersToResult(searchRequest: ISearchRequestData, assorts: Record, pmcProfile: IPmcData, result: IGetOffersResult): void; + /** + * Add index to all offers passed in (0-indexed) + * @param offers Offers to add index value to + */ + protected addIndexValueToOffers(offers: IRagfairOffer[]): void; /** * Update a trader flea offer with buy restrictions stored in the traders assort * @param offer flea offer to update + * @param profile full profile of player */ - protected setTraderOfferPurchaseLimits(offer: IRagfairOffer): void; + protected setTraderOfferPurchaseLimits(offer: IRagfairOffer, profile: IAkiProfile): void; protected isLinkedSearch(info: ISearchRequestData): boolean; protected isRequiredSearch(info: ISearchRequestData): boolean; update(): void; - getItemPrice(info: IGetMarketPriceRequestData): IGetItemPriceResult; + /** + * Called when creating an offer on flea, fills values in top right corner + * @param getPriceRequest + * @returns min/avg/max values for an item based on flea offers available + */ + getItemMinAvgMaxFleaPriceValues(getPriceRequest: IGetMarketPriceRequestData): IGetItemPriceResult; addPlayerOffer(pmcData: IPmcData, info: IAddOfferRequestData, sessionID: string): IItemEventRouterResponse; createPlayerOffer(profile: IAkiProfile, requirements: Requirement[], items: Item[], sellInOnePiece: boolean, amountToSend: number): IRagfairOffer; getAllFleaPrices(): Record; diff --git a/types/controllers/RepairController.d.ts b/types/controllers/RepairController.d.ts index 0e78ef6..fd8ff72 100644 --- a/types/controllers/RepairController.d.ts +++ b/types/controllers/RepairController.d.ts @@ -7,35 +7,35 @@ import { IRepairActionDataRequest } from "../models/eft/repair/IRepairActionData import { ITraderRepairActionDataRequest } from "../models/eft/repair/ITraderRepairActionDataRequest"; import { IRepairConfig } from "../models/spt/config/IRepairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; -import { ConfigServer } from "../servers/ConfigServer"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { DatabaseServer } from "../servers/DatabaseServer"; import { PaymentService } from "../services/PaymentService"; +import { RepairService } from "../services/RepairService"; export declare class RepairController { protected logger: ILogger; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected questHelper: QuestHelper; protected traderHelper: TraderHelper; protected paymentService: PaymentService; protected repairHelper: RepairHelper; - protected configServer: ConfigServer; + protected repairService: RepairService; protected repairConfig: IRepairConfig; - constructor(logger: ILogger, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, questHelper: QuestHelper, traderHelper: TraderHelper, paymentService: PaymentService, repairHelper: RepairHelper, configServer: ConfigServer); + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, databaseServer: DatabaseServer, questHelper: QuestHelper, traderHelper: TraderHelper, paymentService: PaymentService, repairHelper: RepairHelper, repairService: RepairService); /** * Repair with trader - * @param pmcData player profile - * @param body endpoint request data * @param sessionID session id + * @param body endpoint request data + * @param pmcData player profile * @returns item event router action */ - traderRepair(pmcData: IPmcData, body: ITraderRepairActionDataRequest, sessionID: string): IItemEventRouterResponse; + traderRepair(sessionID: string, body: ITraderRepairActionDataRequest, pmcData: IPmcData): IItemEventRouterResponse; /** * Repair with repair kit - * @param pmcData player profile - * @param body endpoint request data * @param sessionID session id + * @param body endpoint request data + * @param pmcData player profile * @returns item event router action */ - repairWithKit(pmcData: IPmcData, body: IRepairActionDataRequest, sessionID: string): IItemEventRouterResponse; + repairWithKit(sessionID: string, body: IRepairActionDataRequest, pmcData: IPmcData): IItemEventRouterResponse; } diff --git a/types/controllers/RepeatableQuestController.d.ts b/types/controllers/RepeatableQuestController.d.ts index 4c31a3d..fee4d44 100644 --- a/types/controllers/RepeatableQuestController.d.ts +++ b/types/controllers/RepeatableQuestController.d.ts @@ -13,12 +13,14 @@ import { IRepeatableQuestChangeRequest } from "../models/eft/quests/IRepeatableQ import { ELocationName } from "../models/enums/ELocationName"; import { IQuestConfig, IRepeatableQuestConfig } from "../models/spt/config/IQuestConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { ItemFilterService } from "../services/ItemFilterService"; +import { LocalisationService } from "../services/LocalisationService"; import { PaymentService } from "../services/PaymentService"; import { ProfileFixerService } from "../services/ProfileFixerService"; +import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { MathUtil } from "../utils/MathUtil"; import { ObjectId } from "../utils/ObjectId"; @@ -55,6 +57,7 @@ export declare class RepeatableQuestController { protected timeUtil: TimeUtil; protected logger: ILogger; protected randomUtil: RandomUtil; + protected httpResponse: HttpResponseUtil; protected mathUtil: MathUtil; protected jsonUtil: JsonUtil; protected databaseServer: DatabaseServer; @@ -63,13 +66,14 @@ export declare class RepeatableQuestController { protected profileHelper: ProfileHelper; protected profileFixerService: ProfileFixerService; protected ragfairServerHelper: RagfairServerHelper; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; + protected localisationService: LocalisationService; protected paymentService: PaymentService; protected objectId: ObjectId; protected itemFilterService: ItemFilterService; protected configServer: ConfigServer; protected questConfig: IQuestConfig; - constructor(timeUtil: TimeUtil, logger: ILogger, randomUtil: RandomUtil, mathUtil: MathUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, itemHelper: ItemHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, ragfairServerHelper: RagfairServerHelper, itemEventRouter: ItemEventRouter, paymentService: PaymentService, objectId: ObjectId, itemFilterService: ItemFilterService, configServer: ConfigServer); + constructor(timeUtil: TimeUtil, logger: ILogger, randomUtil: RandomUtil, httpResponse: HttpResponseUtil, mathUtil: MathUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, itemHelper: ItemHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, ragfairServerHelper: RagfairServerHelper, eventOutputHolder: EventOutputHolder, localisationService: LocalisationService, paymentService: PaymentService, objectId: ObjectId, itemFilterService: ItemFilterService, configServer: ConfigServer); /** * This is the method reached by the /client/repeatalbeQuests/activityPeriods endpoint * Returns an array of objects in the format of repeatable quests to the client. @@ -96,6 +100,13 @@ export declare class RepeatableQuestController { * @returns {array} array of "repeatableQuestObjects" as descibed above */ getClientRepeatableQuests(_info: IEmptyRequestData, sessionID: string): IPmcDataRepeatableQuest[]; + /** + * Get repeatable quest data from profile from name (daily/weekly), creates base repeatable quest object if none exists + * @param repeatableConfig daily/weekly config + * @param pmcData Profile to search + * @returns IPmcDataRepeatableQuest + */ + protected getRepeatableQuestSubTypeFromProfile(repeatableConfig: IRepeatableQuestConfig, pmcData: IPmcData): IPmcDataRepeatableQuest; /** * This method is called by GetClientRepeatableQuests and creates one element of quest type format (see assets/database/templates/repeatableQuests.json). * It randomly draws a quest type (currently Elimination, Completion or Exploration) as well as a trader who is providing the quest @@ -144,6 +155,12 @@ export declare class RepeatableQuestController { * @returns {object} object of quest type format for "Elimination" (see assets/database/templates/repeatableQuests.json) */ generateEliminationQuest(pmcLevel: number, traderId: string, questTypePool: IQuestTypePool, repeatableConfig: IRepeatableQuestConfig): IElimination; + /** + * Cpnvert a location into an quest code can read (e.g. factory4_day into 55f2d3fd4bdc2d5f408b4567) + * @param locationKey e.g factory4_day + * @returns guid + */ + protected getQuestLocationByMapId(locationKey: string): string; /** * Exploration repeatable quests can specify a required extraction point. * This method creates the according object which will be appended to the conditions array diff --git a/types/controllers/TradeController.d.ts b/types/controllers/TradeController.d.ts index c86745c..6c35d66 100644 --- a/types/controllers/TradeController.d.ts +++ b/types/controllers/TradeController.d.ts @@ -6,15 +6,17 @@ import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRag import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { Upd } from "../models/eft/common/tables/IItem"; import { IProcessBaseTradeRequestData } from "../models/eft/trade/IProcessBaseTradeRequestData"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ILogger } from "../models/spt/utils/ILogger"; +import { HttpResponseUtil } from "../utils/HttpResponseUtil"; declare class TradeController { protected logger: ILogger; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected tradeHelper: TradeHelper; protected profileHelper: ProfileHelper; protected ragfairServer: RagfairServer; - constructor(logger: ILogger, itemEventRouter: ItemEventRouter, tradeHelper: TradeHelper, profileHelper: ProfileHelper, ragfairServer: RagfairServer); + protected httpResponse: HttpResponseUtil; + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, tradeHelper: TradeHelper, profileHelper: ProfileHelper, ragfairServer: RagfairServer, httpResponse: HttpResponseUtil); confirmTrading(pmcData: IPmcData, body: IProcessBaseTradeRequestData, sessionID: string, foundInRaid?: boolean, upd?: Upd): IItemEventRouterResponse; confirmRagfairTrading(pmcData: IPmcData, body: IProcessRagfairTradeRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/controllers/TraderController.d.ts b/types/controllers/TraderController.d.ts index b79f55e..b67aec9 100644 --- a/types/controllers/TraderController.d.ts +++ b/types/controllers/TraderController.d.ts @@ -1,3 +1,4 @@ +import { FenceBaseAssortGenerator } from "../generators/FenceBaseAssortGenerator"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { TraderAssortHelper } from "../helpers/TraderAssortHelper"; import { TraderHelper } from "../helpers/TraderHelper"; @@ -6,6 +7,7 @@ import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { FenceService } from "../services/FenceService"; import { TraderAssortService } from "../services/TraderAssortService"; +import { TraderPurchasePersisterService } from "../services/TraderPurchasePersisterService"; import { JsonUtil } from "../utils/JsonUtil"; import { TimeUtil } from "../utils/TimeUtil"; export declare class TraderController { @@ -16,9 +18,11 @@ export declare class TraderController { protected traderHelper: TraderHelper; protected timeUtil: TimeUtil; protected traderAssortService: TraderAssortService; + protected traderPurchasePersisterService: TraderPurchasePersisterService; protected fenceService: FenceService; + protected fenceBaseAssortGenerator: FenceBaseAssortGenerator; protected jsonUtil: JsonUtil; - constructor(logger: ILogger, databaseServer: DatabaseServer, traderAssortHelper: TraderAssortHelper, profileHelper: ProfileHelper, traderHelper: TraderHelper, timeUtil: TimeUtil, traderAssortService: TraderAssortService, fenceService: FenceService, jsonUtil: JsonUtil); + constructor(logger: ILogger, databaseServer: DatabaseServer, traderAssortHelper: TraderAssortHelper, profileHelper: ProfileHelper, traderHelper: TraderHelper, timeUtil: TimeUtil, traderAssortService: TraderAssortService, traderPurchasePersisterService: TraderPurchasePersisterService, fenceService: FenceService, fenceBaseAssortGenerator: FenceBaseAssortGenerator, jsonUtil: JsonUtil); /** * Runs when onLoad event is fired * Iterate over traders, ensure an unmolested copy of their assorts is stored in traderAssortService diff --git a/types/controllers/WeatherController.d.ts b/types/controllers/WeatherController.d.ts index ca7f5eb..631a90c 100644 --- a/types/controllers/WeatherController.d.ts +++ b/types/controllers/WeatherController.d.ts @@ -1,11 +1,18 @@ import { WeatherGenerator } from "../generators/WeatherGenerator"; import { IWeatherData } from "../models/eft/weather/IWeatherData"; import { IWeatherConfig } from "../models/spt/config/IWeatherConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; export declare class WeatherController { protected weatherGenerator: WeatherGenerator; + protected logger: ILogger; protected configServer: ConfigServer; protected weatherConfig: IWeatherConfig; - constructor(weatherGenerator: WeatherGenerator, configServer: ConfigServer); + constructor(weatherGenerator: WeatherGenerator, logger: ILogger, configServer: ConfigServer); generate(): IWeatherData; + /** + * Get the current in-raid time (MUST HAVE PLAYER LOGGED INTO CLIENT TO WORK) + * @returns Date object + */ + getCurrentInRaidTime(): Date; } diff --git a/types/controllers/WishlistController.d.ts b/types/controllers/WishlistController.d.ts index a96c522..83be4b3 100644 --- a/types/controllers/WishlistController.d.ts +++ b/types/controllers/WishlistController.d.ts @@ -1,10 +1,10 @@ -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IWishlistActionData } from "../models/eft/wishlist/IWishlistActionData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; export declare class WishlistController { - protected itemEvenRouter: ItemEventRouter; - constructor(itemEvenRouter: ItemEventRouter); + protected eventOutputHolder: EventOutputHolder; + constructor(eventOutputHolder: EventOutputHolder); addToWishList(pmcData: IPmcData, body: IWishlistActionData, sessionID: string): IItemEventRouterResponse; removeFromWishList(pmcData: IPmcData, body: IWishlistActionData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/di/Container.d.ts b/types/di/Container.d.ts index 98d1fa1..e339a3b 100644 --- a/types/di/Container.d.ts +++ b/types/di/Container.d.ts @@ -3,6 +3,7 @@ import { DependencyContainer } from "tsyringe"; * Handle the registration of classes to be used by the Dependency Injection code */ export declare class Container { + static registerPostLoadTypes(container: DependencyContainer, childContainer: DependencyContainer): void; static registerTypes(depContainer: DependencyContainer): void; static registerListTypes(depContainer: DependencyContainer): void; private static registerUtils; diff --git a/types/di/OnLoad.d.ts b/types/di/OnLoad.d.ts index 064d07d..4a28f13 100644 --- a/types/di/OnLoad.d.ts +++ b/types/di/OnLoad.d.ts @@ -1,4 +1,4 @@ export declare class OnLoad { - onLoad(): void; + onLoad(): Promise; getRoute(): string; } diff --git a/types/di/OnLoadOnUpdate.d.ts b/types/di/OnLoadOnUpdate.d.ts index 8bd3dc3..eaa297c 100644 --- a/types/di/OnLoadOnUpdate.d.ts +++ b/types/di/OnLoadOnUpdate.d.ts @@ -1,7 +1,7 @@ import { OnLoad } from "./OnLoad"; import { OnUpdate } from "./OnUpdate"; export declare class OnLoadOnUpdate implements OnLoad, OnUpdate { - onUpdate(timeSinceLastRun: number): boolean; - onLoad(): void; + onUpdate(timeSinceLastRun: number): Promise; + onLoad(): Promise; getRoute(): string; } diff --git a/types/di/OnUpdate.d.ts b/types/di/OnUpdate.d.ts index 7fbbe09..6839719 100644 --- a/types/di/OnUpdate.d.ts +++ b/types/di/OnUpdate.d.ts @@ -1,4 +1,4 @@ export declare class OnUpdate { - onUpdate(timeSinceLastRun: number): boolean; + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/di/Serializer.d.ts b/types/di/Serializer.d.ts index 70aa7c5..2617007 100644 --- a/types/di/Serializer.d.ts +++ b/types/di/Serializer.d.ts @@ -1,5 +1,6 @@ -import { IHttpServer } from "../models/spt/server/IHttpServer"; +/// +import { IncomingMessage, ServerResponse } from "http"; export declare class Serializer { - serialize(sessionID: string, req: any, resp: any, body: any, httpServer: IHttpServer): void; + serialize(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: any): void; canHandle(something: string): boolean; } diff --git a/types/generators/BotEquipmentModGenerator.d.ts b/types/generators/BotEquipmentModGenerator.d.ts new file mode 100644 index 0000000..5b937ca --- /dev/null +++ b/types/generators/BotEquipmentModGenerator.d.ts @@ -0,0 +1,200 @@ +import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper"; +import { BotHelper } from "../helpers/BotHelper"; +import { BotWeaponGeneratorHelper } from "../helpers/BotWeaponGeneratorHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; +import { ProbabilityHelper } from "../helpers/ProbabilityHelper"; +import { ProfileHelper } from "../helpers/ProfileHelper"; +import { Mods, ModsChances } from "../models/eft/common/tables/IBotType"; +import { Item } from "../models/eft/common/tables/IItem"; +import { ITemplateItem, Slot } from "../models/eft/common/tables/ITemplateItem"; +import { EquipmentFilterDetails, IBotConfig } from "../models/spt/config/IBotConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { BotEquipmentFilterService } from "../services/BotEquipmentFilterService"; +import { BotEquipmentModPoolService } from "../services/BotEquipmentModPoolService"; +import { BotModLimits, BotWeaponModLimitService } from "../services/BotWeaponModLimitService"; +import { ItemFilterService } from "../services/ItemFilterService"; +import { LocalisationService } from "../services/LocalisationService"; +import { HashUtil } from "../utils/HashUtil"; +import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; +export declare class BotEquipmentModGenerator { + protected logger: ILogger; + protected jsonUtil: JsonUtil; + protected hashUtil: HashUtil; + protected randomUtil: RandomUtil; + protected probabilityHelper: ProbabilityHelper; + protected databaseServer: DatabaseServer; + protected itemHelper: ItemHelper; + protected botEquipmentFilterService: BotEquipmentFilterService; + protected itemFilterService: ItemFilterService; + protected profileHelper: ProfileHelper; + protected botWeaponModLimitService: BotWeaponModLimitService; + protected botHelper: BotHelper; + protected botGeneratorHelper: BotGeneratorHelper; + protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + protected localisationService: LocalisationService; + protected botEquipmentModPoolService: BotEquipmentModPoolService; + protected configServer: ConfigServer; + protected botConfig: IBotConfig; + constructor(logger: ILogger, jsonUtil: JsonUtil, hashUtil: HashUtil, randomUtil: RandomUtil, probabilityHelper: ProbabilityHelper, databaseServer: DatabaseServer, itemHelper: ItemHelper, botEquipmentFilterService: BotEquipmentFilterService, itemFilterService: ItemFilterService, profileHelper: ProfileHelper, botWeaponModLimitService: BotWeaponModLimitService, botHelper: BotHelper, botGeneratorHelper: BotGeneratorHelper, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, localisationService: LocalisationService, botEquipmentModPoolService: BotEquipmentModPoolService, configServer: ConfigServer); + /** + * Check mods are compatible and add to array + * @param equipment Equipment item to add mods to + * @param modPool Mod list to choose frm + * @param parentId parentid of item to add mod to + * @param parentTemplate template objet of item to add mods to + * @param modSpawnChances dictionary of mod items and their chance to spawn for this bot type + * @param botRole the bot role being generated for + * @param forceSpawn should this mod be forced to spawn + * @returns Item + compatible mods as an array + */ + generateModsForEquipment(equipment: Item[], modPool: Mods, parentId: string, parentTemplate: ITemplateItem, modSpawnChances: ModsChances, botRole: string, forceSpawn?: boolean): Item[]; + /** + * Add mods to a weapon using the provided mod pool + * @param sessionId session id + * @param weapon Weapon to add mods to + * @param modPool Pool of compatible mods to attach to weapon + * @param weaponParentId parentId of weapon + * @param parentTemplate Weapon which mods will be generated on + * @param modSpawnChances Mod spawn chances + * @param ammoTpl Ammo tpl to use when generating magazines/cartridges + * @param botRole Role of bot weapon is generated for + * @param botLevel lvel of the bot weapon is being generated for + * @param modLimits limits placed on certian mod types per gun + * @param botEquipmentRole role of bot when accessing bot.json equipment config settings + * @returns Weapon + mods array + */ + generateModsForWeapon(sessionId: string, weapon: Item[], modPool: Mods, weaponParentId: string, parentTemplate: ITemplateItem, modSpawnChances: ModsChances, ammoTpl: string, botRole: string, botLevel: number, modLimits: BotModLimits, botEquipmentRole: string): Item[]; + /** + * Is this modslot a front or rear sight + * @param modSlot Slot to check + * @returns true if it's a front/rear sight + */ + protected modIsFrontOrRearSight(modSlot: string): boolean; + /** + * Does the provided mod details show the mod can hold a scope + * @param modSlot e.g. mod_scope, mod_mount + * @param modsParentId Parent id of mod item + * @returns true if it can hold a scope + */ + protected modSlotCanHoldScope(modSlot: string, modsParentId: string): boolean; + /** + * Set all scope mod chances to 100% + * @param modSpawnChances Chances objet to update + */ + protected setScopeSpawnChancesToFull(modSpawnChances: ModsChances): void; + protected sortModKeys(unsortedKeys: string[]): string[]; + /** + * Get a Slot property for an item (chamber/cartridge/slot) + * @param modSlot e.g patron_in_weapon + * @param parentTemplate item template + * @returns Slot item + */ + protected getModItemSlot(modSlot: string, parentTemplate: ITemplateItem): Slot; + /** + * randomly choose if a mod should be spawned, 100% for required mods OR mod is ammo slot + * never return true for an item that has 0% spawn chance + * @param itemSlot slot the item sits in + * @param modSlot slot the mod sits in + * @param modSpawnChances Chances for various mod spawns + * @returns boolean true if it should spawn + */ + protected shouldModBeSpawned(itemSlot: Slot, modSlot: string, modSpawnChances: ModsChances): boolean; + /** + * + * @param modSlot Slot mod will fit into + * @param isRandomisableSlot Will generate a randomised mod pool if true + * @param modsParent Parent slot the item will be a part of + * @param botEquipBlacklist Blacklist to prevent mods from being picked + * @param itemModPool Pool of items to pick from + * @param weapon array with only weapon tpl in it, ready for mods to be added + * @param ammoTpl ammo tpl to use if slot requires a cartridge to be added (e.g. mod_magazine) + * @param parentTemplate Parent item the mod will go into + * @returns ITemplateItem + */ + protected chooseModToPutIntoSlot(modSlot: string, isRandomisableSlot: boolean, botWeaponSightWhitelist: Record, botEquipBlacklist: EquipmentFilterDetails, itemModPool: Record, weapon: Item[], ammoTpl: string, parentTemplate: ITemplateItem): [boolean, ITemplateItem]; + /** + * Create a mod item with parameters as properties + * @param modId _id + * @param modTpl _tpl + * @param parentId parentId + * @param modSlot slotId + * @param modTemplate Used to add additional properites in the upd object + * @returns Item object + */ + protected createModItem(modId: string, modTpl: string, parentId: string, modSlot: string, modTemplate: ITemplateItem, botRole: string): Item; + /** + * Get a list of containers that hold ammo + * e.g. mod_magazine / patron_in_weapon_000 + * @returns string array + */ + protected getAmmoContainers(): string[]; + /** + * Get a random mod from an items compatible mods Filter array + * @param modTpl ???? default value to return if nothing found + * @param parentSlot item mod will go into, used to get combatible items + * @param modSlot Slot to get mod to fill + * @param items items to ensure picked mod is compatible with + * @returns item tpl + */ + protected getModTplFromItemDb(modTpl: string, parentSlot: Slot, modSlot: string, items: Item[]): string; + /** + * Log errors if mod is not compatible with slot + * @param modToAdd template of mod to check + * @param itemSlot slot the item will be placed in + * @param modSlot slot the mod will fill + * @param parentTemplate tempalte of the mods parent item + * @returns true if valid + */ + protected isModValidForSlot(modToAdd: [boolean, ITemplateItem], itemSlot: Slot, modSlot: string, parentTemplate: ITemplateItem): boolean; + /** + * Find mod tpls of a provided type and add to modPool + * @param desiredSlotName slot to look up and add we are adding tpls for (e.g mod_scope) + * @param modTemplate db object for modItem we get compatible mods from + * @param modPool Pool of mods we are adding to + */ + protected addCompatibleModsForProvidedMod(desiredSlotName: string, modTemplate: ITemplateItem, modPool: Mods, botEquipBlacklist: EquipmentFilterDetails): void; + /** + * Get the possible items that fit a slot + * @param parentItemId item tpl to get compatible items for + * @param modSlot Slot item should fit in + * @param botEquipBlacklist equipment that should not be picked + * @returns array of compatible items for that slot + */ + protected getDynamicModPool(parentItemId: string, modSlot: string, botEquipBlacklist: EquipmentFilterDetails): string[]; + /** + * Take a list of tpls and filter out blacklisted values using itemFilterService + botEquipmentBlacklist + * @param allowedMods base mods to filter + * @param botEquipBlacklist equipment blacklist + * @param modSlot slot mods belong to + * @returns Filtered array of mod tpls + */ + protected filterWeaponModsByBlacklist(allowedMods: string[], botEquipBlacklist: EquipmentFilterDetails, modSlot: string): string[]; + /** + * With the shotgun revolver (60db29ce99594040e04c4a27) 12.12 introduced CylinderMagazines. + * Those magazines (e.g. 60dc519adf4c47305f6d410d) have a "Cartridges" entry with a _max_count=0. + * Ammo is not put into the magazine directly but assigned to the magazine's slots: The "camora_xxx" slots. + * This function is a helper called by generateModsForItem for mods with parent type "CylinderMagazine" + * @param items The items where the CylinderMagazine's camora are appended to + * @param modPool modPool which should include available cartrigdes + * @param parentId The CylinderMagazine's UID + * @param parentTemplate The CylinderMagazine's template + */ + protected fillCamora(items: Item[], modPool: Mods, parentId: string, parentTemplate: ITemplateItem): void; + /** + * Take a record of camoras and merge the compatable shells into one array + * @param camorasWithShells camoras we want to merge into one array + * @returns string array of shells fro luitple camora sources + */ + protected mergeCamoraPoolsTogether(camorasWithShells: Record): string[]; + /** + * Filter out non-whitelisted weapon scopes + * @param weapon Weapon scopes will be added to + * @param scopes Full scope pool + * @param botWeaponSightWhitelist whitelist of scope types by weapon base type + * @returns array of scope tpls that have been filtered + */ + protected filterSightsByWeaponType(weapon: Item, scopes: string[], botWeaponSightWhitelist: Record): string[]; +} diff --git a/types/generators/BotGenerator.d.ts b/types/generators/BotGenerator.d.ts index 2ac51db..2675146 100644 --- a/types/generators/BotGenerator.d.ts +++ b/types/generators/BotGenerator.d.ts @@ -1,25 +1,21 @@ +import { BotDifficultyHelper } from "../helpers/BotDifficultyHelper"; import { BotHelper } from "../helpers/BotHelper"; -import { GameEventHelper } from "../helpers/GameEventHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; -import { IGenerateBotsRequestData } from "../models/eft/bot/IGenerateBotsRequestData"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { Health as PmcHealth, IBotBase, Skills } from "../models/eft/common/tables/IBotBase"; -import { Health, IBotType, Inventory } from "../models/eft/common/tables/IBotType"; +import { Health, IBotType } from "../models/eft/common/tables/IBotType"; +import { BotGenerationDetails } from "../models/spt/bots/BotGenerationDetails"; 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 { BotEquipmentFilterService } from "../services/BotEquipmentFilterService"; -import { PmcAiService } from "../services/PmcAiService"; +import { SeasonalEventService } from "../services/SeasonalEventService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; import { BotInventoryGenerator } from "./BotInventoryGenerator"; -declare namespace BotGenerator { - interface IRandomisedBotLevelResult { - level: number; - exp: number; - } -} +import { BotLevelGenerator } from "./BotLevelGenerator"; export declare class BotGenerator { protected logger: ILogger; protected hashUtil: HashUtil; @@ -28,13 +24,15 @@ export declare class BotGenerator { protected profileHelper: ProfileHelper; protected databaseServer: DatabaseServer; protected botInventoryGenerator: BotInventoryGenerator; + protected botLevelGenerator: BotLevelGenerator; protected botEquipmentFilterService: BotEquipmentFilterService; + protected weightedRandomHelper: WeightedRandomHelper; protected botHelper: BotHelper; - protected gameEventHelper: GameEventHelper; - protected pmcAiService: PmcAiService; + protected botDifficultyHelper: BotDifficultyHelper; + protected seasonalEventService: SeasonalEventService; 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, pmcAiService: PmcAiService, configServer: ConfigServer); + constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, jsonUtil: JsonUtil, profileHelper: ProfileHelper, databaseServer: DatabaseServer, botInventoryGenerator: BotInventoryGenerator, botLevelGenerator: BotLevelGenerator, botEquipmentFilterService: BotEquipmentFilterService, weightedRandomHelper: WeightedRandomHelper, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, seasonalEventService: SeasonalEventService, configServer: ConfigServer); /** * Generate a player scav bot object * @param role e.g. assault / pmcbot @@ -44,17 +42,12 @@ export declare class BotGenerator { */ generatePlayerScav(sessionId: string, role: string, difficulty: string, botTemplate: IBotType): IBotBase; /** - * Generate an array of bot objects for populate a raid with - * @param sessionId session id - * @param info request object - * @returns bot array + * Create x number of bots of the type/side/difficulty defined in botGenerationDetails + * @param sessionId Session id + * @param botGenerationDetails details on how to generate bots + * @returns array of bots */ - generate(sessionId: string, info: IGenerateBotsRequestData): IBotBase[]; - /** - * Get a randomised PMC side based on bot config value 'isUsec' - * @returns pmc side as string - */ - protected getRandomisedPmcSide(): string; + prepareAndGenerateBots(sessionId: string, botGenerationDetails: BotGenerationDetails): IBotBase[]; /** * Get a clone of the database\bots\base.json file * @returns IBotBase object @@ -64,26 +57,24 @@ export declare class BotGenerator { * 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 + * @param botJsonTemplate Bot template from db/bots/x.json + * @param botGenerationDetails details on how to generate the bot * @returns IBotBase object */ - protected generateBot(sessionId: string, bot: IBotBase, role: string, node: IBotType, isPmc: boolean, isPlayerScav?: boolean): IBotBase; + protected generateBot(sessionId: string, bot: IBotBase, botJsonTemplate: IBotType, botGenerationDetails: BotGenerationDetails): IBotBase; + /** + * Create a bot nickname + * @param botJsonTemplate x.json from database + * @param isPlayerScav Will bot be player scav + * @param botRole role of bot e.g. assault + * @returns Nickname for bot + */ + protected generateBotNickname(botJsonTemplate: IBotType, isPlayerScav: boolean, botRole: string): string; /** * 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; - /** - * 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 @@ -92,11 +83,6 @@ export declare class BotGenerator { */ protected generateHealth(healthObj: Health, playerScav?: boolean): PmcHealth; protected generateSkills(skillsObj: Skills): Skills; - /** - * 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 @@ -104,12 +90,6 @@ export declare class BotGenerator { */ 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 * @param bot bot to add dogtag to @@ -117,4 +97,3 @@ export declare class BotGenerator { */ protected generateDogtag(bot: IBotBase): IBotBase; } -export {}; diff --git a/types/generators/BotInventoryGenerator.d.ts b/types/generators/BotInventoryGenerator.d.ts index c5ed545..83a548b 100644 --- a/types/generators/BotInventoryGenerator.d.ts +++ b/types/generators/BotInventoryGenerator.d.ts @@ -1,14 +1,18 @@ import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper"; +import { BotHelper } from "../helpers/BotHelper"; import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { Inventory as PmcInventory } from "../models/eft/common/tables/IBotBase"; -import { Chances, Generation, Inventory, Mods } from "../models/eft/common/tables/IBotType"; +import { Chances, Generation, IBotType, Inventory, Mods } from "../models/eft/common/tables/IBotType"; import { EquipmentSlots } from "../models/enums/EquipmentSlots"; -import { IBotConfig } from "../models/spt/config/IBotConfig"; +import { EquipmentFilterDetails, IBotConfig, RandomisationDetails } from "../models/spt/config/IBotConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { BotEquipmentModPoolService } from "../services/BotEquipmentModPoolService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { RandomUtil } from "../utils/RandomUtil"; +import { BotEquipmentModGenerator } from "./BotEquipmentModGenerator"; import { BotLootGenerator } from "./BotLootGenerator"; import { BotWeaponGenerator } from "./BotWeaponGenerator"; export declare class BotInventoryGenerator { @@ -19,15 +23,90 @@ export declare class BotInventoryGenerator { protected botWeaponGenerator: BotWeaponGenerator; protected botLootGenerator: BotLootGenerator; protected botGeneratorHelper: BotGeneratorHelper; + protected botHelper: BotHelper; protected weightedRandomHelper: WeightedRandomHelper; + protected localisationService: LocalisationService; + protected botEquipmentModPoolService: BotEquipmentModPoolService; + protected botEquipmentModGenerator: BotEquipmentModGenerator; 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; + constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, botWeaponGenerator: BotWeaponGenerator, botLootGenerator: BotLootGenerator, botGeneratorHelper: BotGeneratorHelper, botHelper: BotHelper, weightedRandomHelper: WeightedRandomHelper, localisationService: LocalisationService, botEquipmentModPoolService: BotEquipmentModPoolService, botEquipmentModGenerator: BotEquipmentModGenerator, configServer: ConfigServer); + /** + * Add equipment/weapons/loot to bot + * @param sessionId Session id + * @param botJsonTemplate bot/x.json data from db + * @param botRole Role bot has (assault/pmcBot) + * @param isPmc Is bot being converted into a pmc + * @param botLevel Level of bot being generated + * @returns PmcInventory object with equipment/weapons/loot + */ + generateInventory(sessionId: string, botJsonTemplate: IBotType, botRole: string, isPmc: boolean, botLevel: number): PmcInventory; + /** + * Create a pmcInventory object with all the base/generic items needed + * @returns PmcInventory object + */ + protected generateInventoryBase(): PmcInventory; + /** + * Add equipment to a bot + * @param templateInventory bot/x.json data from db + * @param equipmentChances Chances items will be added to bot + * @param botRole Role bot has (assault/pmcBot) + * @param botInventory Inventory to add equipment to + * @param botLevel Level of bot + */ + protected generateAndAddEquipmentToBot(templateInventory: Inventory, equipmentChances: Chances, botRole: string, botInventory: PmcInventory, botLevel: number): void; + /** + * Add a piece of equipment with mods to inventory from the provided pools + * @param equipmentSlot Slot to select an item for + * @param equipmentPool Possible items to choose from + * @param modPool Possible mods to apply to item chosen + * @param spawnChances Chances items will be chosen to be added + * @param botRole Role of bot e.g. assault + * @param inventory Inventory to add item into + * @param randomisationDetails settings from bot.json to adjust how item is generated + */ + protected generateEquipment(equipmentSlot: string, equipmentPool: Record, modPool: Mods, spawnChances: Chances, botRole: string, inventory: PmcInventory, randomisationDetails: RandomisationDetails): void; + /** + * Get all possible mods for item and filter down based on equipment blacklist from bot.json config + * @param itemTpl Item mod pool is being retreived and filtered + * @param equipmentBlacklist blacklist to filter mod pool with + * @returns Filtered pool of mods + */ + protected getFilteredDynamicModsForItem(itemTpl: string, equipmentBlacklist: EquipmentFilterDetails[]): Record; + /** + * Work out what weapons bot should have equipped and add them to bot inventory + * @param templateInventory bot/x.json data from db + * @param equipmentChances Chances bot can have equipment equipped + * @param sessionId Session id + * @param botInventory Inventory to add weapons to + * @param botRole assault/pmcBot/bossTagilla etc + * @param isPmc Is the bot being generated as a pmc + * @param botLevel level of bot having weapon generated + * @param itemGenerationLimitsMinMax Limits for items the bot can have + */ + protected generateAndAddWeaponsToBot(templateInventory: Inventory, equipmentChances: Chances, sessionId: string, botInventory: PmcInventory, botRole: string, isPmc: boolean, itemGenerationLimitsMinMax: Generation, botLevel: number): void; + /** + * Calculate if the bot should have weapons in Primary/Secondary/Holster slots + * @param equipmentChances Chances bot has certain equipment + * @returns What slots bot should have weapons generated for + */ + protected getDesiredWeaponsForBot(equipmentChances: Chances): { + slot: EquipmentSlots; + shouldSpawn: boolean; + }[]; + /** + * Add weapon + spare mags/ammo to bots inventory + * @param sessionId Session id + * @param weaponSlot Weapon slot being generated + * @param templateInventory bot/x.json data from db + * @param botInventory Inventory to add weapon+mags/ammo to + * @param equipmentChances Chances bot can have equipment equipped + * @param botRole assault/pmcBot/bossTagilla etc + * @param isPmc Is the bot being generated as a pmc + * @param itemGenerationLimitsMinMax + */ 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, modPool: Mods, spawnChances: Chances, botRole: string, inventory: PmcInventory): void; - protected generateInventoryBase(): PmcInventory; + }, templateInventory: Inventory, botInventory: PmcInventory, equipmentChances: Chances, botRole: string, isPmc: boolean, itemGenerationLimitsMinMax: Generation, botLevel: number): void; } diff --git a/types/generators/BotLevelGenerator.d.ts b/types/generators/BotLevelGenerator.d.ts new file mode 100644 index 0000000..751e6e6 --- /dev/null +++ b/types/generators/BotLevelGenerator.d.ts @@ -0,0 +1,29 @@ +import { MinMax } from "../models/common/MinMax"; +import { IRandomisedBotLevelResult } from "../models/eft/bot/IRandomisedBotLevelResult"; +import { ExpTable } from "../models/eft/common/IGlobals"; +import { IBotBase } from "../models/eft/common/tables/IBotBase"; +import { BotGenerationDetails } from "../models/spt/bots/BotGenerationDetails"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { RandomUtil } from "../utils/RandomUtil"; +export declare class BotLevelGenerator { + protected logger: ILogger; + protected randomUtil: RandomUtil; + protected databaseServer: DatabaseServer; + constructor(logger: ILogger, randomUtil: RandomUtil, databaseServer: DatabaseServer); + /** + * Return a randomised bot level and exp value + * @param levelDetails min and max of level for bot + * @param botGenerationDetails Deatils to help generate a bot + * @param bot being level is being generated for + * @returns IRandomisedBotLevelResult object + */ + generateBotLevel(levelDetails: MinMax, botGenerationDetails: BotGenerationDetails, bot: IBotBase): IRandomisedBotLevelResult; + /** + * Get the highest level a bot can be relative to the players level, but no futher than the max size from globals.exp_table + * @param playerLevel Players current level + * @param relativeDeltaMax max delta above player level to go + * @returns highest level possible for bot + */ + protected getHighestRelativeBotLevel(playerLevel: number, relativeDeltaMax: number, levelDetails: MinMax, expTable: ExpTable[]): number; +} diff --git a/types/generators/BotLootGenerator.d.ts b/types/generators/BotLootGenerator.d.ts index c1f5310..6273a11 100644 --- a/types/generators/BotLootGenerator.d.ts +++ b/types/generators/BotLootGenerator.d.ts @@ -10,6 +10,7 @@ import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { BotLootCacheService } from "../services/BotLootCacheService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { RandomUtil } from "../utils/RandomUtil"; import { BotWeaponGenerator } from "./BotWeaponGenerator"; @@ -23,10 +24,22 @@ export declare class BotLootGenerator { protected botWeaponGenerator: BotWeaponGenerator; protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; protected botLootCacheService: BotLootCacheService; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected botConfig: IBotConfig; - 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; + constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, botGeneratorHelper: BotGeneratorHelper, botWeaponGenerator: BotWeaponGenerator, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botLootCacheService: BotLootCacheService, localisationService: LocalisationService, configServer: ConfigServer); + /** + * Add loot to bots containers + * @param sessionId Session id + * @param templateInventory x.json from database/bots + * @param itemCounts Liits on item types to be added as loot + * @param isPmc Will bot be a pmc + * @param botRole Role of bot, e.g. asssult + * @param botInventory Inventory to add loot to + * @param equipmentChances + * @param botLevel Level of bot + */ + generateLoot(sessionId: string, templateInventory: Inventory, itemCounts: ItemMinMax, isPmc: boolean, botRole: string, botInventory: PmcInventory, equipmentChances: Chances, botLevel: number): void; protected getRandomisedCount(min: number, max: number, nValue: number): number; /** * Take random items from a pool and add to an inventory until totalItemCount or totalValueLimit is reached @@ -49,7 +62,7 @@ export declare class BotLootGenerator { * @param botRole bots role, .e.g. pmcBot * @param isPmc are we generating for a pmc */ - protected addLooseWeaponsToInventorySlot(sessionId: string, botInventory: PmcInventory, equipmentSlot: string, templateInventory: Inventory, modChances: ModsChances, botRole: string, isPmc: boolean): void; + protected addLooseWeaponsToInventorySlot(sessionId: string, botInventory: PmcInventory, equipmentSlot: string, templateInventory: Inventory, modChances: ModsChances, botRole: string, isPmc: boolean, botLevel: number): void; /** * Get a random item from the pool parameter using the biasedRandomNumber system * @param pool pool of items to pick an item from @@ -113,7 +126,7 @@ export declare class BotLootGenerator { * If no limit found for a non pmc bot, fall back to defaults * @param isPmc is the bot we want limits for a pmc * @param botRole what role does the bot have - * @returns dictionary of tplIds and limit + * @returns Dictionary of tplIds and limit */ protected getItemSpawnLimitsForBotType(isPmc: boolean, botRole: string): Record; /** diff --git a/types/generators/BotWeaponGenerator.d.ts b/types/generators/BotWeaponGenerator.d.ts index 487901b..938d61c 100644 --- a/types/generators/BotWeaponGenerator.d.ts +++ b/types/generators/BotWeaponGenerator.d.ts @@ -12,9 +12,12 @@ 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 { BotWeaponModLimitService } from "../services/BotWeaponModLimitService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; +import { BotEquipmentModGenerator } from "./BotEquipmentModGenerator"; import { IInventoryMagGen } from "./weapongen/IInventoryMagGen"; export declare class BotWeaponGenerator { protected jsonUtil: JsonUtil; @@ -27,10 +30,13 @@ export declare class BotWeaponGenerator { protected randomUtil: RandomUtil; protected configServer: ConfigServer; protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + protected botWeaponModLimitService: BotWeaponModLimitService; + protected botEquipmentModGenerator: BotEquipmentModGenerator; + protected localisationService: LocalisationService; protected inventoryMagGenComponents: IInventoryMagGen[]; protected readonly modMagazineSlotId = "mod_magazine"; protected botConfig: IBotConfig; - constructor(jsonUtil: JsonUtil, logger: ILogger, hashUtil: HashUtil, databaseServer: DatabaseServer, itemHelper: ItemHelper, weightedRandomHelper: WeightedRandomHelper, botGeneratorHelper: BotGeneratorHelper, randomUtil: RandomUtil, configServer: ConfigServer, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, inventoryMagGenComponents: IInventoryMagGen[]); + constructor(jsonUtil: JsonUtil, logger: ILogger, hashUtil: HashUtil, databaseServer: DatabaseServer, itemHelper: ItemHelper, weightedRandomHelper: WeightedRandomHelper, botGeneratorHelper: BotGeneratorHelper, randomUtil: RandomUtil, configServer: ConfigServer, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botWeaponModLimitService: BotWeaponModLimitService, botEquipmentModGenerator: BotEquipmentModGenerator, localisationService: LocalisationService, inventoryMagGenComponents: IInventoryMagGen[]); /** * Pick a random weapon based on weightings and generate a functional weapon * @param equipmentSlot Primary/secondary/holster @@ -41,7 +47,7 @@ export declare class BotWeaponGenerator { * @param isPmc Is weapon generated for a pmc * @returns GenerateWeaponResult object */ - generateRandomWeapon(sessionId: string, equipmentSlot: string, botTemplateInventory: Inventory, weaponParentId: string, modChances: ModsChances, botRole: string, isPmc: boolean): GenerateWeaponResult; + generateRandomWeapon(sessionId: string, equipmentSlot: string, botTemplateInventory: Inventory, weaponParentId: string, modChances: ModsChances, botRole: string, isPmc: boolean, botLevel: number): GenerateWeaponResult; /** * Get a random weighted weapon from a bots pool of weapons * @param equipmentSlot Primary/secondary/holster @@ -60,7 +66,7 @@ export declare class BotWeaponGenerator { * @param isPmc * @returns GenerateWeaponResult object */ - generateWeaponByTpl(sessionId: string, weaponTpl: string, equipmentSlot: string, botTemplateInventory: Inventory, weaponParentId: string, modChances: ModsChances, botRole: string, isPmc: boolean): GenerateWeaponResult; + generateWeaponByTpl(sessionId: string, weaponTpl: string, equipmentSlot: string, botTemplateInventory: Inventory, weaponParentId: string, modChances: ModsChances, botRole: string, isPmc: boolean, botLevel: number): GenerateWeaponResult; /** * Create array with weapon base as only element and * add additional properties based on weapon type diff --git a/types/generators/FenceBaseAssortGenerator.d.ts b/types/generators/FenceBaseAssortGenerator.d.ts new file mode 100644 index 0000000..387df3a --- /dev/null +++ b/types/generators/FenceBaseAssortGenerator.d.ts @@ -0,0 +1,28 @@ +import { HandbookHelper } from "../helpers/HandbookHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { ITraderConfig } from "../models/spt/config/ITraderConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { ItemFilterService } from "../services/ItemFilterService"; +export declare class FenceBaseAssortGenerator { + protected logger: ILogger; + protected databaseServer: DatabaseServer; + protected handbookHelper: HandbookHelper; + protected itemHelper: ItemHelper; + protected itemFilterService: ItemFilterService; + protected configServer: ConfigServer; + protected traderConfig: ITraderConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, itemHelper: ItemHelper, itemFilterService: ItemFilterService, configServer: ConfigServer); + /** + * Create base fence assorts dynamically and store in db + */ + generateFenceBaseAssorts(): void; + /** + * Check if item is valid for being added to fence assorts + * @param item Item to check + * @returns true if valid fence item + */ + protected isValidFenceItem(item: ITemplateItem): boolean; +} diff --git a/types/generators/LocationGenerator.d.ts b/types/generators/LocationGenerator.d.ts index cc61dcf..a80ae3c 100644 --- a/types/generators/LocationGenerator.d.ts +++ b/types/generators/LocationGenerator.d.ts @@ -1,5 +1,4 @@ import { ContainerHelper } from "../helpers/ContainerHelper"; -import { GameEventHelper } from "../helpers/GameEventHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; import { RagfairServerHelper } from "../helpers/RagfairServerHelper"; @@ -9,6 +8,8 @@ import { IStaticAmmoDetails, IStaticContainerProps, IStaticForcedProps, IStaticL import { ILocationConfig } from "../models/spt/config/ILocationConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; +import { LocalisationService } from "../services/LocalisationService"; +import { SeasonalEventService } from "../services/SeasonalEventService"; import { JsonUtil } from "../utils/JsonUtil"; import { MathUtil } from "../utils/MathUtil"; import { ObjectId } from "../utils/ObjectId"; @@ -26,12 +27,13 @@ export declare class LocationGenerator { protected ragfairServerHelper: RagfairServerHelper; protected itemHelper: ItemHelper; protected mathUtil: MathUtil; - protected gameEventHelper: GameEventHelper; + protected seasonalEventService: SeasonalEventService; protected containerHelper: ContainerHelper; protected presetHelper: PresetHelper; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected locationConfig: ILocationConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, objectId: ObjectId, randomUtil: RandomUtil, ragfairServerHelper: RagfairServerHelper, itemHelper: ItemHelper, mathUtil: MathUtil, gameEventHelper: GameEventHelper, containerHelper: ContainerHelper, presetHelper: PresetHelper, configServer: ConfigServer); + constructor(logger: ILogger, jsonUtil: JsonUtil, objectId: ObjectId, randomUtil: RandomUtil, ragfairServerHelper: RagfairServerHelper, itemHelper: ItemHelper, mathUtil: MathUtil, seasonalEventService: SeasonalEventService, containerHelper: ContainerHelper, presetHelper: PresetHelper, localisationService: LocalisationService, configServer: ConfigServer); generateContainerLoot(containerIn: IStaticContainerProps, staticForced: IStaticForcedProps[], staticLootDist: Record, staticAmmoDist: Record, locationName: string): IStaticContainerProps; protected getLooseLootMultiplerForLocation(location: string): number; protected getStaticLootMultiplerForLocation(location: string): number; diff --git a/types/generators/LootGenerator.d.ts b/types/generators/LootGenerator.d.ts index 94f1c65..0d2ef24 100644 --- a/types/generators/LootGenerator.d.ts +++ b/types/generators/LootGenerator.d.ts @@ -6,6 +6,7 @@ import { LootRequest } from "../models/spt/services/LootRequest"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { ItemFilterService } from "../services/ItemFilterService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { RandomUtil } from "../utils/RandomUtil"; export declare class LootGenerator { @@ -14,11 +15,12 @@ export declare class LootGenerator { protected databaseServer: DatabaseServer; protected randomUtil: RandomUtil; protected itemHelper: ItemHelper; + protected localisationService: LocalisationService; protected itemFilterService: ItemFilterService; - constructor(logger: ILogger, hashUtil: HashUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, itemHelper: ItemHelper, itemFilterService: ItemFilterService); + constructor(logger: ILogger, hashUtil: HashUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, itemHelper: ItemHelper, localisationService: LocalisationService, itemFilterService: ItemFilterService); /** - * Generate a list of items based on options passed in - * @param options parameters to adjust what loot is generated + * Generate a list of items based on configuration options parameter + * @param options parameters to adjust how loot is generated * @returns An array of loot items */ createRandomloot(options: LootRequest): LootItem[]; @@ -35,23 +37,31 @@ export declare class LootGenerator { * Find a random item in items.json and add to result array * @param items items to choose from * @param itemTypeCounts item limit counts + * @param options item filters * @param result array to add found item to * @returns true if item was valid and added to pool */ protected findAndAddRandomItemToLoot(items: [string, ITemplateItem][], itemTypeCounts: Record, whitelistedArmorLevels: number[], result: LootItem[]): boolean; + }>, options: LootRequest, result: LootItem[]): boolean; + /** + * Get a randomised stack count for an item between its StackMinRandom and StackMaxSize values + * @param item item to get stack count of + * @param options loot options + * @returns stack count + */ + protected getRandomisedStackCount(item: ITemplateItem, options: LootRequest): number; /** - * * Find a random item in items.json and add to result array * @param globalDefaultPresets presets to choose from * @param itemTypeCounts item limit counts + * @param itemBlacklist items to skip * @param result array to add found preset to * @returns true if preset was valid and added to pool */ protected findAndAddRandomPresetToLoot(globalDefaultPresets: [string, Preset][], itemTypeCounts: Record, result: LootItem[]): boolean; + }>, itemBlacklist: string[], result: LootItem[]): boolean; } diff --git a/types/generators/PlayerScavGenerator.d.ts b/types/generators/PlayerScavGenerator.d.ts index bb2c730..9fee88b 100644 --- a/types/generators/PlayerScavGenerator.d.ts +++ b/types/generators/PlayerScavGenerator.d.ts @@ -10,6 +10,7 @@ import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { BotLootCacheService } from "../services/BotLootCacheService"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { JsonUtil } from "../utils/JsonUtil"; import { BotGenerator } from "./BotGenerator"; export declare class PlayerScavGenerator { @@ -21,10 +22,11 @@ export declare class PlayerScavGenerator { protected jsonUtil: JsonUtil; protected fenceService: FenceService; protected botLootCacheService: BotLootCacheService; + protected localisationService: LocalisationService; protected botGenerator: BotGenerator; protected configServer: ConfigServer; protected playerScavConfig: IPlayerScavConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, botHelper: BotHelper, jsonUtil: JsonUtil, fenceService: FenceService, botLootCacheService: BotLootCacheService, botGenerator: BotGenerator, configServer: ConfigServer); + constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, botHelper: BotHelper, jsonUtil: JsonUtil, fenceService: FenceService, botLootCacheService: BotLootCacheService, localisationService: LocalisationService, botGenerator: BotGenerator, configServer: ConfigServer); /** * Update a player profile to include a new player scav profile * @param sessionID session id to specify what profile is updated diff --git a/types/generators/RagfairOfferGenerator.d.ts b/types/generators/RagfairOfferGenerator.d.ts index 317cd6b..338cd5c 100644 --- a/types/generators/RagfairOfferGenerator.d.ts +++ b/types/generators/RagfairOfferGenerator.d.ts @@ -1,16 +1,19 @@ +import { HandbookHelper } from "../helpers/HandbookHelper"; import { ItemHelper } from "../helpers/ItemHelper"; +import { PaymentHelper } from "../helpers/PaymentHelper"; import { PresetHelper } from "../helpers/PresetHelper"; import { RagfairServerHelper } from "../helpers/RagfairServerHelper"; import { Item } from "../models/eft/common/tables/IItem"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { IBarterScheme } from "../models/eft/common/tables/ITrader"; -import { IRagfairOffer } from "../models/eft/ragfair/IRagfairOffer"; -import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; +import { IRagfairOffer, OfferRequirement } from "../models/eft/ragfair/IRagfairOffer"; +import { Dynamic, IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { RagfairCategoriesService } from "../services/RagfairCategoriesService"; import { RagfairOfferService } from "../services/RagfairOfferService"; import { RagfairPriceService } from "../services/RagfairPriceService"; @@ -27,18 +30,45 @@ export declare class RagfairOfferGenerator { protected timeUtil: TimeUtil; protected databaseServer: DatabaseServer; protected ragfairServerHelper: RagfairServerHelper; + protected handbookHelper: HandbookHelper; protected saveServer: SaveServer; protected presetHelper: PresetHelper; protected ragfairAssortGenerator: RagfairAssortGenerator; protected ragfairOfferService: RagfairOfferService; protected ragfairPriceService: RagfairPriceService; + protected localisationService: LocalisationService; + protected paymentHelper: PaymentHelper; protected ragfairCategoriesService: RagfairCategoriesService; protected fenceService: FenceService; protected itemHelper: ItemHelper; protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, hashUtil: HashUtil, randomUtil: RandomUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, ragfairServerHelper: RagfairServerHelper, saveServer: SaveServer, presetHelper: PresetHelper, ragfairAssortGenerator: RagfairAssortGenerator, ragfairOfferService: RagfairOfferService, ragfairPriceService: RagfairPriceService, ragfairCategoriesService: RagfairCategoriesService, fenceService: FenceService, itemHelper: ItemHelper, configServer: ConfigServer); + protected allowedFleaPriceItemsForBarter: { + tpl: string; + price: number; + }[]; + constructor(logger: ILogger, jsonUtil: JsonUtil, hashUtil: HashUtil, randomUtil: RandomUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, ragfairServerHelper: RagfairServerHelper, handbookHelper: HandbookHelper, saveServer: SaveServer, presetHelper: PresetHelper, ragfairAssortGenerator: RagfairAssortGenerator, ragfairOfferService: RagfairOfferService, ragfairPriceService: RagfairPriceService, localisationService: LocalisationService, paymentHelper: PaymentHelper, ragfairCategoriesService: RagfairCategoriesService, fenceService: FenceService, itemHelper: ItemHelper, configServer: ConfigServer); createOffer(userID: string, time: number, items: Item[], barterScheme: IBarterScheme[], loyalLevel: number, price: number, sellInOnePiece?: boolean): IRagfairOffer; + /** + * Calculate the offer price that's listed on the flea listing + * @param offerRequirements barter requirements for offer + * @returns rouble cost of offer + */ + protected calculateOfferListingPrice(offerRequirements: OfferRequirement[]): number; + /** + * Get avatar url from trader table in db + * @param isTrader Is user we're getting avatar for a trader + * @param userId persons id to get avatar of + * @returns url of avatar + */ + protected getAvatarUrl(isTrader: boolean, userId: string): string; + /** + * Convert a count of currency into roubles + * @param currencyCount amount of currency to convert into roubles + * @param currencyType Type of currency (euro/dollar/rouble) + * @returns count of roubles + */ + protected calculateRoublePrice(currencyCount: number, currencyType: string): number; protected getTraderId(userID: string): string; protected getRating(userID: string): number; /** @@ -58,7 +88,16 @@ export declare class RagfairOfferGenerator { * Create multiple offers for items by using a unique list of items we've generated previously * @param expiredOffers optional, expired offers to regenerate */ - generateDynamicOffers(expiredOffers?: Item[]): void; + generateDynamicOffers(expiredOffers?: Item[]): Promise; + protected createOffersForItems(assortItemIndex: string, assortItemsToProcess: Item[], expiredOffers: Item[], config: Dynamic): Promise; + /** + * Create one flea offer for a specific item + * @param items Item to create offer for + * @param isPreset Is item a weapon preset + * @param itemDetails raw db item details + * @returns + */ + protected createSingleOfferForItem(items: Item[], isPreset: boolean, itemDetails: [boolean, ITemplateItem]): Promise; /** * Generate trader offers on flea using the traders assort data * @param traderID Trader to generate offers for @@ -73,20 +112,36 @@ export declare class RagfairOfferGenerator { * @returns Item with conditions added */ protected addMissingCondition(item: Item): Item; - protected getOfferRequirements(items: Item[]): { - count: number; - _tpl: string; + /** + * Create a barter-based barter scheme, if not possible, fall back to making barter scheme currency based + * @param offerItems Items for sale in offer + * @returns barter scheme + */ + protected createBarterRequirement(offerItems: Item[]): IBarterScheme[]; + /** + * Get an array of flea prices + item tpl, cached in generator class inside `allowedFleaPriceItemsForBarter` + * @returns array with tpl/price values + */ + protected getFleaPricesAsArray(): { + tpl: string; + price: number; }[]; + /** + * Create a random currency-based barter scheme for an array of items + * @param offerItems Items on offer + * @returns Barter scheme for offer + */ + protected createCurrencyRequirement(offerItems: Item[]): IBarterScheme[]; /** * Create a flea offer and store it in the Ragfair server offers array * @param userID owner of the offer * @param time time offer is put up * @param items items in the offer - * @param barterScheme - * @param loyalLevel + * @param barterScheme cost of item (currency or barter) + * @param loyalLevel Loyalty level needed to buy item * @param price price of offer * @param sellInOnePiece - * @returns + * @returns Ragfair offer */ createFleaOffer(userID: string, time: number, items: Item[], barterScheme: IBarterScheme[], loyalLevel: number, price: number, sellInOnePiece?: boolean): IRagfairOffer; } diff --git a/types/generators/ScavCaseRewardGenerator.d.ts b/types/generators/ScavCaseRewardGenerator.d.ts index 89cb5c8..f9ac623 100644 --- a/types/generators/ScavCaseRewardGenerator.d.ts +++ b/types/generators/ScavCaseRewardGenerator.d.ts @@ -37,12 +37,6 @@ export declare class ScavCaseRewardGenerator { * @returns filtered array of db items */ protected getDbItems(): ITemplateItem[]; - /** - * Check if a template id has a blacklisted parent id - * @param tplid template id to check - * @returns true if item is blacklisted - */ - protected itemHasBlacklistedParent(tplid: string): boolean; /** * Pick a number of items to be rewards, the count is defined by the values in * @param items item pool to pick rewards from diff --git a/types/generators/WeatherGenerator.d.ts b/types/generators/WeatherGenerator.d.ts index 8ddbe49..65d2c76 100644 --- a/types/generators/WeatherGenerator.d.ts +++ b/types/generators/WeatherGenerator.d.ts @@ -1,38 +1,54 @@ +import { ApplicationContext } from "../context/ApplicationContext"; import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; -import { IWeatherData } from "../models/eft/weather/IWeatherData"; +import { IWeather, IWeatherData } from "../models/eft/weather/IWeatherData"; +import { WindDirection } from "../models/enums/WindDirection"; import { IWeatherConfig } from "../models/spt/config/IWeatherConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; export declare class WeatherGenerator { protected weightedRandomHelper: WeightedRandomHelper; + protected logger: ILogger; protected randomUtil: RandomUtil; protected timeUtil: TimeUtil; + protected applicationContext: ApplicationContext; protected configServer: ConfigServer; protected weatherConfig: IWeatherConfig; - constructor(weightedRandomHelper: WeightedRandomHelper, randomUtil: RandomUtil, timeUtil: TimeUtil, configServer: ConfigServer); - calculateTime(data: IWeatherData): IWeatherData; + constructor(weightedRandomHelper: WeightedRandomHelper, logger: ILogger, randomUtil: RandomUtil, timeUtil: TimeUtil, applicationContext: ApplicationContext, configServer: ConfigServer); + calculateGameTime(data: IWeatherData): IWeatherData; /** * Get server uptime seconds multiplied by a multiplier and add to current time as seconds * Format to BSGs requirements - * @param computedDate current date + * @param currentDate current date * @returns formatted time */ - protected getAcceleratedTime(computedDate: Date): string; + protected getBsgFormattedInRaidTime(currentDate: Date): string; + /** + * Get the current in-raid time + * @param currentDate (new Date()) + * @returns Date object of current in-raid time + */ + getInRaidTime(currentDate: Date): Date; /** * Get current time formatted to fit BSGs requirement - * @param computedDate date to format into bsg style + * @param date date to format into bsg style * @returns */ - protected getNormalTime(computedDate: Date): string; + protected getBSGFormattedTime(date: Date): string; /** - * Return randomised Weather data - * @param weatherData weather input data + * Return randomised Weather data with help of config/weather.json * @returns Randomised weather data */ - generateWeather(weatherData: IWeatherData): IWeatherData; - protected getWeightedFog(): string; + generateWeather(): IWeather; + /** + * Set IWeather date/time/timestamp values to now + * @param weather Object to update + */ + protected setCurrentDateTime(weather: IWeather): void; + protected getWeightedWindDirection(): WindDirection; + protected getWeightedWindSpeed(): number; + protected getWeightedFog(): number; protected getWeightedRain(): number; protected getRandomFloat(node: string): number; - protected getRandomInt(node: string): number; } diff --git a/types/generators/weapongen/implementations/ExternalInventoryMagGen.d.ts b/types/generators/weapongen/implementations/ExternalInventoryMagGen.d.ts index 4fcb1e2..1589707 100644 --- a/types/generators/weapongen/implementations/ExternalInventoryMagGen.d.ts +++ b/types/generators/weapongen/implementations/ExternalInventoryMagGen.d.ts @@ -1,13 +1,15 @@ import { BotWeaponGeneratorHelper } from "../../../helpers/BotWeaponGeneratorHelper"; import { ItemHelper } from "../../../helpers/ItemHelper"; import { ILogger } from "../../../models/spt/utils/ILogger"; +import { LocalisationService } from "../../../services/LocalisationService"; import { IInventoryMagGen } from "../IInventoryMagGen"; import { InventoryMagGen } from "../InventoryMagGen"; export declare class ExternalInventoryMagGen implements IInventoryMagGen { protected logger: ILogger; protected itemHelper: ItemHelper; + protected localisationService: LocalisationService; protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; - constructor(logger: ILogger, itemHelper: ItemHelper, botWeaponGeneratorHelper: BotWeaponGeneratorHelper); + constructor(logger: ILogger, itemHelper: ItemHelper, localisationService: LocalisationService, botWeaponGeneratorHelper: BotWeaponGeneratorHelper); getPriority(): number; canHandleInventoryMagGen(inventoryMagGen: InventoryMagGen): boolean; process(inventoryMagGen: InventoryMagGen): void; diff --git a/types/helpers/AssortHelper.d.ts b/types/helpers/AssortHelper.d.ts index bfc157f..de8b5bf 100644 --- a/types/helpers/AssortHelper.d.ts +++ b/types/helpers/AssortHelper.d.ts @@ -2,14 +2,16 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { ITraderAssort } from "../models/eft/common/tables/ITrader"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { ItemHelper } from "./ItemHelper"; import { QuestHelper } from "./QuestHelper"; export declare class AssortHelper { protected logger: ILogger; protected itemHelper: ItemHelper; protected databaseServer: DatabaseServer; + protected localisationService: LocalisationService; protected questHelper: QuestHelper; - constructor(logger: ILogger, itemHelper: ItemHelper, databaseServer: DatabaseServer, questHelper: QuestHelper); + constructor(logger: ILogger, itemHelper: ItemHelper, databaseServer: DatabaseServer, localisationService: LocalisationService, questHelper: QuestHelper); /** * Remove assorts from a trader that have not been unlocked yet * @param pmcProfile player profile diff --git a/types/helpers/BotDifficultyHelper.d.ts b/types/helpers/BotDifficultyHelper.d.ts new file mode 100644 index 0000000..a58ebdb --- /dev/null +++ b/types/helpers/BotDifficultyHelper.d.ts @@ -0,0 +1,46 @@ +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 { LocalisationService } from "../services/LocalisationService"; +import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; +import { BotHelper } from "./BotHelper"; +export declare class BotDifficultyHelper { + protected logger: ILogger; + protected jsonUtil: JsonUtil; + protected databaseServer: DatabaseServer; + protected randomUtil: RandomUtil; + protected localisationService: LocalisationService; + protected botHelper: BotHelper; + protected configServer: ConfigServer; + protected botConfig: IBotConfig; + constructor(logger: ILogger, jsonUtil: JsonUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, localisationService: LocalisationService, botHelper: BotHelper, configServer: ConfigServer); + getPmcDifficultySettings(pmcType: "bear" | "usec", difficulty: string, usecType: string, bearType: string): Difficulty; + /** + * Get difficulty settings for desired bot type, if not found use assault bot types + * @param type bot type to retreive difficulty of + * @param difficulty difficulty to get settings for (easy/normal etc) + * @returns Difficulty object + */ + getBotDifficultySettings(type: string, difficulty: string): Difficulty; + /** + * Get difficulty settings for a PMC + * @param type "usec" / "bear" + * @param difficulty what difficulty to retrieve + * @returns Difficulty object + */ + protected getDifficultySettings(type: string, difficulty: string): Difficulty; + /** + * Translate chosen value from pre-raid difficulty dropdown into bot difficulty value + * @param dropDownDifficulty Dropdown difficulty value to convert + * @returns bot difficulty + */ + convertBotDifficultyDropdownToBotDifficulty(dropDownDifficulty: string): string; + /** + * Choose a random difficulty from - easy/normal/hard/impossible + * @returns random difficulty + */ + chooseRandomDifficulty(): string; +} diff --git a/types/helpers/BotGeneratorHelper.d.ts b/types/helpers/BotGeneratorHelper.d.ts index 5e3e501..d9ce968 100644 --- a/types/helpers/BotGeneratorHelper.d.ts +++ b/types/helpers/BotGeneratorHelper.d.ts @@ -1,209 +1,42 @@ import { DurabilityLimitsHelper } from "../helpers/DurabilityLimitsHelper"; -import { Mods, ModsChances } from "../models/eft/common/tables/IBotType"; import { Item, Repairable, Upd } from "../models/eft/common/tables/IItem"; -import { ITemplateItem, Slot } from "../models/eft/common/tables/ITemplateItem"; -import { EquipmentFilterDetails, IBotConfig } from "../models/spt/config/IBotConfig"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { EquipmentFilters, IBotConfig } from "../models/spt/config/IBotConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; -import { BotEquipmentFilterService } from "../services/BotEquipmentFilterService"; -import { ItemFilterService } from "../services/ItemFilterService"; -import { HashUtil } from "../utils/HashUtil"; +import { LocalisationService } from "../services/LocalisationService"; import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; -import { BotWeaponGeneratorHelper } from "./BotWeaponGeneratorHelper"; -import { ContainerHelper } from "./ContainerHelper"; -import { InventoryHelper } from "./InventoryHelper"; import { ItemHelper } from "./ItemHelper"; -import { ProbabilityHelper } from "./ProbabilityHelper"; -import { ProfileHelper } from "./ProfileHelper"; -export declare class BotModLimits { - scope: ItemCount; - scopeMax: number; - scopeBaseTypes: string[]; - flashlightLaser: ItemCount; - flashlightLaserMax: number; - flashlgihtLaserBaseTypes: string[]; -} -export declare class ItemCount { - count: number; -} export declare class BotGeneratorHelper { protected logger: ILogger; - protected jsonUtil: JsonUtil; - protected hashUtil: HashUtil; protected randomUtil: RandomUtil; - protected probabilityHelper: ProbabilityHelper; protected databaseServer: DatabaseServer; protected durabilityLimitsHelper: DurabilityLimitsHelper; protected itemHelper: ItemHelper; - protected inventoryHelper: InventoryHelper; - protected containerHelper: ContainerHelper; - protected botEquipmentFilterService: BotEquipmentFilterService; - protected itemFilterService: ItemFilterService; - protected profileHelper: ProfileHelper; - protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected botConfig: IBotConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, hashUtil: HashUtil, randomUtil: RandomUtil, probabilityHelper: ProbabilityHelper, databaseServer: DatabaseServer, durabilityLimitsHelper: DurabilityLimitsHelper, itemHelper: ItemHelper, inventoryHelper: InventoryHelper, containerHelper: ContainerHelper, botEquipmentFilterService: BotEquipmentFilterService, itemFilterService: ItemFilterService, profileHelper: ProfileHelper, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, configServer: ConfigServer); - /** - * Check mods are compatible and add to array - * @param equipment Equipment item to add mods to - * @param modPool Mod list to choose frm - * @param parentId parentid of item to add mod to - * @param parentTemplate template objet of item to add mods to - * @param modSpawnChances dictionary of mod items and their chance to spawn for this bot type - * @returns Item + compatible mods as an array - */ - generateModsForEquipment(equipment: Item[], modPool: Mods, parentId: string, parentTemplate: ITemplateItem, modSpawnChances: ModsChances): Item[]; - /** - * @param sessionId session id - * @param weapon Weapon to add mods to - * @param modPool Pool of compatible mods to attach to weapon - * @param weaponParentId parentId of weapon - * @param parentWeaponTemplate Weapon which mods will be generated on - * @param modSpawnChances Mod spawn chances - * @param ammoTpl Ammo tpl to use when generating magazines/cartridges - * @param botRole Role of bot weapon is generated for - * @returns Weapon + mods array - */ - generateModsForWeapon(sessionId: string, weapon: Item[], modPool: Mods, weaponParentId: string, parentWeaponTemplate: ITemplateItem, modSpawnChances: ModsChances, ammoTpl: string, botRole: string): Item[]; - /** - * - * @param modSlot - * @param isRandomisableSlot - * @param modsParent - * @param botEquipBlacklist - * @param itemModPool - * @param weapon array with only weapon tpl in it, ready for mods to be added - * @param ammoTpl ammo tpl to use if slot requires a cartridge to be added (e.g. mod_magazine) - * @param parentTemplate - * @returns - */ - protected chooseModToPutIntoSlot(modSlot: string, isRandomisableSlot: boolean, modsParent: Slot, botEquipBlacklist: EquipmentFilterDetails, itemModPool: Record, weapon: Item[], ammoTpl: string, parentTemplate: ITemplateItem): [boolean, ITemplateItem]; - /** - * Find mod tpls of a provided type and add to modPool - * @param desiredSlotName slot to look up and add we are adding tpls for (e.g mod_scope) - * @param modTemplate db object for modItem we get compatible mods from - * @param modPool Pool of mods we are adding to - */ - protected addCompatibleModsForProvidedMod(desiredSlotName: string, modTemplate: ITemplateItem, modPool: Mods, botEquipBlacklist: EquipmentFilterDetails): void; - /** - * Check if mod item is on limited list + has surpassed the limit set for it - * @param botRole role the bot has e.g. assault - * @param modTemplate mods template data - * @param modLimits limits set for weapon being generated for this bot - * @returns true if over item limit - */ - protected modHasReachedItemLimit(botRole: string, modTemplate: ITemplateItem, modLimits: BotModLimits): boolean; - /** - * Initalise mod limits to be used when generating a weapon - * @param botRole "assault", "bossTagilla" or "pmc" - * @returns BotModLimits object - */ - protected initModLimits(botRole: string): BotModLimits; - /** - * Generate a pool of mods for this bots mod type if bot has values inside `randomisedWeaponModSlots` array found in bot.json/equipment[botrole] - * @param allowedMods Mods to be added to mod pool - * @param botEquipBlacklist blacklist of items not allowed to be added to mod pool - * @param modSlot Slot to generate mods for - * @param itemModPool base mod pool to replace values of - */ - protected generateDynamicWeaponModPool(allowedMods: string[], botEquipBlacklist: EquipmentFilterDetails, modSlot: string, itemModPool: Record): void; - /** - * Find all compatible mods for equipment item and add to modPool - * @param itemDetails item to find mods for - * @param modPool ModPool to add mods to - */ - generateDynamicModPool(itemDetails: ITemplateItem, modPool: Mods): void; - /** - * Take a list of tpls and filter out blacklisted values using itemFilterService + botEquipmentBlacklist - * @param allowedMods base mods to filter - * @param botEquipBlacklist equipment blacklist - * @param modSlot slot mods belong to - * @returns Filtered array of mod tpls - */ - protected filterWeaponModsByBlacklist(allowedMods: string[], botEquipBlacklist: EquipmentFilterDetails, modSlot: string): string[]; - /** - * Check if the specific item type on the weapon has reached the set limit - * @param modTpl log mod tpl if over type limit - * @param currentCount current number of this item on gun - * @param maxLimit mod limit allowed - * @param botRole role of bot we're checking weapon of - * @returns true if limit reached - */ - protected weaponModLimitReached(modTpl: string, currentCount: { - count: number; - }, maxLimit: number, botRole: string): boolean; - /** - * Log errors if mod is not compatible with slot - * @param modToAdd template of mod to check - * @param itemSlot slot the item will be placed in - * @param modSlot slot the mod will fill - * @param parentTemplate tempalte of the mods parent item - * @returns true if valid - */ - protected isModValidForSlot(modToAdd: [boolean, ITemplateItem], itemSlot: Slot, modSlot: string, parentTemplate: ITemplateItem): boolean; - /** - * Create a mod item with parameters as properties - * @param modId _id - * @param modTpl _tpl - * @param parentId parentId - * @param modSlot slotId - * @param modTemplate Used to add additional properites in the upd object - * @returns Item object - */ - protected createModItem(modId: string, modTpl: string, parentId: string, modSlot: string, modTemplate: ITemplateItem): Item; - /** - * randomly choose if a mod should be spawned, 100% for required mods OR mod is ammo slot - * never return true for an item that has 0% spawn chance - * @param itemSlot slot the item sits in - * @param modSlot slot the mod sits in - * @param modSpawnChances Chances for various mod spawns - * @returns boolean true if it should spawn - */ - protected shouldModBeSpawned(itemSlot: Slot, modSlot: string, modSpawnChances: ModsChances): boolean; - /** - * Get a list of containers that hold ammo - * e.g. mod_magazine / patron_in_weapon_000 - * @returns string array - */ - protected getAmmoContainers(): string[]; - /** - * Get the slot details for an item (chamber/cartridge/slot) - * @param modSlot e.g patron_in_weapon - * @param parentTemplate item template - * @returns - */ - protected getModItemSlot(modSlot: string, parentTemplate: ITemplateItem): Slot; - /** - * With the shotgun revolver (60db29ce99594040e04c4a27) 12.12 introduced CylinderMagazines. - * Those magazines (e.g. 60dc519adf4c47305f6d410d) have a "Cartridges" entry with a _max_count=0. - * Ammo is not put into the magazine directly but assigned to the magazine's slots: The "camora_xxx" slots. - * This function is a helper called by generateModsForItem for mods with parent type "CylinderMagazine" - * @param items The items where the CylinderMagazine's camora are appended to - * @param modPool modPool which should include available cartrigdes - * @param parentId The CylinderMagazine's UID - * @param parentTemplate The CylinderMagazine's template - * @returns - */ - protected fillCamora(items: Item[], modPool: Mods, parentId: string, parentTemplate: ITemplateItem): void; - /** - * Take a record of camoras and merge the compatable shells into one array - * @param camorasWithShells camoras we want to merge into one array - * @returns string array of shells fro luitple camora sources - */ - protected mergeCamoraPoolsTogether(camorasWithShells: Record): string[]; + constructor(logger: ILogger, randomUtil: RandomUtil, databaseServer: DatabaseServer, durabilityLimitsHelper: DurabilityLimitsHelper, itemHelper: ItemHelper, localisationService: LocalisationService, configServer: ConfigServer); /** * Adds properties to an item * e.g. Repairable / HasHinge / Foldable / MaxDurability - * @param itemTemplate - * @param botRole Used by weapons to randomise the durability values + * @param itemTemplate Item extra properties are being generated for + * @param botRole Used by weapons to randomise the durability values. Null for non-equipped items * @returns Item Upd object with extra properties */ - generateExtraPropertiesForItem(itemTemplate: ITemplateItem, botRole?: any): { + generateExtraPropertiesForItem(itemTemplate: ITemplateItem, botRole?: string): { upd?: Upd; }; + /** + * Get the chance for the weapon attachment or helmet equipment to be set as activated + * @param botRole role of bot with weapon/helmet + * @param setting the setting of the weapon attachment/helmet equipment to be activated + * @param defaultValue default value for the chance of activation if the botrole or bot equipment role is null + * @returns Percent chance to be active + */ + protected getBotEquipmentSettingFromConfig(botRole: string, setting: keyof EquipmentFilters, defaultValue: number): number; /** * Create a repairable object for a weapon that containers durability + max durability properties * @param itemTemplate weapon object being generated for @@ -219,22 +52,22 @@ export declare class BotGeneratorHelper { */ protected generateArmorRepairableProperties(itemTemplate: ITemplateItem, botRole: string): Repairable; /** - * Get a random mod from an items compatible mods Filter array - * @param modTpl - * @param parentSlot - * @param modSlot - * @param items - * @returns item tpl + * Can item be added to another item without conflict + * @param items Items to check compatiblilities with + * @param tplToCheck Tpl of the item to check for incompatibilities + * @param equipmentSlot Slot the item will be placed into + * @returns false if no incompatibilties, also has incompatibility reason */ - protected getModTplFromItemDb(modTpl: string, parentSlot: Slot, modSlot: string, items: Item[]): string; + isItemIncompatibleWithCurrentItems(items: Item[], tplToCheck: string, equipmentSlot: string): { + incompatible: boolean; + reason: string; + }; /** - * Can an item be added to an item without issue - * @param items - * @param tplToCheck - * @param equipmentSlot - * @returns true if possible + * Convert a bots role to the equipment role used in config/bot.json + * @param botRole Role to convert + * @returns Equipment role (e.g. pmc / assault / bossTagilla) */ - isItemIncompatibleWithCurrentItems(items: Item[], tplToCheck: string, equipmentSlot: string): boolean; + getBotEquipmentRole(botRole: string): string; } /** TODO - move into own class */ export declare class ExhaustableArray { diff --git a/types/helpers/BotHelper.d.ts b/types/helpers/BotHelper.d.ts index 18738e5..9a43b8e 100644 --- a/types/helpers/BotHelper.d.ts +++ b/types/helpers/BotHelper.d.ts @@ -1,8 +1,10 @@ +import { MinMax } from "../models/common/MinMax"; import { Difficulty, IBotType } from "../models/eft/common/tables/IBotType"; -import { IBotConfig } from "../models/spt/config/IBotConfig"; +import { EquipmentFilters, IBotConfig, RandomisationDetails } from "../models/spt/config/IBotConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; export declare class BotHelper { @@ -10,40 +12,27 @@ export declare class BotHelper { protected jsonUtil: JsonUtil; protected databaseServer: DatabaseServer; protected randomUtil: RandomUtil; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected botConfig: IBotConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, configServer: ConfigServer); - /** - * Get difficulty settings for desired bot type, if not found use assault bot types - * @param type bot type to retreive difficulty of - * @param difficulty difficulty to get settings for (easy/normal etc) - * @returns Difficulty object - */ - getBotDifficultySettings(type: string, difficulty: string): Difficulty; + constructor(logger: ILogger, jsonUtil: JsonUtil, databaseServer: DatabaseServer, randomUtil: RandomUtil, localisationService: LocalisationService, 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; - /** - * Get difficulty settings for a PMC - * @param type "usec" / "bear" - * @param difficulty what difficulty to retrieve - * @returns Difficulty object - */ - getPmcDifficultySettings(type: string, difficulty: string): Difficulty; - /** - * Choose a random difficulty from - easy/normal/hard/impossible - * @returns random difficulty - */ - chooseRandomDifficulty(): string; /** * Randomise the chance the PMC will attack their own side * Look up value in bot.json/chanceSameSideIsHostilePercent * @param difficultySettings pmc difficulty settings */ randomisePmcHostility(difficultySettings: Difficulty): void; + /** + * 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; @@ -71,4 +60,29 @@ export declare class BotHelper { * @returns true if should be a pmc */ shouldBotBePmc(botRole: string): boolean; + rollChanceToBePmc(role: string, botConvertMinMax: MinMax): boolean; + botRoleIsPmc(botRole: string): boolean; + /** + * Get randomisation settings for bot from config/bot.json + * @param botLevel level of bot + * @param botEquipConfig bot equipment json + * @returns RandomisationDetails + */ + getBotRandomisationDetails(botLevel: number, botEquipConfig: EquipmentFilters): RandomisationDetails; + /** + * Choose between sptBear and sptUsec at random based on the % defined in botConfig.pmc.isUsec + * @returns pmc role + */ + getRandomisedPmcRole(): string; + /** + * Get the corrisponding side when sptBear or sptUsec is passed in + * @param botRole role to get side for + * @returns side (usec/bear) + */ + getPmcSideByRole(botRole: string): string; + /** + * Get a randomised PMC side based on bot config value 'isUsec' + * @returns pmc side as string + */ + protected getRandomisedPmcSide(): string; } diff --git a/types/helpers/BotWeaponGeneratorHelper.d.ts b/types/helpers/BotWeaponGeneratorHelper.d.ts index 7e25f56..b087fa9 100644 --- a/types/helpers/BotWeaponGeneratorHelper.d.ts +++ b/types/helpers/BotWeaponGeneratorHelper.d.ts @@ -4,6 +4,7 @@ import { Item } from "../models/eft/common/tables/IItem"; import { Grid, ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { RandomUtil } from "../utils/RandomUtil"; import { ContainerHelper } from "./ContainerHelper"; @@ -16,8 +17,9 @@ export declare class BotWeaponGeneratorHelper { protected randomUtil: RandomUtil; protected hashUtil: HashUtil; protected inventoryHelper: InventoryHelper; + protected localisationService: LocalisationService; protected containerHelper: ContainerHelper; - constructor(logger: ILogger, databaseServer: DatabaseServer, itemHelper: ItemHelper, randomUtil: RandomUtil, hashUtil: HashUtil, inventoryHelper: InventoryHelper, containerHelper: ContainerHelper); + constructor(logger: ILogger, databaseServer: DatabaseServer, itemHelper: ItemHelper, randomUtil: RandomUtil, hashUtil: HashUtil, inventoryHelper: InventoryHelper, localisationService: LocalisationService, containerHelper: ContainerHelper); /** * Get a randomised number of bullets for a specific magazine * @param magCounts min and max count of magazines diff --git a/types/helpers/DialogueHelper.d.ts b/types/helpers/DialogueHelper.d.ts index e3e2bda..8f03b81 100644 --- a/types/helpers/DialogueHelper.d.ts +++ b/types/helpers/DialogueHelper.d.ts @@ -1,20 +1,24 @@ import { Item } from "../models/eft/common/tables/IItem"; import { Dialogue, MessageContent, MessagePreview } from "../models/eft/profile/IAkiProfile"; import { MessageType } from "../models/enums/MessageType"; +import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { ItemHelper } from "./ItemHelper"; import { NotificationSendHelper } from "./NotificationSendHelper"; import { NotifierHelper } from "./NotifierHelper"; export declare class DialogueHelper { + protected logger: ILogger; protected hashUtil: HashUtil; protected saveServer: SaveServer; protected databaseServer: DatabaseServer; protected notifierHelper: NotifierHelper; protected notificationSendHelper: NotificationSendHelper; + protected localisationService: LocalisationService; protected itemHelper: ItemHelper; - constructor(hashUtil: HashUtil, saveServer: SaveServer, databaseServer: DatabaseServer, notifierHelper: NotifierHelper, notificationSendHelper: NotificationSendHelper, itemHelper: ItemHelper); + constructor(logger: ILogger, hashUtil: HashUtil, saveServer: SaveServer, databaseServer: DatabaseServer, notifierHelper: NotifierHelper, notificationSendHelper: NotificationSendHelper, localisationService: LocalisationService, itemHelper: ItemHelper); createMessageContext(templateId: string, messageType: MessageType, maxStoreTime: number): MessageContent; /** * Add a templated message to the dialogue. @@ -23,7 +27,7 @@ export declare class DialogueHelper { * @param sessionID * @param rewards */ - addDialogueMessage(dialogueID: string, messageContent: MessageContent, sessionID: string, rewards?: any[]): void; + addDialogueMessage(dialogueID: string, messageContent: MessageContent, sessionID: string, rewards?: Item[]): void; /** * Get the preview contents of the last message in a dialogue. * @param dialogue @@ -34,7 +38,8 @@ export declare class DialogueHelper { * Get the item contents for a particular message. * @param messageID * @param sessionID + * @param itemId Item being moved to inventory * @returns */ - getMessageItemContents(messageID: string, sessionID: string): Item[]; + getMessageItemContents(messageID: string, sessionID: string, itemId: string): Item[]; } diff --git a/types/helpers/GameEventHelper.d.ts b/types/helpers/GameEventHelper.d.ts index 7613053..f502c95 100644 --- a/types/helpers/GameEventHelper.d.ts +++ b/types/helpers/GameEventHelper.d.ts @@ -1,9 +1,9 @@ +import { ISeasonalEventConfig } from "../models/spt/config/ISeasonalEventConfig"; +import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; export declare class GameEventHelper { protected databaseServer: DatabaseServer; - constructor(databaseServer: DatabaseServer); - get events(): Record; - get christmasEventItems(): string[]; - itemIsChristmasRelated(itemId: string): boolean; - christmasEventEnabled(): boolean; + protected configServer: ConfigServer; + protected seasonalEventConfig: ISeasonalEventConfig; + constructor(databaseServer: DatabaseServer, configServer: ConfigServer); } diff --git a/types/helpers/HandbookHelper.d.ts b/types/helpers/HandbookHelper.d.ts index b47d466..aa329a9 100644 --- a/types/helpers/HandbookHelper.d.ts +++ b/types/helpers/HandbookHelper.d.ts @@ -1,3 +1,4 @@ +import { DatabaseServer } from "../servers/DatabaseServer"; declare class LookupItem { byId: Record; byParent: Record; @@ -9,25 +10,44 @@ export declare class LookupCollection { constructor(); } export declare class HandbookHelper { - protected lookup: LookupCollection; - hydrateLookup(lookup: LookupCollection): void; - getTemplatePrice(x: string): number; + protected databaseServer: DatabaseServer; + protected lookupCacheGenerated: boolean; + protected handbookPriceCache: LookupCollection; + constructor(databaseServer: DatabaseServer); + hydrateLookup(): void; + /** + * Get price from internal cache, if cache empty look up price directly in handbook (expensive) + * If no values found, return 1 + * @param tpl item tpl to look up price for + * @returns price in roubles + */ + getTemplatePrice(tpl: string): number; + /** + * all items in template with the given parent category + * @param x + * @returns string array + */ templatesWithParent(x: string): string[]; - isCategory(x: string): boolean; + /** + * Does category exist in handbook cache + * @param category + * @returns true if exists in cache + */ + isCategory(category: string): boolean; childrenCategories(x: string): string[]; /** - * Gets Currency to Ruble conversion Value - * @param {number} value - * @param {string} currencyFrom - * @returns number - */ - inRUB(value: number, currencyFrom: string): number; - /** - * Gets Ruble to Currency conversion Value - * @param {number} value - * @param {string} currencyTo - * @returns number + * Convert non-roubles into roubles + * @param nonRoubleCurrencyCount Currency count to convert + * @param currencyTypeFrom What current currency is + * @returns Count in roubles */ - fromRUB(value: number, currencyTo: string): number; + inRUB(nonRoubleCurrencyCount: number, currencyTypeFrom: string): number; + /** + * Convert roubles into another currency + * @param roubleCurrencyCount roubles to convert + * @param currencyTypeTo Currency to convert roubles into + * @returns currency count in desired type + */ + fromRUB(roubleCurrencyCount: number, currencyTypeTo: string): number; } export {}; diff --git a/types/helpers/HealthHelper.d.ts b/types/helpers/HealthHelper.d.ts index 3116c9c..6b5eec2 100644 --- a/types/helpers/HealthHelper.d.ts +++ b/types/helpers/HealthHelper.d.ts @@ -1,4 +1,5 @@ import { IPmcData } from "../models/eft/common/IPmcData"; +import { Effect } from "../models/eft/health/Effect"; import { ISyncHealthRequestData } from "../models/eft/health/ISyncHealthRequestData"; import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { IHealthConfig } from "../models/spt/config/IHealthConfig"; @@ -28,7 +29,7 @@ export declare class HealthHelper { * @param sessionID Session id * @param addEffects Should effects be added or removed (default - add) */ - saveVitality(pmcData: IPmcData, info: ISyncHealthRequestData, sessionID: string, addEffects?: boolean): void; + saveVitality(pmcData: IPmcData, info: ISyncHealthRequestData, sessionID: string, addEffects?: boolean, deleteExistingEffects?: boolean): void; protected saveHealth(pmcData: IPmcData, sessionID: string): void; /** * Save effects to profile @@ -39,13 +40,13 @@ export declare class HealthHelper { * @param addEffects Should effects be added back to profile * @returns */ - protected saveEffects(pmcData: IPmcData, sessionID: string, addEffects: boolean): void; + protected saveEffects(pmcData: IPmcData, sessionID: string, addEffects: boolean, deleteExistingEffects?: boolean): void; /** * Add effect to body part in profile * @param pmcData Player profile * @param effectBodyPart body part to edit * @param effectType Effect to add to body part */ - protected addEffect(pmcData: IPmcData, effectBodyPart: string, effectType: string): void; + protected addEffect(pmcData: IPmcData, effectBodyPart: string, effectType: Effect): void; protected isEmpty(map: any): boolean; } diff --git a/types/helpers/HideoutHelper.d.ts b/types/helpers/HideoutHelper.d.ts index 7495a6a..9d51fed 100644 --- a/types/helpers/HideoutHelper.d.ts +++ b/types/helpers/HideoutHelper.d.ts @@ -8,9 +8,10 @@ import { IHideoutTakeProductionRequestData } from "../models/eft/hideout/IHideou import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IHideoutConfig } from "../models/spt/config/IHideoutConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; @@ -24,18 +25,19 @@ export declare class HideoutHelper { protected timeUtil: TimeUtil; protected randomUtil: RandomUtil; protected databaseServer: DatabaseServer; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected httpResponse: HttpResponseUtil; protected profileHelper: ProfileHelper; protected inventoryHelper: InventoryHelper; protected playerService: PlayerService; + protected localisationService: LocalisationService; protected configServer: ConfigServer; static bitcoinFarm: string; static waterCollector: string; static bitcoin: string; static expeditionaryFuelTank: string; protected hideoutConfig: IHideoutConfig; - constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, itemEventRouter: ItemEventRouter, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, inventoryHelper: InventoryHelper, playerService: PlayerService, configServer: ConfigServer); + constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, inventoryHelper: InventoryHelper, playerService: PlayerService, localisationService: LocalisationService, configServer: ConfigServer); registerProduction(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData | IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** * This convinience function intialies new Production Object diff --git a/types/helpers/InRaidHelper.d.ts b/types/helpers/InRaidHelper.d.ts index 962df38..df2c4af 100644 --- a/types/helpers/InRaidHelper.d.ts +++ b/types/helpers/InRaidHelper.d.ts @@ -5,6 +5,7 @@ import { ISaveProgressRequestData } from "../models/eft/inRaid/ISaveProgressRequ import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; +import { LocalisationService } from "../services/LocalisationService"; import { ProfileFixerService } from "../services/ProfileFixerService"; import { JsonUtil } from "../utils/JsonUtil"; import { InventoryHelper } from "./InventoryHelper"; @@ -16,8 +17,9 @@ export declare class InRaidHelper { protected databaseServer: DatabaseServer; protected inventoryHelper: InventoryHelper; protected paymentHelper: PaymentHelper; + protected localisationService: LocalisationService; protected profileFixerService: ProfileFixerService; - constructor(logger: ILogger, saveServer: SaveServer, jsonUtil: JsonUtil, databaseServer: DatabaseServer, inventoryHelper: InventoryHelper, paymentHelper: PaymentHelper, profileFixerService: ProfileFixerService); + constructor(logger: ILogger, saveServer: SaveServer, jsonUtil: JsonUtil, databaseServer: DatabaseServer, inventoryHelper: InventoryHelper, paymentHelper: PaymentHelper, localisationService: LocalisationService, profileFixerService: ProfileFixerService); /** * Check an array of items and add an upd object to money items with a stack count of 1 * Single stack money items have no upd object and thus no StackObjectsCount, causing issues @@ -42,6 +44,7 @@ export declare class InRaidHelper { * @returns Reset profile object */ updateProfileBaseStats(profileData: IPmcData, saveProgressRequest: ISaveProgressRequestData, sessionID: string): IPmcData; + protected transferPostRaidLimbEffectsToProfile(saveProgressRequest: ISaveProgressRequestData, profileData: IPmcData): void; /** * Some maps have one-time-use keys (e.g. Labs * Remove the relevant key from an inventory based on the post-raid request data passed in diff --git a/types/helpers/InventoryHelper.d.ts b/types/helpers/InventoryHelper.d.ts index b8e5c9d..1ce49da 100644 --- a/types/helpers/InventoryHelper.d.ts +++ b/types/helpers/InventoryHelper.d.ts @@ -5,11 +5,12 @@ import { IInventoryMergeRequestData } from "../models/eft/inventory/IInventoryMe import { IInventoryMoveRequestData } from "../models/eft/inventory/IInventoryMoveRequestData"; import { IInventorySplitRequestData } from "../models/eft/inventory/IInventorySplitRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; -import { IInventoryConfig } from "../models/spt/config/IInventoryConfig"; +import { IInventoryConfig, RewardDetails } from "../models/spt/config/IInventoryConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { JsonUtil } from "../utils/JsonUtil"; @@ -38,9 +39,21 @@ export declare class InventoryHelper { protected itemHelper: ItemHelper; protected containerHelper: ContainerHelper; protected profileHelper: ProfileHelper; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected inventoryConfig: IInventoryConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, hashUtil: HashUtil, httpResponse: HttpResponseUtil, fenceService: FenceService, databaseServer: DatabaseServer, paymentHelper: PaymentHelper, traderAssortHelper: TraderAssortHelper, dialogueHelper: DialogueHelper, itemHelper: ItemHelper, containerHelper: ContainerHelper, profileHelper: ProfileHelper, configServer: ConfigServer); + constructor(logger: ILogger, jsonUtil: JsonUtil, hashUtil: HashUtil, httpResponse: HttpResponseUtil, fenceService: FenceService, databaseServer: DatabaseServer, paymentHelper: PaymentHelper, traderAssortHelper: TraderAssortHelper, dialogueHelper: DialogueHelper, itemHelper: ItemHelper, containerHelper: ContainerHelper, profileHelper: ProfileHelper, localisationService: LocalisationService, configServer: ConfigServer); + /** + * 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 body request data to add items + * @param output response to send back to client + * @param sessionID Session id + * @param callback + * @param foundInRaid Will results added to inventory be set as found in raid + * @param addUpd Additional upd propertys for items being added to inventory + * @returns IItemEventRouterResponse + */ addItem(pmcData: IPmcData, body: IAddItemRequestData, output: IItemEventRouterResponse, sessionID: string, callback: any, foundInRaid?: boolean, addUpd?: any): IItemEventRouterResponse; removeItem(pmcData: IPmcData, itemId: string, sessionID: string, output?: IItemEventRouterResponse): IItemEventRouterResponse; removeItemByCount(pmcData: IPmcData, itemId: string, count: number, sessionID: string, output?: IItemEventRouterResponse): IItemEventRouterResponse; @@ -76,6 +89,12 @@ export declare class InventoryHelper { * Internal helper function to handle cartridges in inventory if any of them exist. */ protected handleCartridges(items: Item[], body: IInventoryMoveRequestData): void; + /** + * Get details for how a random loot container should be handled, max rewards, possible reward tpls + * @param itemTpl Container being opened + * @returns Reward details + */ + getRandomLootContainerRewardDetails(itemTpl: string): RewardDetails; } declare namespace InventoryHelper { interface InventoryItemHash { diff --git a/types/helpers/ItemHelper.d.ts b/types/helpers/ItemHelper.d.ts index 0effaf2..9639923 100644 --- a/types/helpers/ItemHelper.d.ts +++ b/types/helpers/ItemHelper.d.ts @@ -5,11 +5,15 @@ import { IStaticAmmoDetails } from "../models/eft/common/tables/ILootBase"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { ItemBaseClassService } from "../services/ItemBaseClassService"; +import { LocaleService } from "../services/LocaleService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { MathUtil } from "../utils/MathUtil"; import { ObjectId } from "../utils/ObjectId"; import { RandomUtil } from "../utils/RandomUtil"; +import { HandbookHelper } from "./HandbookHelper"; declare class ItemHelper { protected logger: ILogger; protected hashUtil: HashUtil; @@ -18,7 +22,11 @@ declare class ItemHelper { protected objectId: ObjectId; protected mathUtil: MathUtil; protected databaseServer: DatabaseServer; - constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, randomUtil: RandomUtil, objectId: ObjectId, mathUtil: MathUtil, databaseServer: DatabaseServer); + protected handbookHelper: HandbookHelper; + protected itemBaseClassService: ItemBaseClassService; + protected localisationService: LocalisationService; + protected localeService: LocaleService; + constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, randomUtil: RandomUtil, objectId: ObjectId, mathUtil: MathUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, itemBaseClassService: ItemBaseClassService, localisationService: LocalisationService, localeService: LocaleService); /** * Checks if an id is a valid item. Valid meaning that it's an item that be stored in stash * @param {string} tpl the template id / tpl @@ -29,10 +37,17 @@ declare class ItemHelper { * Check if the tpl / template Id provided is a descendent of the baseclass * * @param {string} tpl the item template id to check - * @param {string} baseclassTpl the baseclass to check for + * @param {string} baseClassTpl the baseclass to check for * @return {boolean} is the tpl a descendent? */ - isOfBaseclass(tpl: string, baseclassTpl: string): boolean; + isOfBaseclass(tpl: string, baseClassTpl: string): boolean; + /** + * Check if item has any of the supplied base clases + * @param tpl Item to check base classes of + * @param baseClassTpls base classes to check for + * @returns true if any supplied base classes match + */ + isOfBaseclasses(tpl: string, baseClassTpls: string[]): boolean; /** * Returns the item price based on the handbook or as a fallback from the prices.json if the item is not * found in the handbook. If the price can't be found at all return 0 @@ -177,7 +192,7 @@ declare class ItemHelper { */ replaceIDs(pmcData: IPmcData, items: Item[], insuredItems?: InsuredItem[], fastPanel?: any): any[]; /** - * Recursivly loop down through an items hierarchy to see if any of the ids match the supplied list, return true if any do + * WARNING, SLOW. Recursivly loop down through an items hierarchy to see if any of the ids match the supplied list, return true if any do * @param {string} tpl * @param {Array} tplsToCheck * @returns boolean @@ -212,6 +227,12 @@ declare class ItemHelper { * @returns size of stack */ getItemStackSize(item: Item): number; + /** + * Get the name of an item from the locale file using the item tpl + * @param itemTpl Tpl of item to get name of + * @returns Name of item + */ + getItemName(itemTpl: string): string; } declare namespace ItemHelper { interface ItemSize { diff --git a/types/helpers/NotificationSendHelper.d.ts b/types/helpers/NotificationSendHelper.d.ts index 34e62d9..014ac95 100644 --- a/types/helpers/NotificationSendHelper.d.ts +++ b/types/helpers/NotificationSendHelper.d.ts @@ -1,10 +1,10 @@ import { INotification } from "../models/eft/notifier/INotifier"; -import { IHttpServer } from "../models/spt/server/IHttpServer"; +import { WebSocketServer } from "../servers/WebSocketServer"; import { NotificationService } from "../services/NotificationService"; export declare class NotificationSendHelper { - protected httpServer: IHttpServer; + protected webSocketServer: WebSocketServer; protected notificationService: NotificationService; - constructor(httpServer: IHttpServer, notificationService: NotificationService); + constructor(webSocketServer: WebSocketServer, notificationService: NotificationService); /** * Send notification message to the appropiate channel */ diff --git a/types/helpers/PresetHelper.d.ts b/types/helpers/PresetHelper.d.ts index a469582..cea210e 100644 --- a/types/helpers/PresetHelper.d.ts +++ b/types/helpers/PresetHelper.d.ts @@ -5,8 +5,10 @@ export declare class PresetHelper { protected jsonUtil: JsonUtil; protected databaseServer: DatabaseServer; protected lookup: Record; + protected defaultPresets: Record; constructor(jsonUtil: JsonUtil, databaseServer: DatabaseServer); hydratePresetStore(input: Record): void; + getDefaultPresets(): Record; isPreset(id: string): boolean; hasPreset(templateId: string): boolean; getPreset(id: string): Preset; diff --git a/types/helpers/ProfileHelper.d.ts b/types/helpers/ProfileHelper.d.ts index 9c6560a..7c1b12a 100644 --- a/types/helpers/ProfileHelper.d.ts +++ b/types/helpers/ProfileHelper.d.ts @@ -5,7 +5,6 @@ import { IValidateNicknameRequestData } from "../models/eft/profile/IValidateNic import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; -import { FenceService } from "../services/FenceService"; import { ProfileSnapshotService } from "../services/ProfileSnapshotService"; import { JsonUtil } from "../utils/JsonUtil"; import { TimeUtil } from "../utils/TimeUtil"; @@ -20,9 +19,13 @@ export declare class ProfileHelper { protected databaseServer: DatabaseServer; protected itemHelper: ItemHelper; protected profileSnapshotService: ProfileSnapshotService; - protected fenceService: FenceService; - constructor(logger: ILogger, jsonUtil: JsonUtil, watermark: Watermark, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileSnapshotService: ProfileSnapshotService, fenceService: FenceService); + constructor(logger: ILogger, jsonUtil: JsonUtil, watermark: Watermark, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileSnapshotService: ProfileSnapshotService); resetProfileQuestCondition(sessionID: string, conditionId: string): void; + /** + * Get all profiles from server + * @returns Dictionary of profiles + */ + getProfiles(): Record; getCompleteProfile(sessionID: string): IPmcData[]; /** * Fix xp doubling on post-raid xp reward screen by sending a 'dummy' profile to the post-raid screen diff --git a/types/helpers/QuestHelper.d.ts b/types/helpers/QuestHelper.d.ts index d66d150..6bd1444 100644 --- a/types/helpers/QuestHelper.d.ts +++ b/types/helpers/QuestHelper.d.ts @@ -6,10 +6,11 @@ import { ICompleteQuestRequestData } from "../models/eft/quests/ICompleteQuestRe import { QuestStatus } from "../models/enums/QuestStatus"; import { IQuestConfig } from "../models/spt/config/IQuestConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocaleService } from "../services/LocaleService"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { TimeUtil } from "../utils/TimeUtil"; @@ -25,17 +26,18 @@ export declare class QuestHelper { protected timeUtil: TimeUtil; protected hashUtil: HashUtil; protected itemHelper: ItemHelper; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected localeService: LocaleService; protected ragfairServerHelper: RagfairServerHelper; protected dialogueHelper: DialogueHelper; protected profileHelper: ProfileHelper; protected paymentHelper: PaymentHelper; + protected localisationService: LocalisationService; protected traderHelper: TraderHelper; protected configServer: ConfigServer; protected questConfig: IQuestConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, timeUtil: TimeUtil, hashUtil: HashUtil, itemHelper: ItemHelper, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, localeService: LocaleService, ragfairServerHelper: RagfairServerHelper, dialogueHelper: DialogueHelper, profileHelper: ProfileHelper, paymentHelper: PaymentHelper, traderHelper: TraderHelper, configServer: ConfigServer); + constructor(logger: ILogger, jsonUtil: JsonUtil, timeUtil: TimeUtil, hashUtil: HashUtil, itemHelper: ItemHelper, eventOutputHolder: EventOutputHolder, databaseServer: DatabaseServer, localeService: LocaleService, ragfairServerHelper: RagfairServerHelper, dialogueHelper: DialogueHelper, profileHelper: ProfileHelper, paymentHelper: PaymentHelper, localisationService: LocalisationService, traderHelper: TraderHelper, configServer: ConfigServer); /** * Get status of a quest by quest id * @param pmcData Profile to search @@ -50,6 +52,12 @@ export declare class QuestHelper { * @returns true if player level is greater than or equal to quest */ doesPlayerLevelFulfilCondition(playerLevel: number, condition: AvailableForConditions): boolean; + /** + * Get the quests found in both arrays (inner join) + * @param before Array of qeusts #1 + * @param after Array of quests #2 + * @returns Reduction of cartesian product between two quest arrays + */ getDeltaQuests(before: IQuest[], after: IQuest[]): IQuest[]; /** * Increase skill points of a skill on player profile @@ -60,44 +68,91 @@ export declare class QuestHelper { * @param progressAmount Amount of skill points to add to skill */ rewardSkillPoints(sessionID: string, pmcData: IPmcData, output: IItemEventRouterResponse, skillName: string, progressAmount: number): void; - getQuestLocale(questId: string): any; /** - * Debug Routine for showing some information on the - * quest list in question. + * Get quest name by quest id + * @param questId id to get + * @returns + */ + getQuestNameFromLocale(questId: string): string; + /** + * Check if trader has sufficient loyalty to fullfill quest requirement + * @param questProperties Quest props + * @param profile Player profile + * @returns true if loyalty is high enough to fulfil quest requirement + */ + traderStandingRequirementCheck(questProperties: AvailableForProps, profile: IPmcData): boolean; + protected processReward(reward: Reward): Reward[]; + /** + * Gets a flat list of reward items for the given quest at a specific state (e.g. Fail/Success) + * @param quest quest to get rewards for + * @param state Quest status that holds the items (Started, Success, Fail) + * @returns array of items with the correct maxStack */ - dumpQuests(quests: any): void; - loyaltyRequirementCheck(loyaltyRequirementProperties: AvailableForProps, profile: IPmcData): boolean; - protected processReward(reward: Reward): any[]; getQuestRewardItems(quest: IQuest, state: QuestStatus): Reward[]; /** - * Add quest with new state value to pmc profile + * Update player profile with quest status (e.g. Fail/Success) * @param pmcData profile to add quest to * @param newState state the new quest should be in when added * @param acceptedQuest Details of quest being added */ addQuestToPMCData(pmcData: IPmcData, newState: QuestStatus, acceptedQuest: IAcceptQuestRequestData): void; - acceptedUnlocked(acceptedQuestId: string, sessionID: string): IQuest[]; - failedUnlocked(failedQuestId: string, sessionID: string): IQuest[]; - applyMoneyBoost(quest: IQuest, moneyBoost: number): IQuest; - changeItemStack(pmcData: IPmcData, id: string, value: number, sessionID: string, output: any): void; /** - * Get List of All Quests as an array + * TODO: what is going on here + * @param acceptedQuestId Quest to add to profile + * @param sessionID Session id + * @returns Array of quests in profile + quest passed in as param + */ + acceptedUnlocked(acceptedQuestId: string, sessionID: string): IQuest[]; + /** + * TODO: what is going on here + * @param failedQuestId + * @param sessionID Session id + * @returns + */ + failedUnlocked(failedQuestId: string, sessionID: string): IQuest[]; + /** + * Adjust quest money rewards by passed in multipler + * @param quest Quest to multiple money rewards + * @param multipler Value to adjust money rewards by + * @returns Updated quest + */ + applyMoneyBoost(quest: IQuest, multipler: number): IQuest; + /** + * Sets the item stack to new value, or delete the item if value <= 0 + * // TODO maybe merge this function and the one from customization + * @param pmcData Profile + * @param itemId id of item to adjust stack size of + * @param newStackSize Stack size to adjust to + * @param sessionID Session id + * @param output ItemEvent router response + */ + changeItemStack(pmcData: IPmcData, itemId: string, newStackSize: number, sessionID: string, output: IItemEventRouterResponse): void; + /** + * Get List of All Quests from db + * NOT CLONED * @returns Array of IQuest objects */ - questValues(): IQuest[]; + getQuestsFromDb(): IQuest[]; /** - * Reest AvailableForStart conditions for quests - * @param quests queststo clean + * Get quests, strip all requirement conditions except level + * @param quests quests to process * @returns quest array without conditions */ - protected cleanQuestList(quests: IQuest[]): IQuest[]; + protected getQuestsWithOnlyLevelRequirementStartCondition(quests: IQuest[]): IQuest[]; /** - * Reset AvailableForStart conditions on a quest + * Remove all quest conditions except for level requirement * @param quest quest to clean * @returns reset IQuest object */ - cleanQuestConditions(quest: IQuest): IQuest; - failQuest(pmcData: IPmcData, body: any, sessionID: string): any; + getQuestWithOnlyLevelRequirementStartCondition(quest: IQuest): IQuest; + /** + * Fail a quest in a player profile + * @param pmcData Profile + * @param failRequest fail quest request data + * @param sessionID Session id + * @returns Item event router response + */ + failQuest(pmcData: IPmcData, failRequest: any, sessionID: string): IItemEventRouterResponse; /** * Get quest by id from database * @param questId questid to look for @@ -105,7 +160,12 @@ export declare class QuestHelper { * @returns IQuest object */ getQuestFromDb(questId: string, pmcData: IPmcData): IQuest; - getQuestLocaleIdFromDb(messageId: string): string; + /** + * Get the locale Id from locale db for a quest message + * @param questMessageId Quest mesage id to look up + * @returns Locale Id from locale db + */ + getQuestLocaleIdFromDb(questMessageId: string): string; /** * Alter a quests state + Add a record to tis status timers object * @param pmcData Profile to update @@ -128,5 +188,10 @@ export declare class QuestHelper { * @returns bonus in percent */ protected getIntelCenterRewardBonus(pmcData: IPmcData): number; - getFindItemIdForQuestItem(itemTpl: string): string; + /** + * Find quest with 'findItem' requirement that needs the item tpl be handed in + * @param itemTpl item tpl to look for + * @returns 'FindItem' condition id + */ + getFindItemIdForQuestHandIn(itemTpl: string): string; } diff --git a/types/helpers/RagfairOfferHelper.d.ts b/types/helpers/RagfairOfferHelper.d.ts index e9d72ca..95be986 100644 --- a/types/helpers/RagfairOfferHelper.d.ts +++ b/types/helpers/RagfairOfferHelper.d.ts @@ -6,7 +6,7 @@ import { ISearchRequestData } from "../models/eft/ragfair/ISearchRequestData"; import { IQuestConfig } from "../models/spt/config/IQuestConfig"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; @@ -27,7 +27,7 @@ export declare class RagfairOfferHelper { protected logger: ILogger; protected timeUtil: TimeUtil; protected hashUtil: HashUtil; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected traderHelper: TraderHelper; protected saveServer: SaveServer; @@ -45,12 +45,24 @@ export declare class RagfairOfferHelper { protected static goodSoldTemplate: string; protected ragfairConfig: IRagfairConfig; protected questConfig: IQuestConfig; - constructor(logger: ILogger, timeUtil: TimeUtil, hashUtil: HashUtil, itemEventRouter: ItemEventRouter, databaseServer: DatabaseServer, traderHelper: TraderHelper, saveServer: SaveServer, dialogueHelper: DialogueHelper, itemHelper: ItemHelper, paymentHelper: PaymentHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, ragfairServerHelper: RagfairServerHelper, ragfairSortHelper: RagfairSortHelper, ragfairHelper: RagfairHelper, ragfairOfferService: RagfairOfferService, localeService: LocaleService, configServer: ConfigServer); - getValidOffers(info: ISearchRequestData, itemsToAdd: string[], assorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + constructor(logger: ILogger, timeUtil: TimeUtil, hashUtil: HashUtil, eventOutputHolder: EventOutputHolder, databaseServer: DatabaseServer, traderHelper: TraderHelper, saveServer: SaveServer, dialogueHelper: DialogueHelper, itemHelper: ItemHelper, paymentHelper: PaymentHelper, presetHelper: PresetHelper, profileHelper: ProfileHelper, ragfairServerHelper: RagfairServerHelper, ragfairSortHelper: RagfairSortHelper, ragfairHelper: RagfairHelper, ragfairOfferService: RagfairOfferService, localeService: LocaleService, configServer: ConfigServer); + getValidOffers(searchRequest: ISearchRequestData, itemsToAdd: string[], traderAssorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; getOffersForBuild(info: ISearchRequestData, itemsToAdd: string[], assorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + /** + * Check if trader offers' BuyRestrictionMax value has been reached + * @param offer offer to check restriction properties of + * @returns true if restriction reached, false if no restrictions/not reached + */ + protected traderBuyRestrictionReached(offer: IRagfairOffer): boolean; + /** + * Get an array of flea offers that are inaccessible to player due to their inadequate loyalty level + * @param offers Offers to check + * @param pmcProfile Players profile with trader loyalty levels + */ + protected getLoyaltyLockedOffers(offers: IRagfairOffer[], pmcProfile: IPmcData): string[]; processOffersOnProfile(sessionID: string): boolean; protected getProfileOffers(sessionID: string): IRagfairOffer[]; protected deleteOfferByOfferId(sessionID: string, offerId: string): void; protected completeOffer(sessionID: string, offer: IRagfairOffer, boughtAmount: number): IItemEventRouterResponse; - isDisplayableOffer(info: ISearchRequestData, itemsToAdd: string[], assorts: Record, offer: IRagfairOffer, pmcProfile: IPmcData): boolean; + isDisplayableOffer(info: ISearchRequestData, itemsToAdd: string[], traderAssorts: Record, offer: IRagfairOffer, pmcProfile: IPmcData): boolean; } diff --git a/types/helpers/RagfairSellHelper.d.ts b/types/helpers/RagfairSellHelper.d.ts index 91b8a20..60809b5 100644 --- a/types/helpers/RagfairSellHelper.d.ts +++ b/types/helpers/RagfairSellHelper.d.ts @@ -11,7 +11,21 @@ export declare class RagfairSellHelper { protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; constructor(logger: ILogger, randomUtil: RandomUtil, timeUtil: TimeUtil, configServer: ConfigServer); - calculateSellChance(baseChancePercent: number, offerPriceRub: number, playerListedPriceRub: number): number; + /** + * Get the percent chance to sell an item based on its average listed price vs player chosen listing price + * @param baseChancePercent Base chance to sell item + * @param averageOfferPriceRub Price of average offer in roubles + * @param playerListedPriceRub Price player listed item for in roubles + * @returns percent value + */ + calculateSellChance(baseChancePercent: number, averageOfferPriceRub: number, playerListedPriceRub: number): number; + /** + * Get percent chance to sell an item when price is below items average listing price + * @param playerListedPriceRub Price player listed item for in roubles + * @param averageOfferPriceRub Price of average offer in roubles + * @returns percent value + */ + protected getSellMultiplierWhenPlayerPriceIsBelowAverageListingPrice(averageOfferPriceRub: number, playerListedPriceRub: number): number; /** * Determine if the offer being listed will be sold * @param sellChancePercent chance item will sell diff --git a/types/helpers/RagfairServerHelper.d.ts b/types/helpers/RagfairServerHelper.d.ts index a03cdda..bfe6cc3 100644 --- a/types/helpers/RagfairServerHelper.d.ts +++ b/types/helpers/RagfairServerHelper.d.ts @@ -42,12 +42,22 @@ export declare class RagfairServerHelper { protected isItemBlacklisted(itemTemplateId: string): boolean; isTrader(userID: string): boolean; isPlayer(userID: string): boolean; - returnItems(sessionID: string, items: any[]): void; + returnItems(sessionID: string, items: Item[]): void; calculateDynamicStackCount(tplId: string, isWeaponPreset: boolean): number; + /** + * Choose a currency at random with bias + * @returns currency tpl + */ getDynamicOfferCurrency(): string; getMemberType(userID: string): MemberCategory; getNickname(userID: string): string; getPresetItems(item: any): Item[]; getPresetItemsByTpl(item: Item): Item[]; + /** + * Generate new unique ids for the children while preserving hierarchy + * @param item base item + * @param preset + * @returns Item array with new IDs + */ reparentPresets(item: Item, preset: Item[]): Item[]; } diff --git a/types/helpers/RagfairSortHelper.d.ts b/types/helpers/RagfairSortHelper.d.ts index d20e10c..4669ce6 100644 --- a/types/helpers/RagfairSortHelper.d.ts +++ b/types/helpers/RagfairSortHelper.d.ts @@ -1,14 +1,28 @@ import { IRagfairOffer } from "../models/eft/ragfair/IRagfairOffer"; +import { RagfairSort } from "../models/enums/RagfairSort"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocaleService } from "../services/LocaleService"; export declare class RagfairSortHelper { protected databaseServer: DatabaseServer; protected localeService: LocaleService; constructor(databaseServer: DatabaseServer, localeService: LocaleService); - sortOffers(offers: IRagfairOffer[], type: number, direction?: number): IRagfairOffer[]; + /** + * Sort a list of ragfair offers by something (id/rating/offer name/price/expirty time) + * @param offers Offers to sort + * @param type How to sort it + * @param direction Ascending/descending + * @returns Sorted offers + */ + sortOffers(offers: IRagfairOffer[], type: RagfairSort, direction?: number): IRagfairOffer[]; protected sortOffersByID(a: IRagfairOffer, b: IRagfairOffer): number; protected sortOffersByRating(a: IRagfairOffer, b: IRagfairOffer): number; protected sortOffersByName(a: IRagfairOffer, b: IRagfairOffer): number; + /** + * Order two offers by rouble price value + * @param a Offer a + * @param b Offer b + * @returns + */ protected sortOffersByPrice(a: IRagfairOffer, b: IRagfairOffer): number; protected sortOffersByExpiry(a: IRagfairOffer, b: IRagfairOffer): number; } diff --git a/types/helpers/RepairHelper.d.ts b/types/helpers/RepairHelper.d.ts index 9a3ab29..9983d4d 100644 --- a/types/helpers/RepairHelper.d.ts +++ b/types/helpers/RepairHelper.d.ts @@ -14,8 +14,17 @@ export declare class RepairHelper { protected configServer: ConfigServer; protected repairConfig: IRepairConfig; constructor(logger: ILogger, jsonUtil: JsonUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, configServer: ConfigServer); - updateItemDurability(itemToRepair: Item, itemToRepairDetails: ITemplateItem, isArmor: boolean, amountToRepair: number, useRepairKit?: boolean, applyRandomDegradation?: boolean): Item; - protected getRandomisedArmorRepairDegredationValue(armorMaterial: string, isRepairKit: boolean, armorMax: number): number; - protected getRandomisedWeaponRepairDegredationValue(itemProps: Props, isRepairKit: boolean, armorMax: number): number; + /** + * Alter an items durability after a repair by trader/repair kit + * @param itemToRepair item to update durability details + * @param itemToRepairDetails db details of item to repair + * @param isArmor Is item being repaired a piece of armor + * @param amountToRepair how many unit of durability to repair + * @param useRepairKit Is item being repaired with a repair kit + * @param applyMaxDurabilityDegradation should item have max durability reduced + */ + updateItemDurability(itemToRepair: Item, itemToRepairDetails: ITemplateItem, isArmor: boolean, amountToRepair: number, useRepairKit: boolean, traderQualityMultipler: number, applyMaxDurabilityDegradation?: boolean): void; + protected getRandomisedArmorRepairDegredationValue(armorMaterial: string, isRepairKit: boolean, armorMax: number, traderQualityMultipler: number): number; + protected getRandomisedWeaponRepairDegredationValue(itemProps: Props, isRepairKit: boolean, weaponMax: number, traderQualityMultipler: number): number; isWeaponTemplate(tpl: string): boolean; } diff --git a/types/helpers/TradeHelper.d.ts b/types/helpers/TradeHelper.d.ts index 7ab9768..94ec382 100644 --- a/types/helpers/TradeHelper.d.ts +++ b/types/helpers/TradeHelper.d.ts @@ -6,21 +6,25 @@ import { Item, Upd } from "../models/eft/common/tables/IItem"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IProcessBuyTradeRequestData } from "../models/eft/trade/IProcessBuyTradeRequestData"; import { IProcessSellTradeRequestData } from "../models/eft/trade/IProcessSellTradeRequestData"; +import { ITraderConfig } from "../models/spt/config/ITraderConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { ConfigServer } from "../servers/ConfigServer"; import { RagfairServer } from "../servers/RagfairServer"; import { FenceService } from "../services/FenceService"; import { PaymentService } from "../services/PaymentService"; export declare class TradeHelper { protected logger: ILogger; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected traderHelper: TraderHelper; protected itemHelper: ItemHelper; protected paymentService: PaymentService; protected fenceService: FenceService; protected inventoryHelper: InventoryHelper; protected ragfairServer: RagfairServer; - constructor(logger: ILogger, itemEventRouter: ItemEventRouter, traderHelper: TraderHelper, itemHelper: ItemHelper, paymentService: PaymentService, fenceService: FenceService, inventoryHelper: InventoryHelper, ragfairServer: RagfairServer); + protected configServer: ConfigServer; + protected traderConfig: ITraderConfig; + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, traderHelper: TraderHelper, itemHelper: ItemHelper, paymentService: PaymentService, fenceService: FenceService, inventoryHelper: InventoryHelper, ragfairServer: RagfairServer, configServer: ConfigServer); /** * Buy item from flea or trader * @param pmcData @@ -33,7 +37,7 @@ export declare class TradeHelper { buyItem(pmcData: IPmcData, buyRequestData: IProcessBuyTradeRequestData, sessionID: string, foundInRaid: boolean, upd: Upd): IItemEventRouterResponse; /** * Sell item to trader - * @param pmcData + * @param pmcData Profile to update * @param body * @param sessionID * @returns diff --git a/types/helpers/TraderAssortHelper.d.ts b/types/helpers/TraderAssortHelper.d.ts index 025efd6..c3915c6 100644 --- a/types/helpers/TraderAssortHelper.d.ts +++ b/types/helpers/TraderAssortHelper.d.ts @@ -7,7 +7,9 @@ import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { TraderAssortService } from "../services/TraderAssortService"; +import { TraderPurchasePersisterService } from "../services/TraderPurchasePersisterService"; import { JsonUtil } from "../utils/JsonUtil"; import { MathUtil } from "../utils/MathUtil"; import { TimeUtil } from "../utils/TimeUtil"; @@ -27,11 +29,13 @@ export declare class TraderAssortHelper { protected ragfairAssortGenerator: RagfairAssortGenerator; protected ragfairOfferGenerator: RagfairOfferGenerator; protected traderAssortService: TraderAssortService; + protected localisationService: LocalisationService; + protected traderPurchasePersisterService: TraderPurchasePersisterService; protected traderHelper: TraderHelper; protected fenceService: FenceService; protected configServer: ConfigServer; protected traderConfig: ITraderConfig; - constructor(logger: ILogger, jsonUtil: JsonUtil, mathUtil: MathUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, profileHelper: ProfileHelper, assortHelper: AssortHelper, paymentHelper: PaymentHelper, ragfairAssortGenerator: RagfairAssortGenerator, ragfairOfferGenerator: RagfairOfferGenerator, traderAssortService: TraderAssortService, traderHelper: TraderHelper, fenceService: FenceService, configServer: ConfigServer); + constructor(logger: ILogger, jsonUtil: JsonUtil, mathUtil: MathUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, profileHelper: ProfileHelper, assortHelper: AssortHelper, paymentHelper: PaymentHelper, ragfairAssortGenerator: RagfairAssortGenerator, ragfairOfferGenerator: RagfairOfferGenerator, traderAssortService: TraderAssortService, localisationService: LocalisationService, traderPurchasePersisterService: TraderPurchasePersisterService, traderHelper: TraderHelper, fenceService: FenceService, configServer: ConfigServer); /** * Get a traders assorts * Can be used for returning ragfair / fence assorts diff --git a/types/helpers/TraderHelper.d.ts b/types/helpers/TraderHelper.d.ts index 0dc93e8..62a3492 100644 --- a/types/helpers/TraderHelper.d.ts +++ b/types/helpers/TraderHelper.d.ts @@ -8,6 +8,7 @@ import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; import { TimeUtil } from "../utils/TimeUtil"; import { HandbookHelper } from "./HandbookHelper"; @@ -23,11 +24,12 @@ export declare class TraderHelper { protected itemHelper: ItemHelper; protected handbookHelper: HandbookHelper; protected playerService: PlayerService; + protected localisationService: LocalisationService; protected fenceService: FenceService; protected timeUtil: TimeUtil; protected configServer: ConfigServer; protected traderConfig: ITraderConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, paymentHelper: PaymentHelper, itemHelper: ItemHelper, handbookHelper: HandbookHelper, playerService: PlayerService, fenceService: FenceService, timeUtil: TimeUtil, configServer: ConfigServer); + constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, paymentHelper: PaymentHelper, itemHelper: ItemHelper, handbookHelper: HandbookHelper, playerService: PlayerService, localisationService: LocalisationService, fenceService: FenceService, timeUtil: TimeUtil, configServer: ConfigServer); getTrader(traderID: string, sessionID: string): ITraderBase; getTraderAssortsById(traderId: string): ITraderAssort; /** @@ -53,19 +55,26 @@ export declare class TraderHelper { getPurchasesData(traderID: string, sessionID: string): Record; /** * Should item be skipped when selling to trader according to its sell categories and other checks - * @param pmcData - * @param item - * @param sellCategory + * @param pmcData Profile + * @param item Item to be checked is sellable to trader + * @param sellCategory categories trader will buy + * @param traderId Trader item is being checked can be sold to * @returns true if should NOT be sold to trader */ - protected isItemUnSellableToTrader(pmcData: IPmcData, item: Item, sellCategory: string[]): boolean; + protected isItemUnSellableToTrader(pmcData: IPmcData, item: Item, sellCategory: string[], traderId: string): boolean; /** - * Can this weapon be sold to a trader with its current durabiltiy level - * @param traderID - * @param item - * @returns boolean + * Check if item has durability so low it precludes it from being sold to the trader (inclusive) + * @param item Item to check durability of + * @param traderId Trader item is sold to + * @returns */ - protected isWeaponBelowTraderBuyDurability(traderID: string, item: Item): boolean; + protected itemIsBelowSellableDurabilityThreshhold(item: Item, traderId: string): boolean; + /** + * Get the percentage threshold value a trader will buy armor/weapons above + * @param traderId Trader to look up + * @returns percentage + */ + protected getTraderDurabiltyPurchaseThreshold(traderId: string): number; /** * Get the price of an item and all of its attached children * Take into account bonuses/adjsutments e.g. discounts @@ -113,10 +122,22 @@ export declare class TraderHelper { getTraderUpdateSeconds(traderId: string): number; /** * check if an item is allowed to be sold to a trader - * @param traderFilters array of allowed categories + * @param categoriesTraderBuys array of allowed categories * @param tplToCheck itemTpl of inventory - * @returns boolean + * @returns boolean if item can be sold to trader */ - traderFilter(traderFilters: string[], tplToCheck: string): boolean; + doesTraderBuyItem(categoriesTraderBuys: string[], tplToCheck: string): boolean; getLoyaltyLevel(traderID: string, pmcData: IPmcData): LoyaltyLevel; + /** + * Store the purchase of an assort from a trader in the player profile + * @param sessionID Session id + * @param newPurchaseDetails New item assort id + count + */ + addTraderPurchasesToPlayerProfile(sessionID: string, newPurchaseDetails: { + items: { + item_id: string; + count: number; + }[]; + tid: string; + }): void; } diff --git a/types/ide/Compiler.d.ts b/types/ide/Compiler.d.ts deleted file mode 100644 index fded23a..0000000 --- a/types/ide/Compiler.d.ts +++ /dev/null @@ -1 +0,0 @@ -import "reflect-metadata"; diff --git a/types/loaders/PostDBModLoader.d.ts b/types/loaders/PostDBModLoader.d.ts index 5101b7b..87b60f9 100644 --- a/types/loaders/PostDBModLoader.d.ts +++ b/types/loaders/PostDBModLoader.d.ts @@ -4,7 +4,7 @@ import { PreAkiModLoader } from "./PreAkiModLoader"; export declare class PostDBModLoader implements OnLoad { protected preAkiModLoader: PreAkiModLoader; constructor(preAkiModLoader: PreAkiModLoader); - onLoad(): void; + onLoad(): Promise; getRoute(): string; getModPath(mod: string): string; protected executeMods(container: DependencyContainer): void; diff --git a/types/loaders/PreAkiModLoader.d.ts b/types/loaders/PreAkiModLoader.d.ts index d310ae2..212aaf3 100644 --- a/types/loaders/PreAkiModLoader.d.ts +++ b/types/loaders/PreAkiModLoader.d.ts @@ -1,10 +1,14 @@ import { DependencyContainer } from "tsyringe"; +import { IPostAkiLoadMod } from "../models/external/IPostAkiLoadMod"; +import { IPostDBLoadMod } from "../models/external/IPostDBLoadMod"; +import { IPreAkiLoadMod } from "../models/external/IPreAkiLoadMod"; import { ICoreConfig } from "../models/spt/config/ICoreConfig"; import { ModLoader } from "../models/spt/mod/IMod"; import { IModLoader } from "../models/spt/mod/IModLoader"; import { IPackageJsonData } from "../models/spt/mod/IPackageJsonData"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; +import { LocalisationService } from "../services/LocalisationService"; import { ModCompilerService } from "../services/ModCompilerService"; import { JsonUtil } from "../utils/JsonUtil"; import { VFS } from "../utils/VFS"; @@ -15,12 +19,13 @@ export declare class PreAkiModLoader implements IModLoader { protected jsonUtil: JsonUtil; protected modCompilerService: ModCompilerService; protected bundleLoader: BundleLoader; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected static container: DependencyContainer; protected readonly basepath = "user/mods/"; protected imported: Record; protected akiConfig: ICoreConfig; - constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, modCompilerService: ModCompilerService, bundleLoader: BundleLoader, configServer: ConfigServer); + constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, modCompilerService: ModCompilerService, bundleLoader: BundleLoader, localisationService: LocalisationService, configServer: ConfigServer); load(container: DependencyContainer): Promise; getBundles(local: boolean): string; getBundle(key: string, local: boolean): void; @@ -29,6 +34,7 @@ export declare class PreAkiModLoader implements IModLoader { * @returns Array of mod names in load order */ getImportedModsNames(): string[]; + getImportedModDetails(): Record; getModPath(mod: string): string; protected importClass(name: string, filepath: string, container: DependencyContainer): void; protected importMods(): Promise; @@ -44,9 +50,9 @@ export declare class PreAkiModLoader implements IModLoader { */ protected getDuplicates(stringArray: string[]): string[]; /** - * - * @param mods Get an array of broken/invalid mods by name - * @returns Mod names array + * Get an array of mods with errors that prevent them from working with SPT + * @param mods mods to validate + * @returns Mod names as array */ protected getBrokenMods(mods: string[]): string[]; /** @@ -56,19 +62,38 @@ export declare class PreAkiModLoader implements IModLoader { */ protected getModsPackageData(mods: string[]): Record; /** - * Does mod have "delayedLoad(" string in its entry class - * @param modFolderName folder name - * @param modToValidate package.json details + * Use defined safe guard to check if the mod is a IPreAkiLoadMod * @returns boolean */ - protected isModSpt3XXCompatible(modFolderName: string, modToValidate: IPackageJsonData): boolean; + protected isPreAkiLoad(mod: any): mod is IPreAkiLoadMod; + /** + * Use defined safe guard to check if the mod is a IPostAkiLoadMod + * @returns boolean + */ + protected isPostAkiLoad(mod: any): mod is IPostAkiLoadMod; + /** + * Use defined safe guard to check if the mod is a IPostDBLoadMod + * @returns boolean + */ + protected isPostDBAkiLoad(mod: any): mod is IPostDBLoadMod; + /** + * Check that the mod is compatible with SPT 3.X.X + * @param mod the mod to check + * @returns boolean + */ + protected isModSpt3XXCompatible(mod: any): boolean; protected isModCombatibleWithAki(mod: IPackageJsonData): boolean; protected executeMods(container: DependencyContainer): void; sortModsLoadOrder(): string[]; protected addMod(mod: string): Promise; protected areModDependenciesFulfilled(pkg: IPackageJsonData, loadedMods: Record): boolean; protected isModCompatible(mod: IPackageJsonData, loadedMods: Record): boolean; - protected validMod(mod: string): boolean; + /** + * Validate a mod passes a number of checks + * @param modName name of mod in /mods/ to validate + * @returns true if valid + */ + protected validMod(modName: string): boolean; protected getLoadOrderRecursive(mod: string, result: Record, visited: Record): void; protected getLoadOrder(mods: Record): Record; getContainer(): DependencyContainer; diff --git a/types/models/eft/bot/IGenerateBotsRequestData.d.ts b/types/models/eft/bot/IGenerateBotsRequestData.d.ts index c49cef7..f1f7013 100644 --- a/types/models/eft/bot/IGenerateBotsRequestData.d.ts +++ b/types/models/eft/bot/IGenerateBotsRequestData.d.ts @@ -2,6 +2,7 @@ export interface IGenerateBotsRequestData { conditions: Condition[]; } export interface Condition { + /** e.g. assault/pmcBot/bossKilla */ Role: string; Limit: number; Difficulty: string; diff --git a/types/models/eft/bot/IRandomisedBotLevelResult.d.ts b/types/models/eft/bot/IRandomisedBotLevelResult.d.ts new file mode 100644 index 0000000..75bd936 --- /dev/null +++ b/types/models/eft/bot/IRandomisedBotLevelResult.d.ts @@ -0,0 +1,4 @@ +export interface IRandomisedBotLevelResult { + level: number; + exp: number; +} diff --git a/types/models/eft/common/IGlobals.d.ts b/types/models/eft/common/IGlobals.d.ts index 9d28dbc..b53f106 100644 --- a/types/models/eft/common/IGlobals.d.ts +++ b/types/models/eft/common/IGlobals.d.ts @@ -591,6 +591,7 @@ export interface HealPrice { export interface ProfileHealthSettings { BodyPartsSettings: BodyPartsSettings; HealthFactorsSettings: HealthFactorsSettings; + DefaultStimulatorBuff: string; } export interface BodyPartsSettings { Head: BodyPartsSetting; @@ -1175,5 +1176,6 @@ export interface Preset { _name: string; _parent: string; _items: Item[]; + /** Default presets have this property */ _encyclopedia?: string; } diff --git a/types/models/eft/common/tables/IBotBase.d.ts b/types/models/eft/common/tables/IBotBase.d.ts index 25cb861..1c28ae0 100644 --- a/types/models/eft/common/tables/IBotBase.d.ts +++ b/types/models/eft/common/tables/IBotBase.d.ts @@ -341,6 +341,7 @@ export interface RagfairInfo { offers: IRagfairOffer[]; } export interface Bonus { + id?: string; type: string; templateId?: string; passive?: boolean; @@ -348,6 +349,8 @@ export interface Bonus { visible?: boolean; value?: number; icon?: string; + filter?: string[]; + skillType?: string; } export interface Note { Time: number; diff --git a/types/models/eft/common/tables/IBotType.d.ts b/types/models/eft/common/tables/IBotType.d.ts index c1fe579..e02d990 100644 --- a/types/models/eft/common/tables/IBotType.d.ts +++ b/types/models/eft/common/tables/IBotType.d.ts @@ -13,8 +13,8 @@ export interface IBotType { skills: Skills; } export interface Appearance { - body: string[]; - feet: string[]; + body: Record; + feet: Record; hands: string[]; head: string[]; voice: string[]; @@ -57,6 +57,10 @@ export interface ModsChances { mod_pistol_grip: number; mod_reciever: number; mod_scope: number; + mod_scope_000: number; + mod_scope_001: number; + mod_scope_002: number; + mod_scope_003: number; mod_sight_front: number; mod_sight_rear: number; mod_stock: number; @@ -152,4 +156,4 @@ export interface Items { SpecialLoot: string[]; TacticalVest: string[]; } -export declare type Mods = Record>; +export type Mods = Record>; diff --git a/types/models/eft/common/tables/IQuest.d.ts b/types/models/eft/common/tables/IQuest.d.ts index a349a6d..d538126 100644 --- a/types/models/eft/common/tables/IQuest.d.ts +++ b/types/models/eft/common/tables/IQuest.d.ts @@ -1,4 +1,5 @@ import { QuestRewardType } from "../../../enums/QuestRewardType"; +import { QuestStatus } from "../../../enums/QuestStatus"; import { Item } from "./IItem"; export interface IQuest { QuestName: string; @@ -36,7 +37,7 @@ export interface Conditions { export interface AvailableForConditions { _parent: string; _props: AvailableForProps; - dynamicLocale: boolean; + dynamicLocale?: boolean; } export interface AvailableForProps { id: string; @@ -47,7 +48,7 @@ export interface AvailableForProps { compareMethod?: string; visibilityConditions?: VisibilityCondition[]; target?: string | string[]; - status?: number[]; + status?: QuestStatus[]; onlyFoundInRaid?: boolean; oneSessionOnly?: boolean; doNotResetIfCounterCompleted?: boolean; @@ -99,7 +100,7 @@ export interface Rewards { FailRestartable: Reward[]; Expired: Reward[]; } -export interface Reward { +export interface Reward extends Item { value?: string | number; id: string; type: QuestRewardType; diff --git a/types/models/eft/common/tables/IRepeatableQuests.d.ts b/types/models/eft/common/tables/IRepeatableQuests.d.ts index e23ec73..6a02958 100644 --- a/types/models/eft/common/tables/IRepeatableQuests.d.ts +++ b/types/models/eft/common/tables/IRepeatableQuests.d.ts @@ -25,7 +25,7 @@ export interface IPmcDataRepeatableQuest { endTime: number; changeRequirement: TChangeRequirementRecord; } -export declare type TChangeRequirementRecord = Record; +export type TChangeRequirementRecord = Record; export interface IChangeRequirement { changeCost: IChangeCost[]; changeStandingCost: number; diff --git a/types/models/eft/common/tables/ITemplateItem.d.ts b/types/models/eft/common/tables/ITemplateItem.d.ts index 8569e61..0fa7e18 100644 --- a/types/models/eft/common/tables/ITemplateItem.d.ts +++ b/types/models/eft/common/tables/ITemplateItem.d.ts @@ -254,7 +254,7 @@ export interface Props { foodUseTime?: number; foodEffectType?: string; StimulatorBuffs?: string; - effects_health?: any; + effects_health?: IHealthEffect[] | Record>; effects_damage?: any; MaximumNumberOfUsage?: number; knifeHitDelay?: number; @@ -366,6 +366,10 @@ export interface Props { MinTimeToContactExplode?: number; ExplosionEffectType?: string; } +export interface IHealthEffect { + type: string; + value: number; +} export interface Prefab { path: string; rcid: string; diff --git a/types/models/eft/common/tables/ITrader.d.ts b/types/models/eft/common/tables/ITrader.d.ts index 37b2d61..246a5b8 100644 --- a/types/models/eft/common/tables/ITrader.d.ts +++ b/types/models/eft/common/tables/ITrader.d.ts @@ -54,8 +54,9 @@ export interface Repair { currency: string; currency_coefficient: number; excluded_category: string[]; + /** Doesn't exist in client object */ excluded_id_list: any[]; - quality: string; + quality: number; } export interface ITraderAssort { nextResupply: number; diff --git a/types/models/eft/customization/IGetSuitsResponse.d.ts b/types/models/eft/customization/IGetSuitsResponse.d.ts new file mode 100644 index 0000000..cbb909d --- /dev/null +++ b/types/models/eft/customization/IGetSuitsResponse.d.ts @@ -0,0 +1,4 @@ +export interface IGetSuitsResponse { + _id: string; + suites: string[]; +} diff --git a/types/models/eft/dialog/IChatServer.d.ts b/types/models/eft/dialog/IChatServer.d.ts new file mode 100644 index 0000000..48cacc4 --- /dev/null +++ b/types/models/eft/dialog/IChatServer.d.ts @@ -0,0 +1,16 @@ +export interface IChatServer { + _id: string; + RegistrationId: number; + VersionId: string; + Ip: string; + Port: number; + DateTime: number; + Chats: IChat[]; + Regions: string[]; + /** Possibly removed */ + IsDeveloper?: boolean; +} +export interface IChat { + _id: string; + Members: number; +} diff --git a/types/models/eft/dialog/IGetFriendListDataResponse.d.ts b/types/models/eft/dialog/IGetFriendListDataResponse.d.ts index 1d0c0e8..f8d700c 100644 --- a/types/models/eft/dialog/IGetFriendListDataResponse.d.ts +++ b/types/models/eft/dialog/IGetFriendListDataResponse.d.ts @@ -1,8 +1,8 @@ import { MemberCategory } from "../../enums/MemberCategory"; export interface IGetFriendListDataResponse { Friends: Friend[]; - Ignore: any[]; - InIgnoreList: any[]; + Ignore: string[]; + InIgnoreList: string[]; } export interface Friend { _id: string; diff --git a/types/models/eft/game/ICheckVersionResponse.d.ts b/types/models/eft/game/ICheckVersionResponse.d.ts new file mode 100644 index 0000000..fa8aa6f --- /dev/null +++ b/types/models/eft/game/ICheckVersionResponse.d.ts @@ -0,0 +1,4 @@ +export interface ICheckVersionResponse { + isvalid: boolean; + latestVersion: string; +} diff --git a/types/models/eft/game/IGameConfigResponse.d.ts b/types/models/eft/game/IGameConfigResponse.d.ts index eb37a39..e1b7587 100644 --- a/types/models/eft/game/IGameConfigResponse.d.ts +++ b/types/models/eft/game/IGameConfigResponse.d.ts @@ -7,11 +7,13 @@ export interface IGameConfigResponse { activeProfileId: string; backend: Backend; utc_time: number; + /** Total in game time */ totalInGame: number; reportAvailable: boolean; twitchEventMember: boolean; } export interface Backend { + Lobby: string; Trading: string; Messaging: string; Main: string; diff --git a/types/models/eft/game/IGameKeepAliveResponse.d.ts b/types/models/eft/game/IGameKeepAliveResponse.d.ts new file mode 100644 index 0000000..170ce6a --- /dev/null +++ b/types/models/eft/game/IGameKeepAliveResponse.d.ts @@ -0,0 +1,4 @@ +export interface IGameKeepAliveResponse { + msg: string; + utc_time: number; +} diff --git a/types/models/eft/game/IGameLogoutResponseData.d.ts b/types/models/eft/game/IGameLogoutResponseData.d.ts new file mode 100644 index 0000000..0f52050 --- /dev/null +++ b/types/models/eft/game/IGameLogoutResponseData.d.ts @@ -0,0 +1,3 @@ +export interface IGameLogoutResponseData { + status: string; +} diff --git a/types/models/eft/game/IGameStartResponse.d.ts b/types/models/eft/game/IGameStartResponse.d.ts new file mode 100644 index 0000000..9f0ab6d --- /dev/null +++ b/types/models/eft/game/IGameStartResponse.d.ts @@ -0,0 +1,3 @@ +export interface IGameStartResponse { + utc_time: number; +} diff --git a/types/models/eft/game/IServerDetails.d.ts b/types/models/eft/game/IServerDetails.d.ts new file mode 100644 index 0000000..101cf99 --- /dev/null +++ b/types/models/eft/game/IServerDetails.d.ts @@ -0,0 +1,4 @@ +export interface IServerDetails { + ip: string; + port: number; +} diff --git a/types/models/eft/hideout/IHideoutProduction.d.ts b/types/models/eft/hideout/IHideoutProduction.d.ts index ce878be..9295fb1 100644 --- a/types/models/eft/hideout/IHideoutProduction.d.ts +++ b/types/models/eft/hideout/IHideoutProduction.d.ts @@ -3,7 +3,7 @@ export interface IHideoutProduction { areaType: number; requirements: Requirement[]; productionTime: number; - boosters: any; + boosters?: any; endProduct: string; continuous: boolean; count: number; diff --git a/types/models/eft/insurance/IGetInsuranceCostResponseData.d.ts b/types/models/eft/insurance/IGetInsuranceCostResponseData.d.ts index bf209c6..4579fdb 100644 --- a/types/models/eft/insurance/IGetInsuranceCostResponseData.d.ts +++ b/types/models/eft/insurance/IGetInsuranceCostResponseData.d.ts @@ -1 +1 @@ -export declare type IGetInsuranceCostResponseData = Record>; +export type IGetInsuranceCostResponseData = Record>; diff --git a/types/models/eft/inventory/IAddItemRequestData.d.ts b/types/models/eft/inventory/IAddItemRequestData.d.ts index 53db97a..61516d6 100644 --- a/types/models/eft/inventory/IAddItemRequestData.d.ts +++ b/types/models/eft/inventory/IAddItemRequestData.d.ts @@ -1,4 +1,9 @@ export interface IAddItemRequestData { tid: string; - items: any[]; + items: AddItem[]; +} +export interface AddItem { + count: number; + isPreset?: boolean; + item_id: string; } diff --git a/types/models/eft/inventory/IInventoryBaseActionRequestData.d.ts b/types/models/eft/inventory/IInventoryBaseActionRequestData.d.ts index b45e459..6d7c190 100644 --- a/types/models/eft/inventory/IInventoryBaseActionRequestData.d.ts +++ b/types/models/eft/inventory/IInventoryBaseActionRequestData.d.ts @@ -16,7 +16,7 @@ export interface ToLocation { export interface Container { id: string; container: string; - location: Location | number; + location?: Location | number; } export interface Location { x: number; diff --git a/types/models/eft/inventory/IOpenRandomLootContainerRequestData.d.ts b/types/models/eft/inventory/IOpenRandomLootContainerRequestData.d.ts new file mode 100644 index 0000000..3c45124 --- /dev/null +++ b/types/models/eft/inventory/IOpenRandomLootContainerRequestData.d.ts @@ -0,0 +1,11 @@ +import { IInventoryBaseActionRequestData } from "./IInventoryBaseActionRequestData"; +export interface IOpenRandomLootContainerRequestData extends IInventoryBaseActionRequestData { + Action: "OpenRandomLootContainer"; + /** Container item opened */ + item: string; + to: To[]; +} +export interface To { + /** Player character (pmc/scav) id items will be sent to */ + id: string; +} diff --git a/types/models/eft/itemEvent/IItemEventRouterBase.d.ts b/types/models/eft/itemEvent/IItemEventRouterBase.d.ts index 4841cfd..6b18df3 100644 --- a/types/models/eft/itemEvent/IItemEventRouterBase.d.ts +++ b/types/models/eft/itemEvent/IItemEventRouterBase.d.ts @@ -7,11 +7,12 @@ export interface IItemEventRouterBase { warnings: Warning[]; profileChanges: TProfileChanges | ""; } -export declare type TProfileChanges = Record; +export type TProfileChanges = Record; export interface Warning { index: number; - err: string; errmsg: string; + code?: string; + data?: any; } export interface ProfileChange { _id: string; diff --git a/types/models/eft/launcher/IRemoveProfileData.d.ts b/types/models/eft/launcher/IRemoveProfileData.d.ts index d31c9ac..4cc5618 100644 --- a/types/models/eft/launcher/IRemoveProfileData.d.ts +++ b/types/models/eft/launcher/IRemoveProfileData.d.ts @@ -1,2 +1,2 @@ import { ILoginRequestData } from "./ILoginRequestData"; -export declare type IRemoveProfileData = ILoginRequestData; +export type IRemoveProfileData = ILoginRequestData; diff --git a/types/models/eft/match/IStartOffineRaidRequestData.d.ts b/types/models/eft/match/IStartOffineRaidRequestData.d.ts index af0625e..1983728 100644 --- a/types/models/eft/match/IStartOffineRaidRequestData.d.ts +++ b/types/models/eft/match/IStartOffineRaidRequestData.d.ts @@ -2,8 +2,10 @@ import { BotAmount } from "../../enums/BotAmount"; import { BotDifficulty } from "../../enums/BotDifficulty"; export interface IStartOfflineRaidRequestData { locationName: string; + /** Current time, not in-game time */ startTime: number; - dateTime: string; + /** CURR = am, past = pm */ + dateTime: "CURR" | "PAST"; gameSettings: GameSettings; } export interface GameSettings { diff --git a/types/models/eft/notifier/ISelectProfileResponse.d.ts b/types/models/eft/notifier/ISelectProfileResponse.d.ts new file mode 100644 index 0000000..ecb668a --- /dev/null +++ b/types/models/eft/notifier/ISelectProfileResponse.d.ts @@ -0,0 +1,6 @@ +import { INotifierChannel } from "./INotifier"; +export interface ISelectProfileResponse { + status: string; + notifier: INotifierChannel; + notifierServer: string; +} diff --git a/types/models/eft/profile/GetProfileStatusResponseData.d.ts b/types/models/eft/profile/GetProfileStatusResponseData.d.ts index eee9b4f..cb7368c 100644 --- a/types/models/eft/profile/GetProfileStatusResponseData.d.ts +++ b/types/models/eft/profile/GetProfileStatusResponseData.d.ts @@ -4,6 +4,7 @@ export interface GetProfileStatusResponseData { } export interface ProfileData { profileid: string; + profileToken: string; status: string; sid: string; ip: string; diff --git a/types/models/eft/profile/IAkiProfile.d.ts b/types/models/eft/profile/IAkiProfile.d.ts index eaa66c1..2cea0c8 100644 --- a/types/models/eft/profile/IAkiProfile.d.ts +++ b/types/models/eft/profile/IAkiProfile.d.ts @@ -11,6 +11,12 @@ export interface IAkiProfile { vitality: Vitality; inraid: Inraid; insurance: Insurance[]; + /** Assort purchases made by player since last trader refresh */ + traderPurchases?: Record>; +} +export declare class TraderPurchaseData { + count: number; + purchaseTimestamp: number; } export interface Info { id: string; @@ -37,12 +43,12 @@ export interface Dialogue { attachmentsNew: number; } export interface DialogueInfo { - _id: string; - type: MessageType; - message: MessagePreview; - pinned: boolean; - new: number; attachmentsNew: number; + new: number; + type: MessageType; + pinned: boolean; + message: MessagePreview; + _id: string; } export interface Message { _id: string; @@ -93,6 +99,13 @@ export interface DateTime { } export interface Aki { version: string; + mods?: ModDetails[]; +} +export interface ModDetails { + name: string; + version: string; + author: string; + dateAdded: number; } export interface Vitality { health: Health; diff --git a/types/models/eft/ragfair/IRagfairOffer.d.ts b/types/models/eft/ragfair/IRagfairOffer.d.ts index 141b605..792ec7d 100644 --- a/types/models/eft/ragfair/IRagfairOffer.d.ts +++ b/types/models/eft/ragfair/IRagfairOffer.d.ts @@ -7,18 +7,19 @@ export interface IRagfairOffer { requirements: OfferRequirement[]; root: string; intId: number; + /** Handbook price */ itemsCost: number; + /** Rouble price */ requirementsCost: number; startTime: number; endTime: number; sellInOnePiece: boolean; - name?: string; - shortName?: string; loyaltyLevel: number; buyRestrictionMax?: number; buyRestrictionCurrent?: number; locked: boolean; unlimitedCount: boolean; + /** Rouble price */ summaryCost: number; user: IRagfairOfferUser; notAvailable: boolean; @@ -32,11 +33,11 @@ export interface OfferRequirement { } export interface IRagfairOfferUser { id: string; - nickname: string; - rating: number; + nickname?: string; + rating?: number; memberType: MemberCategory; - avatar: string; - isRatingGrowing: boolean; + avatar?: string; + isRatingGrowing?: boolean; } export interface SellResult { sellTime: number; diff --git a/types/models/eft/ragfair/ISearchRequestData.d.ts b/types/models/eft/ragfair/ISearchRequestData.d.ts index 08e7fd3..56d093b 100644 --- a/types/models/eft/ragfair/ISearchRequestData.d.ts +++ b/types/models/eft/ragfair/ISearchRequestData.d.ts @@ -1,7 +1,8 @@ +import { RagfairSort } from "../../enums/RagfairSort"; export interface ISearchRequestData { page: number; limit: number; - sortType: number; + sortType: RagfairSort; sortDirection: number; currency: number; priceFrom: number; diff --git a/types/models/eft/weather/IWeatherData.d.ts b/types/models/eft/weather/IWeatherData.d.ts index ecc96ce..1f5d5b5 100644 --- a/types/models/eft/weather/IWeatherData.d.ts +++ b/types/models/eft/weather/IWeatherData.d.ts @@ -1,17 +1,18 @@ +import { WindDirection } from "../../../models/enums/WindDirection"; export interface IWeatherData { acceleration: number; time: string; date: string; - weather: IWeather; + weather?: IWeather; } export interface IWeather { pressure: number; temp: number; - fog: string; + fog: number; rain_intensity: number; - rain: any; + rain: number; wind_gustiness: number; - wind_direction: any; + wind_direction: WindDirection; wind_speed: number; cloud: number; time: string; diff --git a/types/models/enums/BackendErrorCodes.d.ts b/types/models/enums/BackendErrorCodes.d.ts new file mode 100644 index 0000000..6614b75 --- /dev/null +++ b/types/models/enums/BackendErrorCodes.d.ts @@ -0,0 +1,67 @@ +export declare enum BackendErrorCodes { + NONE = 0, + UNKNOWN_ERROR = 200, + NOT_AUTHORIZED = 201, + NEED_AUTHORIZATION_CODE = 209, + WRONG_AUTHORIZATION_CODE = 211, + NEED_CAPTCHA = 214, + NO_NEED_CAPTCHA = 215, + CAPTCHA_FAILED = 218, + CAPTCHA_BRUTE_FORCED = 219, + NO_ROOM_IN_STASH = 223, + NICKNAME_NOT_UNIQUE = 225, + NICKNAME_NOT_VALID = 226, + UNSUPPORTED_CLIENT_VERSION = 232, + REPORT_NOT_ALLOWED = 238, + NICKNAME_IS_ABUSIVE = 241, + NICKNAME_CHANGE_TIMEOUT = 242, + NOT_MODIFIED = 304, + HTTP_BAD_REQUEST = 400, + HTTP_NOT_AUTHORIZED = 401, + HTTP_FORBIDDEN = 403, + HTTP_NOT_FOUND = 404, + HTTP_METHOD_NOT_ALLOWED = 405, + UNKNOWN_TRADING_ERROR = 500, + HTTPNOTIMPLEMENTED = 501, + HTTPBADGATEWAY = 502, + HTTPSERVICEUNAVAILABLE = 503, + HTTPGATEWAYTIMEOUT = 504, + TRADEROUTOFMONEY = 505, + HTTPVARIANTALSONEGOTIATES = 506, + PRICECHANGED = 509, + TRADERDISABLED = 512, + ITEMHASBEENSOLD = 513, + NOTENOUGHSPACEFORMONEY = 518, + HTTPINVALIDSSLCERTIFICATE = 526, + UNKNOWNRAGFAIRERROR = 550, + UNKNOWNRAGFAIRERROR2 = 551, + UNKNOWNMATCHMAKERERROR = 600, + SESSIONPARAMETERSERROR = 601, + SESSIONLOST = 602, + SERVERNOTREGISTERED = 604, + UNKNOWNQUESTERROR = 700, + QUESTBADPARAM = 702, + QUESTNOTFOUND = 703, + QUESTISUNAVAILABLE = 704, + NOFREESPACEFORREWARDS = 705, + WRONGQUESTSTATUS = 706, + CANTCOMPLETEQUEST = 707, + UNKNOWNMAILERROR = 900, + TOOMANYFRIENDREQUESTS = 925, + UNKNOWNSCRIPTEXECUTIONERROR = 1000, + UNKNOWNREPAIRINGERROR = 1200, + UNKNOWNINSURANCEERROR = 1300, + UNKNOWNCURRENCYEXCHANGEERROR = 1400, + OFFERNOTFOUND = 1503, + NOTENOUGHSPACE = 1505, + OFFEROUTOFSTOCK = 1506, + OFFERSOLD = 1507, + RAGFAIRUNAVAILABLE = 1511, + BANNEDERRORCODE = 1513, + INSUFFICIENTNUMBERINSTOCK = 1516, + TOOMANYITEMSTOSELL = 1517, + EXAMINATIONFAILED = 22001, + ITEMALREADYEXAMINED = 22002, + UNKNOWNNGINXERROR = 9000, + PARSERESPONSEERROR = 9001 +} diff --git a/types/models/enums/BaseClasses.d.ts b/types/models/enums/BaseClasses.d.ts index 36ebc71..7d11510 100644 --- a/types/models/enums/BaseClasses.d.ts +++ b/types/models/enums/BaseClasses.d.ts @@ -1,10 +1,15 @@ export declare enum BaseClasses { WEAPON = "5422acb9af1c889c16000029", ARMOR = "5448e54d4bdc2dcc718b4568", + ARMOREDEQUIPMENT = "57bef4c42459772e8d35a53b", + HEADWEAR = "5a341c4086f77401f2541505", + FACECOVER = "5a341c4686f77469e155819e", VEST = "5448e5284bdc2dcb718b4567", BACKPACK = "5448e53e4bdc2d60728b4567", VISORS = "5448e5724bdc2ddf718b4568", FOOD = "5448e8d04bdc2ddf718b4569", + GAS_BLOCK = "56ea9461d2720b67698b456f", + RAIL_COVER = "55818b1d4bdc2d5b648b4572", DRINK = "5448e8d64bdc2dce718b4568", BARTER_ITEM = "5448eb774bdc2d0a728b4567", INFO = "5448ecbe4bdc2d60728b4568", @@ -33,6 +38,7 @@ export declare enum BaseClasses { THROW_WEAPON = "543be6564bdc2df4348b4568", FOOD_DRINK = "543be6674bdc2df1348b4569", PISTOL = "5447b5cf4bdc2d65278b4567", + REVOLVER = "617f1ef5e8b54b0998387733", SMG = "5447b5e04bdc2d62278b4567", ASSAULT_RIFLE = "5447b5f14bdc2d61278b4567", ASSAULT_CARBINE = "5447b5fc4bdc2d87278b4567", @@ -70,9 +76,10 @@ export declare enum BaseClasses { TACTICAL_COMBO = "55818b164bdc2ddc698b456c", FLASHLIGHT = "55818b084bdc2d5b648b4571", MAGAZINE = "5448bc234bdc2d3c308b4569", - LIGHT_LASER = "55818b0e4bdc2dde698b456e", + LIGHT_LASER_DESIGNATOR = "55818b0e4bdc2dde698b456e", FLASH_HIDER = "550aa4bf4bdc2dd6348b456b", COLLIMATOR = "55818ad54bdc2ddc698b4569", + IRON_SIGHT = "55818ac54bdc2d5b648b456e", COMPACT_COLLIMATOR = "55818acf4bdc2dde698b456b", COMPENSATOR = "550aa4af4bdc2dd4348b456e", OPTIC_SCOPE = "55818ae44bdc2dde698b456c", diff --git a/types/models/enums/ConfigTypes.d.ts b/types/models/enums/ConfigTypes.d.ts index 468ece5..9c48b68 100644 --- a/types/models/enums/ConfigTypes.d.ts +++ b/types/models/enums/ConfigTypes.d.ts @@ -18,5 +18,6 @@ export declare enum ConfigTypes { REPAIR = "aki-repair", SCAVCASE = "aki-scavcase", TRADER = "aki-trader", - WEATHER = "aki-weather" + WEATHER = "aki-weather", + SEASONAL_EVENT = "aki-seasonalevents" } diff --git a/types/models/enums/ExitStatis.d.ts b/types/models/enums/ExitStatis.d.ts new file mode 100644 index 0000000..78d9733 --- /dev/null +++ b/types/models/enums/ExitStatis.d.ts @@ -0,0 +1,7 @@ +export declare enum ExitStatus { + SURVIVED = 0, + KILLED = 1, + LEFT = 2, + RUNNER = 3, + MISSINGINACTION = 4 +} diff --git a/types/models/enums/HideoutEventActions.d.ts b/types/models/enums/HideoutEventActions.d.ts new file mode 100644 index 0000000..e441477 --- /dev/null +++ b/types/models/enums/HideoutEventActions.d.ts @@ -0,0 +1,11 @@ +export declare enum HideoutEventActions { + HIDEOUT_UPGRADE = "HideoutUpgrade", + HIDEOUT_UPGRADE_COMPLETE = "HideoutUpgradeComplete", + HIDEOUT_PUT_ITEMS_IN_AREA_SLOTS = "HideoutPutItemsInAreaSlots", + HIDEOUT_TAKE_ITEMS_FROM_AREA_SLOTS = "HideoutTakeItemsFromAreaSlots", + HIDEOUT_TOGGLE_AREA = "HideoutToggleArea", + HIDEOUT_SINGLE_PRODUCTION_START = "HideoutSingleProductionStart", + HIDEOUT_SCAV_CASE_PRODUCTION_START = "HideoutScavCaseProductionStart", + HIDEOUT_CONTINUOUS_PRODUCTION_START = "HideoutContinuousProductionStart", + HIDEOUT_TAKE_PRODUCTION = "HideoutTakeProduction" +} diff --git a/types/models/enums/ItemEventActions.d.ts b/types/models/enums/ItemEventActions.d.ts new file mode 100644 index 0000000..0e65453 --- /dev/null +++ b/types/models/enums/ItemEventActions.d.ts @@ -0,0 +1,19 @@ +export declare enum ItemEventActions { + MOVE = "Move", + REMOVE = "Remove", + SPLIT = "Split", + MERGE = "Merge", + TRANSFER = "Transfer", + SWAP = "Swap", + FOLD = "Fold", + TOGGLE = "Toggle", + TAG = "Tag", + BIND = "Bind", + EXAMINE = "Examine", + READ_ENCYCLOPEDIA = "ReadEncyclopedia", + APPLY_INVENTORY_CHANGES = "ApplyInventoryChanges", + CREATE_MAP_MARKER = "CreateMapMarker", + DELETE_MAP_MARKER = "DeleteMapMarker", + EDIT_MAP_MARKER = "EditMapMarker", + OPEN_RANDOM_LOOT_CONTAINER = "OpenRandomLootContainer" +} diff --git a/types/models/enums/RagfairSort.d.ts b/types/models/enums/RagfairSort.d.ts new file mode 100644 index 0000000..798a5e7 --- /dev/null +++ b/types/models/enums/RagfairSort.d.ts @@ -0,0 +1,7 @@ +export declare enum RagfairSort { + ID = 0, + RATING = 3, + OFFER_TITLE = 4, + PRICE = 5, + EXPIRY = 6 +} diff --git a/types/models/enums/WeatherType.d.ts b/types/models/enums/WeatherType.d.ts new file mode 100644 index 0000000..d31fefe --- /dev/null +++ b/types/models/enums/WeatherType.d.ts @@ -0,0 +1,19 @@ +export declare enum WeatherType { + CLEAR_DAY = 1, + CLEAR_WIND = 2, + CLEAR_NIGHT = 3, + PARTLY_CLOUD_DAY = 4, + PARTLY_CLOUD_NIGHT = 5, + CLEAR_FOG_DAY = 6, + CLEAR_FOG_NIGHT = 7, + CLOUDFOG = 8, + FOG = 9, + MOSTLY_CLOUD = 10, + LIGHT_RAIN = 11, + RAIN = 12, + CLOUD_WIND = 13, + CLOUD_WIND_RAIN = 14, + FULL_CLOUD = 15, + THUNDER_CLOUD = 16, + NONE = 0 +} diff --git a/types/models/enums/WildSpawnTypeNumber.d.ts b/types/models/enums/WildSpawnTypeNumber.d.ts new file mode 100644 index 0000000..ff806fe --- /dev/null +++ b/types/models/enums/WildSpawnTypeNumber.d.ts @@ -0,0 +1,33 @@ +export declare enum WildSpawnTypeNumber { + ASSAULT = 1, + MARKSMAN = 2, + BOSSTEST = 4, + BOSSBULLY = 8, + FOLLOWERTEST = 16, + FOLLOWERBULLY = 32, + BOSSKILLA = 64, + BOSSKOJANIY = 128, + FOLLOWERKOJANIY = 256, + PMCBOT = 512, + CURSEDASSAULT = 1024, + BOSSGLUHAR = 2048, + FOLLOWERGLUHARASSAULT = 4096, + FOLLOWERGLUHARSECURITY = 8192, + FOLLOWERGLUHARSCOUT = 16384, + FOLLOWERGLUHARSNIPE = 32768, + FOLLOWERSANITAR = 65536, + BOSSSANITAR = 131072, + TEST = 262144, + ASSAULTGROUP = 524288, + SECTANTWARRIOR = 1048576, + SECTANTPRIEST = 2097152, + BOSSTAGILLA = 4194304, + FOLLOWERTAGILLA = 8388608, + EXUSEC = 16777216, + GIFTER = 33554432, + BOSSKNIGHT = 67108864, + FOLLOWERBIGPIPE = 134217728, + FOLLOWERBIRDEYE = 268435456, + SPTUSEC = 536870912, + SPTBEAR = 1073741824 +} diff --git a/types/models/enums/WindDirection.d.ts b/types/models/enums/WindDirection.d.ts new file mode 100644 index 0000000..fb30b20 --- /dev/null +++ b/types/models/enums/WindDirection.d.ts @@ -0,0 +1,10 @@ +export declare enum WindDirection { + EAST = 1, + NORTH = 2, + WEST = 3, + SOUTH = 4, + SE = 5, + SW = 6, + NW = 7, + NE = 8 +} diff --git a/types/models/external/HttpFramework.d.ts b/types/models/external/HttpFramework.d.ts new file mode 100644 index 0000000..64a37d6 --- /dev/null +++ b/types/models/external/HttpFramework.d.ts @@ -0,0 +1,33 @@ +/// +import { IncomingMessage, ServerResponse } from "http"; +export type HandleFn = (_: string, req: IncomingMessage, resp: ServerResponse) => void; +/** + * Associates handlers, HTTP methods and a base url to a listener using a proxy + * @param basePath The base path + * @returns The decorator that create the listener proxy + */ +export declare const Listen: (basePath: string) => any>(Base: T) => T; +/** + * HTTP DELETE decorator + */ +export declare const Delete: (path?: string) => (target: any, propertyKey: string) => void; +/** + * HTTP GET decorator + */ +export declare const Get: (path?: string) => (target: any, propertyKey: string) => void; +/** + * HTTP OPTIONS decorator + */ +export declare const Options: (path?: string) => (target: any, propertyKey: string) => void; +/** + * HTTP PATCH decorator + */ +export declare const Patch: (path?: string) => (target: any, propertyKey: string) => void; +/** + * HTTP POST decorator + */ +export declare const Post: (path?: string) => (target: any, propertyKey: string) => void; +/** + * HTTP PUT decorator + */ +export declare const Put: (path?: string) => (target: any, propertyKey: string) => void; diff --git a/types/models/spt/bots/BotGenerationDetails.d.ts b/types/models/spt/bots/BotGenerationDetails.d.ts new file mode 100644 index 0000000..26571a2 --- /dev/null +++ b/types/models/spt/bots/BotGenerationDetails.d.ts @@ -0,0 +1,18 @@ +export interface BotGenerationDetails { + /** Should the bot be generated as a PMC */ + isPmc: boolean; + /** assault/pmcBot etc */ + role: string; + /** Side of bot */ + side: string; + /** Active players current level */ + playerLevel: number; + /** Delta of highest level of bot */ + botRelativeLevelDeltaMax: number; + /** How many to create and store */ + botCountToGenerate: number; + /** Desired difficulty of the bot */ + botDifficulty: string; + /** Will the generated bot be a player scav */ + isPlayerScav: boolean; +} diff --git a/types/models/spt/callbacks/IDataCallbacks.d.ts b/types/models/spt/callbacks/IDataCallbacks.d.ts index a098560..b4f4f8c 100644 --- a/types/models/spt/callbacks/IDataCallbacks.d.ts +++ b/types/models/spt/callbacks/IDataCallbacks.d.ts @@ -6,7 +6,6 @@ import { IHideoutProduction } from "../../eft/hideout/IHideoutProduction"; import { IHideoutScavCase } from "../../eft/hideout/IHideoutScavCase"; import { IHideoutSettingsBase } from "../../eft/hideout/IHideoutSettingsBase"; import { IGetBodyResponseData } from "../../eft/httpResponse/IGetBodyResponseData"; -import { ILanguageBase } from "../server/ILocaleBase"; import { ISettingsBase } from "../server/ISettingsBase"; export interface IDataCallbacks { getSettings(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; @@ -20,7 +19,7 @@ export interface IDataCallbacks { getHideoutAreas(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; gethideoutProduction(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getHideoutScavcase(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - getLocalesLanguages(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + getLocalesLanguages(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData>; getLocalesMenu(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getLocalesGlobal(url: string, info: IEmptyRequestData, sessionID: string): string; } diff --git a/types/models/spt/config/IAirdropConfig.d.ts b/types/models/spt/config/IAirdropConfig.d.ts index e963a1b..53df991 100644 --- a/types/models/spt/config/IAirdropConfig.d.ts +++ b/types/models/spt/config/IAirdropConfig.d.ts @@ -25,5 +25,6 @@ export interface AirdropLoot { itemTypeWhitelist: string[]; /** key: item base type: value: max count */ itemLimits: Record; + itemStackLimits: Record; armorLevelWhitelist: number[]; } diff --git a/types/models/spt/config/IBotConfig.d.ts b/types/models/spt/config/IBotConfig.d.ts index 2d495f9..4b1a621 100644 --- a/types/models/spt/config/IBotConfig.d.ts +++ b/types/models/spt/config/IBotConfig.d.ts @@ -24,9 +24,11 @@ export interface IBotConfig extends IBaseConfig { /** Show a bots botType value after their name */ showTypeInNickname: boolean; /** Max number of bots that can be spawned in a raid at any one time */ - maxBotCap: number; + maxBotCap: Record; /** How many stacks of secret ammo should a bot have in its bot secure container */ secureContainerAmmoStackCount: number; + /** Batch generation size when type not available in cache */ + botGenerationBatchSizePerType: number; } export interface PresetBatch { assault: number; @@ -64,10 +66,15 @@ export interface LootNvalue { } export interface EquipmentFilters { weaponModLimits: ModLimits; - randomisedWeaponModSlots?: string[]; - randomisedArmorSlots?: string[]; + weaponSightWhitelist: Record; + faceShieldIsActiveChancePercent?: number; + lightLaserIsActiveChancePercent?: number; + nvgIsActiveChancePercent?: number; + randomisation: RandomisationDetails[]; blacklist: EquipmentFilterDetails[]; whitelist: EquipmentFilterDetails[]; + clothing: WeightingAdjustmentDetails[]; + weightingAdjustments: WeightingAdjustmentDetails[]; } export interface ModLimits { /** How many scopes are allowed on a weapon - hard coded to work with OPTIC_SCOPE, ASSAULT_SCOPE, COLLIMATOR, COMPACT_COLLIMATOR */ @@ -75,8 +82,27 @@ export interface ModLimits { /** How many lasers or lights are allowed on a weapon - hard coded to work with TACTICAL_COMBO, and FLASHLIGHT */ lightLaserLimit?: number; } +export interface RandomisationDetails { + levelRange: MinMax; + randomisedWeaponModSlots?: string[]; + randomisedArmorSlots?: string[]; + /** Equipment chances */ + equipment?: Record; + /** Modc chances */ + mods?: Record; +} export interface EquipmentFilterDetails { levelRange: MinMax; equipment: Record; cartridge: Record; } +export interface WeightingAdjustmentDetails { + levelRange: MinMax; + ammo?: AdjustmentDetails; + equipment?: AdjustmentDetails; + clothing?: AdjustmentDetails; +} +export interface AdjustmentDetails { + add: Record>; + edit: Record>; +} diff --git a/types/models/spt/config/IHttpConfig.d.ts b/types/models/spt/config/IHttpConfig.d.ts index c41d035..3fe4787 100644 --- a/types/models/spt/config/IHttpConfig.d.ts +++ b/types/models/spt/config/IHttpConfig.d.ts @@ -1,5 +1,6 @@ import { IBaseConfig } from "./IBaseConfig"; export interface IHttpConfig extends IBaseConfig { + webSocketPingDelayMs: number; kind: "aki-http"; ip: string; port: number; diff --git a/types/models/spt/config/IInventoryConfig.d.ts b/types/models/spt/config/IInventoryConfig.d.ts index ffffa41..4642b9b 100644 --- a/types/models/spt/config/IInventoryConfig.d.ts +++ b/types/models/spt/config/IInventoryConfig.d.ts @@ -2,4 +2,10 @@ import { IBaseConfig } from "./IBaseConfig"; export interface IInventoryConfig extends IBaseConfig { kind: "aki-inventory"; newItemsMarkedFound: boolean; + randomLootContainers: Record; +} +export interface RewardDetails { + rewardCount: number; + foundInRaid: boolean; + rewardTplPool: Record; } diff --git a/types/models/spt/config/ILocaleConfig.d.ts b/types/models/spt/config/ILocaleConfig.d.ts index fe9abf7..0a8955c 100644 --- a/types/models/spt/config/ILocaleConfig.d.ts +++ b/types/models/spt/config/ILocaleConfig.d.ts @@ -1,5 +1,10 @@ import { IBaseConfig } from "./IBaseConfig"; export interface ILocaleConfig extends IBaseConfig { kind: "aki-locale"; - desiredLocale: string; + /** e.g. ru/en/cn/fr etc, or 'system', will take computer locale setting */ + gameLocale: string; + /** e.g. ru/en/cn/fr etc, or 'system', will take computer locale setting */ + serverLocale: string; + /** Languages server can be translated into */ + serverSupportedLocales: string[]; } diff --git a/types/models/spt/config/ILocationConfig.d.ts b/types/models/spt/config/ILocationConfig.d.ts index 0551d57..a012fae 100644 --- a/types/models/spt/config/ILocationConfig.d.ts +++ b/types/models/spt/config/ILocationConfig.d.ts @@ -1,8 +1,16 @@ +import { BossLocationSpawn, Wave } from "../../../models/eft/common/ILocationBase"; import { IBaseConfig } from "./IBaseConfig"; export interface ILocationConfig extends IBaseConfig { kind: "aki-location"; looseLootMultiplier: LootMultiplier; staticLootMultiplier: LootMultiplier; + customWaves: CustomWaves; + /** Open zones to add to map */ + openZones: Record; +} +export interface CustomWaves { + boss: Record; + normal: Record; } export interface LootMultiplier { bigmap: number; diff --git a/types/models/spt/config/IPmcConfig.d.ts b/types/models/spt/config/IPmcConfig.d.ts index 9db2ba1..979122c 100644 --- a/types/models/spt/config/IPmcConfig.d.ts +++ b/types/models/spt/config/IPmcConfig.d.ts @@ -6,14 +6,17 @@ export interface IPmcConfig { looseWeaponInBackpackChancePercent: number; looseWeaponInBackpackLootMinMax: MinMax; isUsec: number; + usecType: string; + bearType: string; chanceSameSideIsHostilePercent: number; /** key: location, value: type for usec/bear */ - pmcType: Record; + pmcType: Record>>; maxBackpackLootTotalRub: number; maxPocketLootTotalRub: number; maxVestLootTotalRub: number; convertIntoPmcChance: Record; enemyTypes: string[]; + botRelativeLevelDeltaMax: number; } export interface PmcTypes { usec: string; diff --git a/types/models/spt/config/IQuestConfig.d.ts b/types/models/spt/config/IQuestConfig.d.ts index 45c9aae..951f1a7 100644 --- a/types/models/spt/config/IQuestConfig.d.ts +++ b/types/models/spt/config/IQuestConfig.d.ts @@ -4,6 +4,7 @@ export interface IQuestConfig extends IBaseConfig { kind: "aki-quest"; redeemTime: number; repeatableQuests: IRepeatableQuestConfig[]; + locationIdMap: Record; bearOnlyQuests: string[]; usecOnlyQuests: string[]; } diff --git a/types/models/spt/config/IRagfairConfig.d.ts b/types/models/spt/config/IRagfairConfig.d.ts index c1b8763..6786417 100644 --- a/types/models/spt/config/IRagfairConfig.d.ts +++ b/types/models/spt/config/IRagfairConfig.d.ts @@ -28,12 +28,8 @@ export interface Reputation { gain: number; loss: number; } -export declare class OfferAdjustment { - maxPriceDifferenceBelowHandbookPercent: number; - handbookPriceMultipier: number; - priceThreshholdRub: number; -} export interface Dynamic { + barter: Barter; offerAdjustment: OfferAdjustment; expiredOfferThreshold: number; offerItemCount: MinMax; @@ -49,6 +45,20 @@ export interface Dynamic { showAsSingleStack: string[]; blacklist: Blacklist; } +export declare class Barter { + enable: boolean; + chancePercent: number; + itemCountMin: number; + itemCountMax: number; + priceRangeVariancePercent: number; + minRoubleCostToBecomeBarter: number; + itemTypeBlacklist: string[]; +} +export declare class OfferAdjustment { + maxPriceDifferenceBelowHandbookPercent: number; + handbookPriceMultipier: number; + priceThreshholdRub: number; +} export interface Condition { conditionChance: number; min: number; diff --git a/types/models/spt/config/ISeasonalEventConfig.d.ts b/types/models/spt/config/ISeasonalEventConfig.d.ts new file mode 100644 index 0000000..e410925 --- /dev/null +++ b/types/models/spt/config/ISeasonalEventConfig.d.ts @@ -0,0 +1,15 @@ +import { IBaseConfig } from "./IBaseConfig"; +export interface ISeasonalEventConfig extends IBaseConfig { + kind: "aki-seasonalevents"; + enableSeasonalEventDetection: boolean; + /** event / botType / equipSlot / itemid */ + eventGear: Record>>>; + events: ISeasonalEvent[]; +} +export interface ISeasonalEvent { + name: string; + startDay: number; + startMonth: number; + endDay: number; + endMonth: number; +} diff --git a/types/models/spt/config/ITraderConfig.d.ts b/types/models/spt/config/ITraderConfig.d.ts index 6b1c1e3..b1ec484 100644 --- a/types/models/spt/config/ITraderConfig.d.ts +++ b/types/models/spt/config/ITraderConfig.d.ts @@ -1,10 +1,13 @@ +import { MinMax } from "../../../models/common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface ITraderConfig extends IBaseConfig { kind: "aki-trader"; updateTime: UpdateTime[]; updateTimeDefault: number; + /** What % of max durability an item needs to sell to a trader*/ + durabilityPurchaseThreshhold: Record; traderPriceMultipler: number; - minDurabilityForSale: number; + persistPurchaseDataInProfile: boolean; fence: FenceConfig; } export interface UpdateTime { @@ -17,5 +20,10 @@ export interface FenceConfig { assortSize: number; maxPresetsPercent: number; presetPriceMult: number; + armorMaxDurabilityPercentMinMax: MinMax; + presetMaxDurabilityPercentMinMax: MinMax; + itemPriceMult: number; + regenerateAssortsOnRefresh: boolean; + itemTypeLimits: Record; blacklist: string[]; } diff --git a/types/models/spt/config/IWeatherConfig.d.ts b/types/models/spt/config/IWeatherConfig.d.ts index bbdc43e..41a1c83 100644 --- a/types/models/spt/config/IWeatherConfig.d.ts +++ b/types/models/spt/config/IWeatherConfig.d.ts @@ -1,3 +1,4 @@ +import { WindDirection } from "../../../models/enums/WindDirection"; import { MinMax } from "../../common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface IWeatherConfig extends IBaseConfig { @@ -7,12 +8,16 @@ export interface IWeatherConfig extends IBaseConfig { } export interface Weather { clouds: MinMax; - windSpeed: MinMax; - windDirection: MinMax; + windSpeed: WeatherSettings; + windDirection: WeatherSettings; windGustiness: MinMax; - rain: MinMax; + rain: WeatherSettings; rainIntensity: MinMax; - fog: MinMax; + fog: WeatherSettings; temp: MinMax; pressure: MinMax; } +export interface WeatherSettings { + values: T[]; + weights: number[]; +} diff --git a/types/models/spt/server/IHttpServer.d.ts b/types/models/spt/server/IHttpServer.d.ts deleted file mode 100644 index c828399..0000000 --- a/types/models/spt/server/IHttpServer.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -/// -/// -import http, { ServerResponse } from "http"; -import { INotification } from "../../eft/notifier/INotifier"; -export interface IHttpServer { - load(): void; - getCookies(req: http.IncomingMessage): any; - sendFile(resp: ServerResponse, file: any): void; - isConnectionWebSocket(sessionID: string): boolean; - sendResponse(sessionID: string, req: any, resp: any, body: Buffer): void; - sendMessage(sessionID: string, output: INotification): void; -} diff --git a/types/models/spt/server/ILocaleBase.d.ts b/types/models/spt/server/ILocaleBase.d.ts index 6e20b89..3cdaf6f 100644 --- a/types/models/spt/server/ILocaleBase.d.ts +++ b/types/models/spt/server/ILocaleBase.d.ts @@ -1,49 +1,5 @@ export interface ILocaleBase { - global: Record; + global: Record>; menu: Record; - languages: ILanguageBase[]; -} -export interface ILocaleGlobalBase { - interface: Record; - enum: any[]; - mail: Record; - quest: Record; - preset: Record; - handbook: Record; - season: Record; - customization: Record; - repeatableQuest: Record; - templates: Record; - locations: Record; - banners: Record; - trading: Record; -} -export interface ILocaleQuest { - name: string; - description: string; - note: string; - failMessageText: string; - startedMessageText: string; - successMessageText: string; - conditions: Record; - location: string; -} -export interface ILocalePreset { - Name: string; -} -export interface ILocaleProps { - Name: string; - ShortName: string; - Description: string; -} -export interface ILocaleTradingProps { - FullName: string; - FirstName: string; - Nickname: string; - Location: string; - Description: string; -} -export interface ILanguageBase { - ShortName: string; - Name: string; + languages: Record; } diff --git a/types/models/spt/server/ISettingsBase.d.ts b/types/models/spt/server/ISettingsBase.d.ts index c067cda..625ad5c 100644 --- a/types/models/spt/server/ISettingsBase.d.ts +++ b/types/models/spt/server/ISettingsBase.d.ts @@ -11,6 +11,7 @@ export interface Config { FramerateLimit: FramerateLimit; GroupStatusInterval: number; KeepAliveInterval: number; + LobbyKeepAliveInterval: number; Mark502and504AsNonImportant: boolean; MemoryManagementSettings: MemoryManagementSettings; NVidiaHighlights: boolean; @@ -18,7 +19,10 @@ export interface Config { PingServerResultSendInterval: number; PingServersInterval: number; ReleaseProfiler: ReleaseProfiler; + RequestConfirmationTimeouts: number[]; + RequestsMadeThroughLobby: string[]; SecondCycleDelaySeconds: number; + ShouldEstablishLobbyConnection: boolean; TurnOffLogging: boolean; WeaponOverlapDistanceCulling: number; WebDiagnosticsEnabled: boolean; diff --git a/types/models/spt/services/LootRequest.d.ts b/types/models/spt/services/LootRequest.d.ts index 9213160..8c197ee 100644 --- a/types/models/spt/services/LootRequest.d.ts +++ b/types/models/spt/services/LootRequest.d.ts @@ -6,5 +6,6 @@ export declare class LootRequest { itemTypeWhitelist: string[]; /** key: item base type: value: max count */ itemLimits: Record; + itemStackLimits: Record; armorLevelWhitelist: number[]; } diff --git a/types/routers/EventOutputHolder.d.ts b/types/routers/EventOutputHolder.d.ts new file mode 100644 index 0000000..7a2387b --- /dev/null +++ b/types/routers/EventOutputHolder.d.ts @@ -0,0 +1,11 @@ +import { JsonUtil } from "../utils/JsonUtil"; +import { ProfileHelper } from "../helpers/ProfileHelper"; +import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +export declare class EventOutputHolder { + protected jsonUtil: JsonUtil; + protected profileHelper: ProfileHelper; + constructor(jsonUtil: JsonUtil, profileHelper: ProfileHelper); + protected output: IItemEventRouterResponse; + getOutput(sessionID: string): IItemEventRouterResponse; + resetOutput(sessionID: string): void; +} diff --git a/types/routers/ImageRouter.d.ts b/types/routers/ImageRouter.d.ts index ab03977..675441c 100644 --- a/types/routers/ImageRouter.d.ts +++ b/types/routers/ImageRouter.d.ts @@ -1,13 +1,14 @@ /// import { IncomingMessage, ServerResponse } from "http"; -import { IHttpServer } from "../models/spt/server/IHttpServer"; import { ImageRouteService } from "../services/mod/image/ImageRouteService"; +import { HttpFileUtil } from "../utils/HttpFileUtil"; import { VFS } from "../utils/VFS"; export declare class ImageRouter { protected vfs: VFS; protected imageRouteService: ImageRouteService; - constructor(vfs: VFS, imageRouteService: ImageRouteService); + protected httpFileUtil: HttpFileUtil; + constructor(vfs: VFS, imageRouteService: ImageRouteService, httpFileUtil: HttpFileUtil); addRoute(key: string, valueToAdd: string): void; - sendImage(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: any, httpServer: IHttpServer): void; + sendImage(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: any): void; getImage(): string; } diff --git a/types/routers/ItemEventRouter.d.ts b/types/routers/ItemEventRouter.d.ts index b1ac5d9..a9338ab 100644 --- a/types/routers/ItemEventRouter.d.ts +++ b/types/routers/ItemEventRouter.d.ts @@ -1,17 +1,16 @@ -import { JsonUtil } from "../utils/JsonUtil"; -import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; -import { IItemEventRouterRequest } from "../models/eft/itemEvent/IItemEventRouterRequest"; -import { ProfileHelper } from "../helpers/ProfileHelper"; import { ItemEventRouterDefinition } from "../di/Router"; +import { ProfileHelper } from "../helpers/ProfileHelper"; +import { IItemEventRouterRequest } from "../models/eft/itemEvent/IItemEventRouterRequest"; +import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; +import { EventOutputHolder } from "./EventOutputHolder"; export declare class ItemEventRouter { protected logger: ILogger; - protected jsonUtil: JsonUtil; protected profileHelper: ProfileHelper; protected itemEventRouters: ItemEventRouterDefinition[]; - constructor(logger: ILogger, jsonUtil: JsonUtil, profileHelper: ProfileHelper, itemEventRouters: ItemEventRouterDefinition[]); - protected output: IItemEventRouterResponse; + protected localisationService: LocalisationService; + protected eventOutputHolder: EventOutputHolder; + constructor(logger: ILogger, profileHelper: ProfileHelper, itemEventRouters: ItemEventRouterDefinition[], localisationService: LocalisationService, eventOutputHolder: EventOutputHolder); handleEvents(info: IItemEventRouterRequest, sessionID: string): IItemEventRouterResponse; - getOutput(sessionID: string): IItemEventRouterResponse; - protected resetOutput(sessionID: string): void; } diff --git a/types/routers/item_events/HideoutItemEventRouter.d.ts b/types/routers/item_events/HideoutItemEventRouter.d.ts index e1e98af..44bd1cd 100644 --- a/types/routers/item_events/HideoutItemEventRouter.d.ts +++ b/types/routers/item_events/HideoutItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { HideoutCallbacks } from "../../callbacks/HideoutCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class HideoutItemEventRouter extends ItemEventRouterDefinition { protected hideoutCallbacks: HideoutCallbacks; constructor(hideoutCallbacks: HideoutCallbacks); diff --git a/types/routers/item_events/InventoryItemEventRouter.d.ts b/types/routers/item_events/InventoryItemEventRouter.d.ts index 2619bb9..953d322 100644 --- a/types/routers/item_events/InventoryItemEventRouter.d.ts +++ b/types/routers/item_events/InventoryItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { InventoryCallbacks } from "../../callbacks/InventoryCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class InventoryItemEventRouter extends ItemEventRouterDefinition { protected inventoryCallbacks: InventoryCallbacks; constructor(inventoryCallbacks: InventoryCallbacks); diff --git a/types/routers/serializers/BundleSerializer.d.ts b/types/routers/serializers/BundleSerializer.d.ts index 912db83..ca4d8b6 100644 --- a/types/routers/serializers/BundleSerializer.d.ts +++ b/types/routers/serializers/BundleSerializer.d.ts @@ -1,11 +1,14 @@ +/// +import { IncomingMessage, ServerResponse } from "http"; import { Serializer } from "../../di/Serializer"; import { BundleLoader } from "../../loaders/BundleLoader"; -import { IHttpServer } from "../../models/spt/server/IHttpServer"; import { ILogger } from "../../models/spt/utils/ILogger"; +import { HttpFileUtil } from "../../utils/HttpFileUtil"; export declare class BundleSerializer extends Serializer { protected logger: ILogger; protected bundleLoader: BundleLoader; - constructor(logger: ILogger, bundleLoader: BundleLoader); - serialize(sessionID: string, req: any, resp: any, body: any, httpServer: IHttpServer): void; + protected httpFileUtil: HttpFileUtil; + constructor(logger: ILogger, bundleLoader: BundleLoader, httpFileUtil: HttpFileUtil); + serialize(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: any): void; canHandle(route: string): boolean; } diff --git a/types/routers/serializers/ImageSerializer.d.ts b/types/routers/serializers/ImageSerializer.d.ts index 0e040d4..7f15bcf 100644 --- a/types/routers/serializers/ImageSerializer.d.ts +++ b/types/routers/serializers/ImageSerializer.d.ts @@ -1,9 +1,10 @@ -import { IHttpServer } from "../../models/spt/server/IHttpServer"; +/// import { Serializer } from "../../di/Serializer"; import { ImageRouter } from "../ImageRouter"; +import { IncomingMessage, ServerResponse } from "http"; export declare class ImageSerializer extends Serializer { protected imageRouter: ImageRouter; constructor(imageRouter: ImageRouter); - serialize(sessionID: string, req: any, resp: any, body: any, httpServer: IHttpServer): void; + serialize(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: any): void; canHandle(route: string): boolean; } diff --git a/types/routers/serializers/NotifySerializer.d.ts b/types/routers/serializers/NotifySerializer.d.ts index 1779ac9..0d8cc89 100644 --- a/types/routers/serializers/NotifySerializer.d.ts +++ b/types/routers/serializers/NotifySerializer.d.ts @@ -1,11 +1,12 @@ +/// +import { IncomingMessage, ServerResponse } from "http"; import { NotifierController } from "../../controllers/NotifierController"; import { Serializer } from "../../di/Serializer"; import { HttpServerHelper } from "../../helpers/HttpServerHelper"; -import { IHttpServer } from "../../models/spt/server/IHttpServer"; export declare class NotifySerializer extends Serializer { protected notifierController: NotifierController; protected httpServerHelper: HttpServerHelper; constructor(notifierController: NotifierController, httpServerHelper: HttpServerHelper); - serialize(_sessionID: string, req: any, resp: any, body: any, httpServer: IHttpServer): void; + serialize(_sessionID: string, req: IncomingMessage, resp: ServerResponse, _: any): void; canHandle(route: string): boolean; } diff --git a/types/servers/DatabaseServer.d.ts b/types/servers/DatabaseServer.d.ts index aa152d0..b3d29e9 100644 --- a/types/servers/DatabaseServer.d.ts +++ b/types/servers/DatabaseServer.d.ts @@ -2,5 +2,5 @@ import { IDatabaseTables } from "../models/spt/server/IDatabaseTables"; export declare class DatabaseServer { protected tableData: IDatabaseTables; getTables(): IDatabaseTables; - setTables(any: any): void; + setTables(tableData: IDatabaseTables): void; } diff --git a/types/servers/HttpServer.d.ts b/types/servers/HttpServer.d.ts index 44d802b..80c1d48 100644 --- a/types/servers/HttpServer.d.ts +++ b/types/servers/HttpServer.d.ts @@ -1,51 +1,26 @@ /// -/// -import http, { ServerResponse } from "http"; +import http, { IncomingMessage, ServerResponse } from "http"; import { ApplicationContext } from "../context/ApplicationContext"; -import { Serializer } from "../di/Serializer"; import { HttpServerHelper } from "../helpers/HttpServerHelper"; -import { NotifierHelper } from "../helpers/NotifierHelper"; -import { INotification } from "../models/eft/notifier/INotifier"; import { IHttpConfig } from "../models/spt/config/IHttpConfig"; -import { IHttpServer } from "../models/spt/server/IHttpServer"; import { ILogger } from "../models/spt/utils/ILogger"; -import { HttpRouter } from "../routers/HttpRouter"; -import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -import { JsonUtil } from "../utils/JsonUtil"; -import { RandomUtil } from "../utils/RandomUtil"; +import { LocalisationService } from "../services/LocalisationService"; import { ConfigServer } from "./ConfigServer"; import { DatabaseServer } from "./DatabaseServer"; -export declare class HttpServer implements IHttpServer { - protected httpRouter: HttpRouter; +import { IHttpListener } from "./http/IHttpListener"; +import { WebSocketServer } from "./WebSocketServer"; +export declare class HttpServer { protected logger: ILogger; - protected randomUtil: RandomUtil; - protected jsonUtil: JsonUtil; - protected httpResponse: HttpResponseUtil; protected databaseServer: DatabaseServer; - protected notifierHelper: NotifierHelper; protected httpServerHelper: HttpServerHelper; - protected serializers: Serializer[]; + protected localisationService: LocalisationService; + protected httpListeners: IHttpListener[]; protected configServer: ConfigServer; protected applicationContext: ApplicationContext; - constructor(httpRouter: HttpRouter, // TODO: delay required - logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, httpResponse: HttpResponseUtil, databaseServer: DatabaseServer, notifierHelper: NotifierHelper, httpServerHelper: HttpServerHelper, serializers: Serializer[], configServer: ConfigServer, applicationContext: ApplicationContext); - protected buffers: {}; - protected onReceive: {}; - protected onRespond: {}; + protected webSocketServer: WebSocketServer; + constructor(logger: ILogger, databaseServer: DatabaseServer, httpServerHelper: HttpServerHelper, localisationService: LocalisationService, httpListeners: IHttpListener[], configServer: ConfigServer, applicationContext: ApplicationContext, webSocketServer: WebSocketServer); protected httpConfig: IHttpConfig; - protected webSockets: {}; - protected websocketPingHandler: any; getCookies(req: http.IncomingMessage): any; - resetBuffer(sessionID: string): void; - putInBuffer(sessionID: any, data: any, bufLength: number): boolean; - getFromBuffer(sessionID: string): any; - sendZlibJson(resp: any, output: any, sessionID: string): void; - sendMessage(sessionID: string, output: INotification): void; - sendFile(resp: ServerResponse, file: any): void; - isConnectionWebSocket(sessionID: string): boolean; - sendResponse(sessionID: string, req: any, resp: any, body: Buffer): void; - handleRequest(req: http.IncomingMessage, resp: http.ServerResponse): void; + handleRequest(req: IncomingMessage, resp: ServerResponse): void; load(): void; - protected getRandomisedMessage(): string; - wsOnConnection(ws: any, req: any): void; } diff --git a/types/servers/RagfairServer.d.ts b/types/servers/RagfairServer.d.ts index c93864b..f49654a 100644 --- a/types/servers/RagfairServer.d.ts +++ b/types/servers/RagfairServer.d.ts @@ -4,6 +4,7 @@ import { TraderHelper } from "../helpers/TraderHelper"; import { IRagfairOffer } from "../models/eft/ragfair/IRagfairOffer"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; import { RagfairCategoriesService } from "../services/RagfairCategoriesService"; import { RagfairOfferService } from "../services/RagfairOfferService"; import { RagfairRequiredItemsService } from "../services/RagfairRequiredItemsService"; @@ -14,13 +15,14 @@ export declare class RagfairServer { protected ragfairOfferService: RagfairOfferService; protected ragfairCategoriesService: RagfairCategoriesService; protected ragfairRequiredItemsService: RagfairRequiredItemsService; + protected localisationService: LocalisationService; protected traderHelper: TraderHelper; protected traderAssortHelper: TraderAssortHelper; protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; - constructor(logger: ILogger, ragfairOfferGenerator: RagfairOfferGenerator, ragfairOfferService: RagfairOfferService, ragfairCategoriesService: RagfairCategoriesService, ragfairRequiredItemsService: RagfairRequiredItemsService, traderHelper: TraderHelper, traderAssortHelper: TraderAssortHelper, configServer: ConfigServer); - load(): void; - update(): void; + constructor(logger: ILogger, ragfairOfferGenerator: RagfairOfferGenerator, ragfairOfferService: RagfairOfferService, ragfairCategoriesService: RagfairCategoriesService, ragfairRequiredItemsService: RagfairRequiredItemsService, localisationService: LocalisationService, traderHelper: TraderHelper, traderAssortHelper: TraderAssortHelper, configServer: ConfigServer); + load(): Promise; + update(): Promise; /** * Get traders who need to be periodically refreshed * @returns string array of traders diff --git a/types/servers/SaveServer.d.ts b/types/servers/SaveServer.d.ts index cb28f49..4dca514 100644 --- a/types/servers/SaveServer.d.ts +++ b/types/servers/SaveServer.d.ts @@ -1,20 +1,22 @@ +import { SaveLoadRouter } from "../di/Router"; import { IAkiProfile, Info } from "../models/eft/profile/IAkiProfile"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { VFS } from "../utils/VFS"; -import { SaveLoadRouter } from "../di/Router"; -import { ILogger } from "../models/spt/utils/ILogger"; export declare class SaveServer { protected vfs: VFS; protected saveLoadRouters: SaveLoadRouter[]; protected jsonUtil: JsonUtil; protected hashUtil: HashUtil; + protected localisationService: LocalisationService; protected logger: ILogger; protected profileFilepath: string; protected profiles: {}; protected onSave: {}; protected saveMd5: {}; - constructor(vfs: VFS, saveLoadRouters: SaveLoadRouter[], jsonUtil: JsonUtil, hashUtil: HashUtil, logger: ILogger); + constructor(vfs: VFS, saveLoadRouters: SaveLoadRouter[], jsonUtil: JsonUtil, hashUtil: HashUtil, localisationService: LocalisationService, logger: ILogger); load(): void; save(): void; getProfile(sessionId: string): IAkiProfile; diff --git a/types/servers/WebSocketServer.d.ts b/types/servers/WebSocketServer.d.ts new file mode 100644 index 0000000..5d40e6e --- /dev/null +++ b/types/servers/WebSocketServer.d.ts @@ -0,0 +1,27 @@ +/// +import http, { IncomingMessage } from "http"; +import WebSocket from "ws"; +import { HttpServerHelper } from "../helpers/HttpServerHelper"; +import { INotification } from "../models/eft/notifier/INotifier"; +import { IHttpConfig } from "../models/spt/config/IHttpConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; +import { RandomUtil } from "../utils/RandomUtil"; +import { ConfigServer } from "./ConfigServer"; +export declare class WebSocketServer { + protected logger: ILogger; + protected randomUtil: RandomUtil; + protected configServer: ConfigServer; + protected localisationService: LocalisationService; + protected httpServerHelper: HttpServerHelper; + constructor(logger: ILogger, randomUtil: RandomUtil, configServer: ConfigServer, localisationService: LocalisationService, httpServerHelper: HttpServerHelper); + protected httpConfig: IHttpConfig; + protected defaultNotification: INotification; + protected webSockets: Record; + protected websocketPingHandler: any; + setupWebSocket(httpServer: http.Server): void; + sendMessage(sessionID: string, output: INotification): void; + protected getRandomisedMessage(): string; + isConnectionWebSocket(sessionID: string): boolean; + protected wsOnConnection(ws: WebSocket.WebSocket, req: IncomingMessage): void; +} diff --git a/types/servers/http/AkiHttpListener.d.ts b/types/servers/http/AkiHttpListener.d.ts new file mode 100644 index 0000000..acf92aa --- /dev/null +++ b/types/servers/http/AkiHttpListener.d.ts @@ -0,0 +1,28 @@ +/// +/// +import { IncomingMessage, ServerResponse } from "http"; +import { Serializer } from "../../di/Serializer"; +import { ILogger } from "../../models/spt/utils/ILogger"; +import { HttpRouter } from "../../routers/HttpRouter"; +import { LocalisationService } from "../../services/LocalisationService"; +import { HttpResponseUtil } from "../../utils/HttpResponseUtil"; +import { JsonUtil } from "../../utils/JsonUtil"; +import { HttpBufferHandler } from "./HttpBufferHandler"; +import { IHttpListener } from "./IHttpListener"; +export declare class AkiHttpListener implements IHttpListener { + protected httpRouter: HttpRouter; + protected serializers: Serializer[]; + protected logger: ILogger; + protected jsonUtil: JsonUtil; + protected httpResponse: HttpResponseUtil; + protected localisationService: LocalisationService; + protected httpBufferHandler: HttpBufferHandler; + constructor(httpRouter: HttpRouter, // TODO: delay required + serializers: Serializer[], logger: ILogger, jsonUtil: JsonUtil, httpResponse: HttpResponseUtil, localisationService: LocalisationService, httpBufferHandler: HttpBufferHandler); + canHandle(_: string, req: IncomingMessage): boolean; + handle(sessionId: string, req: IncomingMessage, resp: ServerResponse): void; + sendResponse(sessionID: string, req: IncomingMessage, resp: ServerResponse, body: Buffer, output: string): void; + getResponse(sessionID: string, req: IncomingMessage, body: Buffer): string; + protected getBodyInfo(body: Buffer): string; + sendZlibJson(resp: ServerResponse, output: any, sessionID: string): void; +} diff --git a/types/servers/http/HttpBufferHandler.d.ts b/types/servers/http/HttpBufferHandler.d.ts new file mode 100644 index 0000000..fec4936 --- /dev/null +++ b/types/servers/http/HttpBufferHandler.d.ts @@ -0,0 +1,6 @@ +export declare class HttpBufferHandler { + protected buffers: {}; + resetBuffer(sessionID: string): void; + putInBuffer(sessionID: any, data: any, bufLength: number): boolean; + getFromBuffer(sessionID: string): any; +} diff --git a/types/servers/http/HttpMethods.d.ts b/types/servers/http/HttpMethods.d.ts new file mode 100644 index 0000000..96031e2 --- /dev/null +++ b/types/servers/http/HttpMethods.d.ts @@ -0,0 +1,8 @@ +export declare enum HttpMethods { + OPTIONS = "OPTIONS", + GET = "GET", + POST = "POST", + PUT = "PUT", + PATCH = "PATCH", + DELETE = "DELETE" +} diff --git a/types/servers/http/IHttpListener.d.ts b/types/servers/http/IHttpListener.d.ts new file mode 100644 index 0000000..758bb5a --- /dev/null +++ b/types/servers/http/IHttpListener.d.ts @@ -0,0 +1,6 @@ +/// +import { IncomingMessage, ServerResponse } from "http"; +export interface IHttpListener { + canHandle(sessionId: string, req: IncomingMessage): boolean; + handle(sessionId: string, req: IncomingMessage, resp: ServerResponse): void; +} diff --git a/types/services/BotEquipmentFilterService.d.ts b/types/services/BotEquipmentFilterService.d.ts index 632f961..ef3b504 100644 --- a/types/services/BotEquipmentFilterService.d.ts +++ b/types/services/BotEquipmentFilterService.d.ts @@ -1,21 +1,41 @@ -import { IBotType } from "../models/eft/common/tables/IBotType"; -import { EquipmentFilters, EquipmentFilterDetails, IBotConfig } from "../models/spt/config/IBotConfig"; +import { BotHelper } from "../helpers/BotHelper"; +import { EquipmentChances, IBotType, ModsChances } from "../models/eft/common/tables/IBotType"; +import { BotGenerationDetails } from "../models/spt/bots/BotGenerationDetails"; +import { AdjustmentDetails, EquipmentFilterDetails, EquipmentFilters, IBotConfig, WeightingAdjustmentDetails } from "../models/spt/config/IBotConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; export declare class BotEquipmentFilterService { protected logger: ILogger; + protected botHelper: BotHelper; protected configServer: ConfigServer; protected botConfig: IBotConfig; - protected botEquipmentFilterlists: Record; - constructor(logger: ILogger, configServer: ConfigServer); + protected botEquipmentConfig: Record; + constructor(logger: ILogger, botHelper: BotHelper, configServer: ConfigServer); /** * Filter a bots data to exclude equipment and cartridges defines in the botConfig * @param baseBotNode bots json data to filter - * @param playerLevel Level of the currently playing player - * @param isPmc Is the bot we're filtering a PMC - * @param role Role of the bot we're filtering + * @param botLevel Level of the bot + * @param botGenerationDetails details on how to generate a bot */ - filterBotEquipment(baseBotNode: IBotType, playerLevel: number, isPmc: boolean, role: string): void; + filterBotEquipment(baseBotNode: IBotType, botLevel: number, botGenerationDetails: BotGenerationDetails): void; + /** + * Iterate over the changes passed in and alter data in baseValues + * @param equipmentChanges Changes to apply + * @param baseValues Values to update + */ + protected adjustChances(equipmentChanges: Record, baseValues: EquipmentChances | ModsChances): void; + /** + * Get equipment settings for bot + * @param botEquipmentRole equipment role to return + * @returns EquipmentFilters object + */ + getBotEquipmentSettings(botEquipmentRole: string): EquipmentFilters; + /** + * Get weapon sight whitelist for a specific bot type + * @param botEquipmentRole equipment role of bot to look up + * @returns Dictionary of weapon type and their whitelisted scope types + */ + getBotWeaponSightWhitelist(botEquipmentRole: string): Record; /** * Get an object that contains equipment and cartridge blacklists for a specified bot type * @param botRole Role of the bot we want the blacklist for @@ -30,6 +50,20 @@ export declare class BotEquipmentFilterService { * @returns EquipmentFilterDetails object */ protected getBotEquipmentWhitelist(botRole: string, playerLevel: number): EquipmentFilterDetails; + /** + * Retreive clothing weighting adjustments from bot.json config + * @param botRole Bot type to get adjustments for + * @param playerLevel level of player + * @returns Weighting adjustments for bots clothing + */ + protected getBotClothingAdjustments(botRole: string, playerLevel: number): WeightingAdjustmentDetails; + /** + * Retreive item weighting adjustments from bot.json config + * @param botRole Bot type to get adjustments for + * @param playerLevel level of player + * @returns Weighting adjustments for bot items + */ + protected getBotWeightingAdjustments(botRole: string, playerLevel: number): WeightingAdjustmentDetails; /** * Filter bot equipment based on blacklist and whitelist from config/bot.json * Prioritises whitelist first, if one is found blacklist is ignored @@ -47,4 +81,10 @@ export declare class BotEquipmentFilterService { * @returns Filtered bot file */ protected filterCartridges(baseBotNode: IBotType, blacklist: EquipmentFilterDetails, whitelist: EquipmentFilterDetails): void; + /** + * Add/Edit weighting changes to bot items using values from config/bot.json/equipment + * @param weightingAdjustments Weighting change to apply to bot + * @param botItemPool Bot item dictionary to adjust + */ + protected adjustWeighting(weightingAdjustments: AdjustmentDetails, botItemPool: Record, showEditWarnings?: boolean): void; } diff --git a/types/services/BotEquipmentModPoolService.d.ts b/types/services/BotEquipmentModPoolService.d.ts new file mode 100644 index 0000000..adf59ff --- /dev/null +++ b/types/services/BotEquipmentModPoolService.d.ts @@ -0,0 +1,65 @@ +import { ItemHelper } from "../helpers/ItemHelper"; +import { Mods } from "../models/eft/common/tables/IBotType"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +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 { VFS } from "../utils/VFS"; +/** Store a mapping between weapons, their slots and the items that fit those slots */ +export declare class BotEquipmentModPoolService { + protected logger: ILogger; + protected vfs: VFS; + protected itemHelper: ItemHelper; + protected databaseServer: DatabaseServer; + protected configServer: ConfigServer; + protected botConfig: IBotConfig; + protected weaponModPool: Mods; + protected gearModPool: Mods; + protected weaponPoolGenerated: boolean; + protected armorPoolGenerated: boolean; + constructor(logger: ILogger, vfs: VFS, itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer); + /** + * Store dictionary of mods for each item passed in + * @param items items to find related mods and store in modPool + */ + protected generatePool(items: ITemplateItem[], poolType: string): void; + /** + * Empty the mod pool + */ + resetPool(): void; + /** + * Get array of compatible mods for an items mod slot (generate pool if it doesnt exist already) + * @param itemTpl item to look up + * @param slotName slot to get compatible mods for + * @returns tpls that fit the slot + */ + getCompatibleModsForWeaponSlot(itemTpl: string, slotName: string): string[]; + /** + * Get array of compatible mods for an items mod slot (generate pool if it doesnt exist already) + * @param itemTpl item to look up + * @param slotName slot to get compatible mods for + * @returns tpls that fit the slot + */ + getCompatibleModsFoGearSlot(itemTpl: string, slotName: string): string[]; + /** + * Get mods for a piece of gear by its tpl + * @param itemTpl items tpl to look up mods for + * @returns Dictionary of mods (keys are mod slot names) with array of compatible mod tpls as value + */ + getModsForGearSlot(itemTpl: string): Record; + /** + * Get mods for a weapon by its tpl + * @param itemTpl Weapons tpl to look up mods for + * @returns Dictionary of mods (keys are mod slot names) with array of compatible mod tpls as value + */ + getModsForWeaponSlot(itemTpl: string): Record; + /** + * Create weapon mod pool and set generated flag to true + */ + protected generateWeaponPool(): void; + /** + * Create gear mod pool and set generated flag to true + */ + protected generateGearPool(): void; +} diff --git a/types/services/BotGenerationCacheService.d.ts b/types/services/BotGenerationCacheService.d.ts index c7dddf5..a491b03 100644 --- a/types/services/BotGenerationCacheService.d.ts +++ b/types/services/BotGenerationCacheService.d.ts @@ -3,45 +3,34 @@ import { IBotBase } from "../models/eft/common/tables/IBotBase"; import { ILogger } from "../models/spt/utils/ILogger"; import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; +import { LocalisationService } from "./LocalisationService"; export declare class BotGenerationCacheService { protected logger: ILogger; protected randomUtil: RandomUtil; protected jsonUtil: JsonUtil; + protected localisationService: LocalisationService; protected botHelper: BotHelper; - protected storedBots: IBotBase[]; - constructor(logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, botHelper: BotHelper); + protected storedBots: Map; + constructor(logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, localisationService: LocalisationService, botHelper: BotHelper); /** * Store array of bots in cache, shuffle results before storage - * @param botsToStore + * @param botsToStore Bots we want to store in the cache */ - storeBots(botsToStore: IBotBase[]): void; + storeBots(key: string, botsToStore: IBotBase[]): void; /** * Find and return a bot based on its role * Remove bot from internal array so it can't be retreived again - * @param role role to retreive (assault/bossTagilla etc) + * @param key role to retreive (assault/bossTagilla etc) * @returns IBotBase object */ - getBot(role: string): IBotBase[]; - /** - * Find a bot by its index from cache - * @param indexOfBotToReturn index to find bot by - * @returns bot profile - */ - protected getBotFromCache(indexOfBotToReturn: number): IBotBase; - /** - * Remove bot profile by index from cache - * @param indexOfBotToReturn Index of bot profile to remove - */ - protected removeBotFromCache(indexOfBotToReturn: number): void; - /** - * Get index of bot profile that matches criteria - * @param role role of bot we want - * @param getPmc is requested bot a pmc - * @returns index of found bot - */ - protected getIndexOfBotToReturn(role: string, getPmc: boolean): number; + getBot(key: string): IBotBase; /** * Remove all cached bot profiles */ clearStoredBots(): void; + /** + * Does cache have a bot with requested key + * @returns false if empty + */ + cacheHasBotOfRole(key: string): boolean; } diff --git a/types/services/BotLootCacheService.d.ts b/types/services/BotLootCacheService.d.ts index 00ffb9c..dab7c6d 100644 --- a/types/services/BotLootCacheService.d.ts +++ b/types/services/BotLootCacheService.d.ts @@ -5,15 +5,17 @@ import { BotLootCache, LootCacheType } from "../models/spt/bots/BotLootCache"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { JsonUtil } from "../utils/JsonUtil"; +import { LocalisationService } from "./LocalisationService"; import { RagfairPriceService } from "./RagfairPriceService"; export declare class BotLootCacheService { protected logger: ILogger; protected jsonUtil: JsonUtil; protected databaseServer: DatabaseServer; protected pmcLootGenerator: PMCLootGenerator; + protected localisationService: LocalisationService; protected ragfairPriceService: RagfairPriceService; protected lootCache: Record; - constructor(logger: ILogger, jsonUtil: JsonUtil, databaseServer: DatabaseServer, pmcLootGenerator: PMCLootGenerator, ragfairPriceService: RagfairPriceService); + constructor(logger: ILogger, jsonUtil: JsonUtil, databaseServer: DatabaseServer, pmcLootGenerator: PMCLootGenerator, localisationService: LocalisationService, ragfairPriceService: RagfairPriceService); /** * Remove all cached bot loot data */ diff --git a/types/services/BotWeaponModLimitService.d.ts b/types/services/BotWeaponModLimitService.d.ts new file mode 100644 index 0000000..f8ebc2f --- /dev/null +++ b/types/services/BotWeaponModLimitService.d.ts @@ -0,0 +1,54 @@ +import { ItemHelper } from "../helpers/ItemHelper"; +import { Item } from "../models/eft/common/tables/IItem"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { IBotConfig } from "../models/spt/config/IBotConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +export declare class BotModLimits { + scope: ItemCount; + scopeMax: number; + scopeBaseTypes: string[]; + flashlightLaser: ItemCount; + flashlightLaserMax: number; + flashlgihtLaserBaseTypes: string[]; +} +export declare class ItemCount { + count: number; +} +export declare class BotWeaponModLimitService { + protected logger: ILogger; + protected configServer: ConfigServer; + protected itemHelper: ItemHelper; + protected botConfig: IBotConfig; + constructor(logger: ILogger, configServer: ConfigServer, itemHelper: ItemHelper); + /** + * Initalise mod limits to be used when generating a weapon + * @param botRole "assault", "bossTagilla" or "pmc" + * @returns BotModLimits object + */ + getWeaponModLimits(botRole: string): BotModLimits; + /** + * Check if weapon mod item is on limited list + has surpassed the limit set for it + * Exception: Always allow ncstar backup mount + * Exception: Always allow scopes with a scope for a parent + * Exception: Always disallow mounts that hold only scopes once scope limit reached + * Exception: Always disallow mounts that hold only flashlights once flashlight limit reached + * @param botRole role the bot has e.g. assault + * @param modTemplate mods template data + * @param modLimits limits set for weapon being generated for this bot + * @param modsParent The parent of the mod to be checked + * @returns true if over item limit + */ + weaponModHasReachedLimit(botRole: string, modTemplate: ITemplateItem, modLimits: BotModLimits, modsParent: ITemplateItem, weapon: Item[]): boolean; + /** + * Check if the specific item type on the weapon has reached the set limit + * @param modTpl log mod tpl if over type limit + * @param currentCount current number of this item on gun + * @param maxLimit mod limit allowed + * @param botRole role of bot we're checking weapon of + * @returns true if limit reached + */ + protected weaponModLimitReached(modTpl: string, currentCount: { + count: number; + }, maxLimit: number, botRole: string): boolean; +} diff --git a/types/services/CustomLocationWaveService.d.ts b/types/services/CustomLocationWaveService.d.ts new file mode 100644 index 0000000..7d14f07 --- /dev/null +++ b/types/services/CustomLocationWaveService.d.ts @@ -0,0 +1,42 @@ +import { BossLocationSpawn, Wave } from "../models/eft/common/ILocationBase"; +import { ILocationConfig } from "../models/spt/config/ILocationConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; +export declare class CustomLocationWaveService { + protected logger: ILogger; + protected randomUtil: RandomUtil; + protected jsonUtil: JsonUtil; + protected databaseServer: DatabaseServer; + protected configServer: ConfigServer; + protected locationConfig: ILocationConfig; + constructor(logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, configServer: ConfigServer); + /** + * Add a boss wave to a map + * @param locationId e.g. factory4_day, bigmap + * @param waveToAdd Boss wave to add to map + */ + addBossWaveToMap(locationId: string, waveToAdd: BossLocationSpawn): void; + /** + * Add a normal bot wave to a map + * @param locationId e.g. factory4_day, bigmap + * @param waveToAdd Wave to add to map + */ + addNormalWaveToMap(locationId: string, waveToAdd: Wave): void; + /** + * Clear all custom boss waves from a map + * @param locationId e.g. factory4_day, bigmap + */ + clearBossWavesForMap(locationId: string): void; + /** + * Clear all custom normal waves from a map + * @param locationId e.g. factory4_day, bigmap + */ + clearNormalWavesForMap(locationId: string): void; + /** + * Add custom boss and normal waves to maps found in config/location.json to db + */ + applyWaveChangesToAllMaps(): void; +} diff --git a/types/services/FenceService.d.ts b/types/services/FenceService.d.ts index 23fbf52..cb20500 100644 --- a/types/services/FenceService.d.ts +++ b/types/services/FenceService.d.ts @@ -3,6 +3,8 @@ import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; import { FenceLevel } from "../models/eft/common/IGlobals"; import { IPmcData } from "../models/eft/common/IPmcData"; +import { Item } from "../models/eft/common/tables/IItem"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { ITraderAssort } from "../models/eft/common/tables/ITrader"; import { ITraderConfig } from "../models/spt/config/ITraderConfig"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -13,6 +15,7 @@ import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; import { ItemFilterService } from "./ItemFilterService"; +import { LocalisationService } from "./LocalisationService"; /** * Handle actions surrounding Fence * e.g. generating or refreshing assorts / get next refresh time @@ -28,11 +31,12 @@ export declare class FenceService { protected itemHelper: ItemHelper; protected presetHelper: PresetHelper; protected itemFilterService: ItemFilterService; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected fenceAssort: ITraderAssort; protected traderConfig: ITraderConfig; protected nextMiniRefreshTimestamp: number; - constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, timeUtil: TimeUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, itemHelper: ItemHelper, presetHelper: PresetHelper, itemFilterService: ItemFilterService, configServer: ConfigServer); + constructor(logger: ILogger, hashUtil: HashUtil, jsonUtil: JsonUtil, timeUtil: TimeUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, itemHelper: ItemHelper, presetHelper: PresetHelper, itemFilterService: ItemFilterService, localisationService: LocalisationService, configServer: ConfigServer); protected setFenceAssort(fenceAssort: ITraderAssort): void; /** * Get assorts player can purchase @@ -41,6 +45,13 @@ export declare class FenceService { * @returns ITraderAssort */ getFenceAssorts(pmcProfile: IPmcData): ITraderAssort; + /** + * Adjust assorts price by a modifier + * @param item + * @param assort + * @param modifier + */ + protected adjustItemPriceByModifier(item: Item, assort: ITraderAssort, modifier: number): void; /** * Get fence assorts with no price adjustments based on fence rep * @returns ITraderAssort @@ -82,9 +93,9 @@ export declare class FenceService { */ getOfferCount(): number; /** - * Create a trader assort for fence + * Create trader assorts for fence and store in fenceService cache */ - generateFenceAssortCache(): void; + generateFenceAssorts(): void; /** * Create skeleton to hold assort items * @returns ITraderAssort object @@ -96,6 +107,21 @@ export declare class FenceService { * @param assorts object to add assorts to */ protected createAssorts(assortCount: number, assorts: ITraderAssort): void; + /** + * Randomise items' upd properties e.g. med packs/weapons/armor + * @param itemDetails Item being randomised + * @param itemToAdjust Item being edited + */ + protected randomiseItemUpdProperties(itemDetails: ITemplateItem, itemToAdjust: Item): void; + /** + * Construct item limit record to hold max and current item count + * @param limits limits as defined in config + * @returns record, key: item tplId, value: current/max item count allowed + */ + protected initItemLimitCounter(limits: Record): Record; /** * Get the next update timestamp for fence * @returns future timestamp diff --git a/types/services/InsuranceService.d.ts b/types/services/InsuranceService.d.ts index 6be8a2f..9328b54 100644 --- a/types/services/InsuranceService.d.ts +++ b/types/services/InsuranceService.d.ts @@ -1,4 +1,5 @@ import { DialogueHelper } from "../helpers/DialogueHelper"; +import { HandbookHelper } from "../helpers/HandbookHelper"; import { SecureContainerHelper } from "../helpers/SecureContainerHelper"; import { TraderHelper } from "../helpers/TraderHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; @@ -12,6 +13,7 @@ import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; +import { LocalisationService } from "./LocalisationService"; export declare class InsuranceService { protected logger: ILogger; protected databaseServer: DatabaseServer; @@ -21,14 +23,16 @@ export declare class InsuranceService { protected saveServer: SaveServer; protected traderHelper: TraderHelper; protected dialogueHelper: DialogueHelper; + protected handbookHelper: HandbookHelper; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected insured: Record>; protected insuranceConfig: IInsuranceConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, secureContainerHelper: SecureContainerHelper, randomUtil: RandomUtil, timeUtil: TimeUtil, saveServer: SaveServer, traderHelper: TraderHelper, dialogueHelper: DialogueHelper, configServer: ConfigServer); + constructor(logger: ILogger, databaseServer: DatabaseServer, secureContainerHelper: SecureContainerHelper, randomUtil: RandomUtil, timeUtil: TimeUtil, saveServer: SaveServer, traderHelper: TraderHelper, dialogueHelper: DialogueHelper, handbookHelper: HandbookHelper, localisationService: LocalisationService, configServer: ConfigServer); insuranceExists(sessionId: string): boolean; insuranceTraderArrayExists(sessionId: string, traderId: string): boolean; getInsurance(sessionId: string): Record; - getInsuranceItems(sessionId: string, traderId: string): any[]; + getInsuranceItems(sessionId: string, traderId: string): Item[]; resetInsurance(sessionId: string): void; resetInsuranceTraderArray(sessionId: string, traderId: string): void; addInsuranceItemToArray(sessionId: string, traderId: string, itemToAdd: any): void; diff --git a/types/services/ItemBaseClassService.d.ts b/types/services/ItemBaseClassService.d.ts new file mode 100644 index 0000000..d7bc4bc --- /dev/null +++ b/types/services/ItemBaseClassService.d.ts @@ -0,0 +1,39 @@ +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "./LocalisationService"; +/** + * Cache the baseids for each item in the tiems db inside a dictionary + */ +export declare class ItemBaseClassService { + protected logger: ILogger; + protected localisationService: LocalisationService; + protected databaseServer: DatabaseServer; + protected itemBaseClassesCache: Record; + protected cacheGenerated: boolean; + constructor(logger: ILogger, localisationService: LocalisationService, databaseServer: DatabaseServer); + /** + * Create cache and store inside ItemBaseClassService + */ + hydrateItemBaseClassCache(): void; + /** + * Helper method, recursivly iterate through items parent items, finding and adding ids to dictionary + * @param itemIdToUpdate item tpl to store base ids against in dictionary + * @param item item being checked + * @param allDbItems all items in db + */ + protected addBaseItems(itemIdToUpdate: string, item: ITemplateItem, allDbItems: Record): void; + /** + * Does item tpl inherit from the requested base class + * @param itemTpl item to check base classes of + * @param baseClass base class to check for + * @returns true if item inherits from base class passed in + */ + itemHasBaseClass(itemTpl: string, baseClasses: string[]): boolean; + /** + * Get base classes item inherits from + * @param itemTpl item to get base classes for + * @returns array of base classes + */ + getItemBaseClasses(itemTpl: string): string[]; +} diff --git a/types/services/ItemFilterService.d.ts b/types/services/ItemFilterService.d.ts index c9c8ef3..b830d74 100644 --- a/types/services/ItemFilterService.d.ts +++ b/types/services/ItemFilterService.d.ts @@ -2,7 +2,7 @@ import { IItemConfig } from "../models/spt/config/IItemConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; -/** Centralise the handling of blacklisting items, uses blacklist found in config/item.json */ +/** Centralise the handling of blacklisting items, uses blacklist found in config/item.json, stores items that should not be used by players / broken items */ export declare class ItemFilterService { protected logger: ILogger; protected databaseServer: DatabaseServer; diff --git a/types/services/LocaleService.d.ts b/types/services/LocaleService.d.ts index 33bea7b..09c658b 100644 --- a/types/services/LocaleService.d.ts +++ b/types/services/LocaleService.d.ts @@ -1,14 +1,41 @@ import { ILocaleConfig } from "../models/spt/config/ILocaleConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +/** + * Handles getting locales from config or users machine + */ export declare class LocaleService { protected logger: ILogger; + protected databaseServer: DatabaseServer; protected configServer: ConfigServer; protected localeConfig: ILocaleConfig; - constructor(logger: ILogger, configServer: ConfigServer); + constructor(logger: ILogger, databaseServer: DatabaseServer, configServer: ConfigServer); /** - * Gets the locale key from the locale.json file + * Get the eft globals db file based on the configured locale in config/locale.json, if not found, fall back to 'en' + * @returns dictionary + */ + getLocaleDb(): Record; + /** + * Gets the game locale key from the locale.json file, + * if value is 'system' get system locale * @returns locale e.g en/ge/cz/cn */ - getDesiredLocale(): string; + getDesiredGameLocale(): string; + /** + * Gets the game locale key from the locale.json file, + * if value is 'system' get system locale + * @returns locale e.g en/ge/cz/cn + */ + getDesiredServerLocale(): string; + /** + * Get array of languages supported for localisation + * @returns array of locales e.g. en/fr/cn + */ + getServerSupportedLocales(): string[]; + /** + * Get the locale of the computer running the server + * @returns langage part of locale e.g. 'en' part of 'en-US' + */ + protected getPlatformLocale(): string; } diff --git a/types/services/LocalisationService.d.ts b/types/services/LocalisationService.d.ts new file mode 100644 index 0000000..519325d --- /dev/null +++ b/types/services/LocalisationService.d.ts @@ -0,0 +1,21 @@ +import { I18n } from "i18n"; +import { ILocaleConfig } from "../models/spt/config/ILocaleConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { LocaleService } from "./LocaleService"; +/** + * Handles translating server text into different langauges + */ +export declare class LocalisationService { + protected logger: ILogger; + protected localeService: LocaleService; + protected localeConfig: ILocaleConfig; + protected i18n: I18n; + constructor(logger: ILogger, localeService: LocaleService); + /** + * Get a localised value using the passed in key + * @param key Key to loop up locale for + * @param args optional arguments + * @returns Localised string + */ + getText(key: string, args?: any): string; +} diff --git a/types/services/ModCompilerService.d.ts b/types/services/ModCompilerService.d.ts index 26cb4ac..a4bf3c8 100644 --- a/types/services/ModCompilerService.d.ts +++ b/types/services/ModCompilerService.d.ts @@ -1,20 +1,14 @@ -import * as ts from "typescript"; -import { ILogger } from "../models/spt/utils/ILogger"; -import { VFS } from "../utils/VFS"; +import { CompilerOptions } from "typescript"; +import type { ILogger } from "../models/spt/utils/ILogger"; import { HashCacheService } from "./HashCacheService"; +import { VFS } from "../utils/VFS"; export declare class ModCompilerService { protected logger: ILogger; protected hashCacheService: HashCacheService; protected vfs: VFS; constructor(logger: ILogger, hashCacheService: HashCacheService, vfs: VFS); compileMod(modName: string, modPath: string, modTypeScriptFiles: string[]): Promise; - protected compile(fileNames: string[], options: ts.CompilerOptions): Promise; - protected buildDepth(depth: number): string; - protected getNodesModulesPath(depth: number): string; - protected getAkiPath(depth: number): string; - protected getAkiFolder(): string; - protected getNodesModulesFolder(): string; - protected calculateDepth(file: string): number; + protected compile(fileNames: string[], options: CompilerOptions): Promise; protected areFilesReady(fileNames: string[]): boolean; protected delay(ms: number): Promise; } diff --git a/types/services/OpenZoneService.d.ts b/types/services/OpenZoneService.d.ts new file mode 100644 index 0000000..8e70b94 --- /dev/null +++ b/types/services/OpenZoneService.d.ts @@ -0,0 +1,28 @@ +import { ILocationConfig } from "../models/spt/config/ILocationConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; +import { LocalisationService } from "./LocalisationService"; +/** Service for adding new zones to a maps OpenZones property */ +export declare class OpenZoneService { + protected logger: ILogger; + protected randomUtil: RandomUtil; + protected jsonUtil: JsonUtil; + protected databaseServer: DatabaseServer; + protected localisationService: LocalisationService; + protected configServer: ConfigServer; + protected locationConfig: ILocationConfig; + constructor(logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, databaseServer: DatabaseServer, localisationService: LocalisationService, configServer: ConfigServer); + /** + * Add open zone to specified map + * @param locationId map location (e.g. factory4_day) + * @param zoneToAdd zone to add + */ + addZoneToMap(locationId: string, zoneToAdd: string): void; + /** + * Add open zones to all maps found in config/location.json to db + */ + applyZoneChangesToAllMaps(): void; +} diff --git a/types/services/PaymentService.d.ts b/types/services/PaymentService.d.ts index a5e538f..26f1952 100644 --- a/types/services/PaymentService.d.ts +++ b/types/services/PaymentService.d.ts @@ -11,6 +11,7 @@ import { IProcessSellTradeRequestData } from "../models/eft/trade/IProcessSellTr import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +import { LocalisationService } from "./LocalisationService"; export declare class PaymentService { protected logger: ILogger; protected httpResponse: HttpResponseUtil; @@ -19,8 +20,9 @@ export declare class PaymentService { protected traderHelper: TraderHelper; protected itemHelper: ItemHelper; protected inventoryHelper: InventoryHelper; + protected localisationService: LocalisationService; protected paymentHelper: PaymentHelper; - constructor(logger: ILogger, httpResponse: HttpResponseUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, traderHelper: TraderHelper, itemHelper: ItemHelper, inventoryHelper: InventoryHelper, paymentHelper: PaymentHelper); + constructor(logger: ILogger, httpResponse: HttpResponseUtil, databaseServer: DatabaseServer, handbookHelper: HandbookHelper, traderHelper: TraderHelper, itemHelper: ItemHelper, inventoryHelper: InventoryHelper, localisationService: LocalisationService, paymentHelper: PaymentHelper); /** * Take money and insert items into return to server request * @param {Object} pmcData @@ -50,7 +52,7 @@ export declare class PaymentService { * @param pmcData Player profile to find and remove currency from * @param currencyTpl Type of currency to pay * @param amountToPay money value to pay - * @param sessionID Sessino id + * @param sessionID Session id * @param output output object to send to client * @returns IItemEventRouterResponse */ @@ -58,9 +60,9 @@ export declare class PaymentService { /** * Prioritise player stash first over player inventory * Post-raid healing would often take money out of the players pockets/secure container - * @param a Firsat money stack item + * @param a First money stack item * @param b Second money stack item - * @returns sorted item + * @returns sort order */ - protected moneySort(a: Item, b: Item): number; + protected prioritiseStashSort(a: Item, b: Item): number; } diff --git a/types/services/PlayerService.d.ts b/types/services/PlayerService.d.ts index 519b7e5..2f364d5 100644 --- a/types/services/PlayerService.d.ts +++ b/types/services/PlayerService.d.ts @@ -2,10 +2,12 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { IPlayerIncrementSkillLevelRequestData } from "../models/eft/player/IPlayerIncrementSkillLevelRequestData"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "./LocalisationService"; export declare class PlayerService { protected logger: ILogger; + protected localisationService: LocalisationService; protected databaseServer: DatabaseServer; - constructor(logger: ILogger, databaseServer: DatabaseServer); + constructor(logger: ILogger, localisationService: LocalisationService, databaseServer: DatabaseServer); /** * increases the profile skill and updates any output * @param {Object} pmcData diff --git a/types/services/PmcAiService.d.ts b/types/services/PmcAiService.d.ts deleted file mode 100644 index 0690f1f..0000000 --- a/types/services/PmcAiService.d.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { IBotConfig } from "../models/spt/config/IBotConfig"; -import { ILogger } from "../models/spt/utils/ILogger"; -import { ConfigServer } from "../servers/ConfigServer"; -/** Storing/retreving pmcRoles set at the start of a raid - its done at that point as we know what location the player is heading to */ -export declare class PmcAiService { - protected logger: ILogger; - protected configServer: ConfigServer; - protected botConfig: IBotConfig; - protected usecRole: string; - protected bearRole: string; - constructor(logger: ILogger, configServer: ConfigServer); - /** - * 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 - */ - getPmcRole(pmcSide: "usec" | "bear" | string): string; - /** - * Set the roles for pmcs - * @param location map location to look up and use as pmc types - */ - setPmcRolesByLocation(location: string): void; - /** - * Clear the saved role from usec/bear PMCs - */ - clearPmcRoles(): void; -} diff --git a/types/services/ProfileFixerService.d.ts b/types/services/ProfileFixerService.d.ts index 9cb5a38..86a6af8 100644 --- a/types/services/ProfileFixerService.d.ts +++ b/types/services/ProfileFixerService.d.ts @@ -1,16 +1,21 @@ +import { HideoutHelper } from "../helpers/HideoutHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { HideoutSlot } from "../models/eft/common/tables/IBotBase"; +import { Bonus, HideoutSlot } from "../models/eft/common/tables/IBotBase"; import { IPmcDataRepeatableQuest, IRepeatableQuest } from "../models/eft/common/tables/IRepeatableQuests"; +import { StageBonus } from "../models/eft/hideout/IHideoutArea"; import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { HideoutAreas } from "../models/enums/HideoutAreas"; import { ILogger } from "../models/spt/utils/ILogger"; import { DatabaseServer } from "../servers/DatabaseServer"; import { Watermark } from "../utils/Watermark"; +import { LocalisationService } from "./LocalisationService"; export declare class ProfileFixerService { protected logger: ILogger; protected watermark: Watermark; + protected hideoutHelper: HideoutHelper; + protected localisationService: LocalisationService; protected databaseServer: DatabaseServer; - constructor(logger: ILogger, watermark: Watermark, databaseServer: DatabaseServer); + constructor(logger: ILogger, watermark: Watermark, hideoutHelper: HideoutHelper, localisationService: LocalisationService, databaseServer: DatabaseServer); /** * Find issues in the pmc profile data that may cause issues and fix them * @param pmcProfile profile to check and fix @@ -63,4 +68,21 @@ export declare class ProfileFixerService { */ protected updateProfilePocketsToNewId(pmcProfile: IPmcData): void; addMissingArmorRepairSkill(pmcProfile: IPmcData): void; + /** + * Iterate over players hideout areas and find what's build, look for missing bonuses those areas give and add them if missing + * @param pmcProfile Profile to update + */ + addMissingHideoutBonusesToProfile(pmcProfile: IPmcData): void; + /** + * + * @param profileBonuses bonuses from profile + * @param bonus bonus to find + * @returns matching bonus + */ + protected getBonusFromProfile(profileBonuses: Bonus[], bonus: StageBonus): Bonus; + /** + * Checks profile inventiory for items that do not exist inside the items db + * @param pmcProfile Profile to check inventory of + */ + checkForOrphanedModdedItems(pmcProfile: IPmcData): void; } diff --git a/types/services/RagfairOfferService.d.ts b/types/services/RagfairOfferService.d.ts index f9e3a34..133e6a7 100644 --- a/types/services/RagfairOfferService.d.ts +++ b/types/services/RagfairOfferService.d.ts @@ -1,3 +1,4 @@ +import { RagfairOfferHolder } from "../utils/RagfairOfferHolder"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { RagfairServerHelper } from "../helpers/RagfairServerHelper"; import { Item } from "../models/eft/common/tables/IItem"; @@ -5,12 +6,13 @@ import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRout import { IRagfairOffer } from "../models/eft/ragfair/IRagfairOffer"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; -import { ItemEventRouter } from "../routers/ItemEventRouter"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { TimeUtil } from "../utils/TimeUtil"; +import { LocalisationService } from "./LocalisationService"; import { RagfairCategoriesService } from "./RagfairCategoriesService"; export declare class RagfairOfferService { protected logger: ILogger; @@ -20,14 +22,15 @@ export declare class RagfairOfferService { protected ragfairServerHelper: RagfairServerHelper; protected ragfairCategoriesService: RagfairCategoriesService; protected profileHelper: ProfileHelper; - protected itemEventRouter: ItemEventRouter; + protected eventOutputHolder: EventOutputHolder; protected httpResponse: HttpResponseUtil; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected playerOffersLoaded: boolean; - protected expiredOffers: Item[]; - protected offers: IRagfairOffer[]; + protected expiredOffers: Record; protected ragfairConfig: IRagfairConfig; - constructor(logger: ILogger, timeUtil: TimeUtil, databaseServer: DatabaseServer, saveServer: SaveServer, ragfairServerHelper: RagfairServerHelper, ragfairCategoriesService: RagfairCategoriesService, profileHelper: ProfileHelper, itemEventRouter: ItemEventRouter, httpResponse: HttpResponseUtil, configServer: ConfigServer); + protected ragfairOfferHandler: RagfairOfferHolder; + constructor(logger: ILogger, timeUtil: TimeUtil, databaseServer: DatabaseServer, saveServer: SaveServer, ragfairServerHelper: RagfairServerHelper, ragfairCategoriesService: RagfairCategoriesService, profileHelper: ProfileHelper, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, localisationService: LocalisationService, configServer: ConfigServer); /** * Get all offers * @returns IRagfairOffer array @@ -42,7 +45,7 @@ export declare class RagfairOfferService { * Get an array of expired items not yet processed into new offers * @returns items that need to be turned into offers */ - getExpiredOffers(): Item[]; + getExpiredOfferItems(): Item[]; resetExpiredOffers(): void; /** * Does the offer exist on the ragfair @@ -61,12 +64,6 @@ export declare class RagfairOfferService { traderOffersNeedRefreshing(traderID: string): boolean; addPlayerOffers(): void; expireStaleOffers(): void; - /** - * Get an array of stale offers that are still shown to player - * @returns IRagfairOffer array - */ - protected getStaleOffers(): IRagfairOffer[]; - protected isStale(offer: IRagfairOffer, time: number): boolean; protected processStaleOffer(staleOffer: IRagfairOffer): void; protected returnPlayerOffer(offer: IRagfairOffer): IItemEventRouterResponse; } diff --git a/types/services/RagfairPriceService.d.ts b/types/services/RagfairPriceService.d.ts index 466c9e3..cf0459c 100644 --- a/types/services/RagfairPriceService.d.ts +++ b/types/services/RagfairPriceService.d.ts @@ -10,7 +10,11 @@ import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { RandomUtil } from "../utils/RandomUtil"; -export declare class RagfairPriceService { +import { OnLoad } from "../di/OnLoad"; +/** + * Stores flea prices for items as well as methods to interact with them + */ +export declare class RagfairPriceService implements OnLoad { protected handbookHelper: HandbookHelper; protected databaseServer: DatabaseServer; protected logger: ILogger; @@ -19,21 +23,48 @@ export declare class RagfairPriceService { protected randomUtil: RandomUtil; protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; + protected generatedDynamicPrices: boolean; + protected generatedStaticPrices: boolean; protected prices: IRagfairServerPrices; constructor(handbookHelper: HandbookHelper, databaseServer: DatabaseServer, logger: ILogger, itemHelper: ItemHelper, presetHelper: PresetHelper, randomUtil: RandomUtil, configServer: ConfigServer); + /** + * Generate static (handbook) and dynamic (prices.json) flea prices, store inside class as dictionaries + */ + onLoad(): Promise; + getRoute(): string; + /** + * Iterate over all items of type "Item" in db and get template price, store in cache + */ generateStaticPrices(): void; - generateDynamicPrices(): void; - hasDynamicPrices(): boolean; - getDynamicPrice(itemTpl: string): number; - getAllFleaPrices(): Record; + /** + * Create a dictionary and store prices from prices.json in it + */ + protected generateDynamicPrices(): void; + /** + * Get the dynamic price for an item. If value doesn't exist, use static (handbook0) value. + * if no static value, return 1 + * @param tplId Item tpl id to get price for + * @returns price in roubles + */ getFleaPriceForItem(tplId: string): number; /** - * Check to see if an items price is below its handbook price and adjust accoring to values set to config/ragfair.json - * @param itemPrice price of item - * @param itemTpl item template Id being checked - * @returns adjusted price value in roubles + * get the dynamic (flea) price for an item + * Grabs prices from prices.json and stores in class if none currently exist + * @param itemTpl item template id to look up + * @returns price in roubles */ - protected adjustPriceIfBelowHandbook(itemPrice: number, itemTpl: string): number; + getDynamicPriceForItem(itemTpl: string): number; + /** + * Grab the static (handbook) for an item by its tplId + * @param itemTpl item template id to look up + * @returns price in roubles + */ + getStaticPriceForItem(itemTpl: string): number; + /** + * Get prices for all items on flea, priorities dynamic prices from prices.json, use handbook prices if missing + * @returns Dictionary of item tpls and rouble cost + */ + getAllFleaPrices(): Record; /** * Get the percentage difference between two values * @param a numerical value a @@ -41,9 +72,26 @@ export declare class RagfairPriceService { * @returns different in percent */ protected getPriceDifference(a: number, b: number): number; - getStaticPriceForItem(tplId: string): number; + /** + * Get the rouble price for an assorts barter scheme + * @param barterScheme + * @returns Rouble price + */ getBarterPrice(barterScheme: IBarterScheme[]): number; + /** + * Generate a currency cost for an item and its mods + * @param items Item with mods to get price for + * @param desiredCurrency Currency price desired in + * @returns cost of item in desired currency + */ getDynamicOfferPrice(items: Item[], desiredCurrency: string): number; + /** + * Check to see if an items price is below its handbook price and adjust accoring to values set to config/ragfair.json + * @param itemPrice price of item + * @param itemTpl item template Id being checked + * @returns adjusted price value in roubles + */ + protected adjustPriceIfBelowHandbook(itemPrice: number, itemTpl: string): number; /** * Multiply the price by a randomised curve where n = 2, shift = 2 * @param existingPrice price to alter @@ -58,7 +106,7 @@ export declare class RagfairPriceService { * @param existingPrice price of existing base weapon * @returns */ - getWeaponPresetPrice(item: Item, items: Item[], existingPrice: number): number; + protected getWeaponPresetPrice(item: Item, items: Item[], existingPrice: number): number; /** * Attempt to get the default preset for a weapon, failing that get the first preset in the array * (assumes default = has encyclopedia entry) diff --git a/types/services/RagfairRequiredItemsService.d.ts b/types/services/RagfairRequiredItemsService.d.ts index b05fc65..95c3ddb 100644 --- a/types/services/RagfairRequiredItemsService.d.ts +++ b/types/services/RagfairRequiredItemsService.d.ts @@ -7,6 +7,6 @@ export declare class RagfairRequiredItemsService { protected ragfairOfferService: RagfairOfferService; protected requiredItemsCache: {}; constructor(logger: ILogger, paymentHelper: PaymentHelper, ragfairOfferService: RagfairOfferService); - getRequiredItems(searchId: string): any; + getRequiredItemsById(searchId: string): any; buildRequiredItemTable(): void; } diff --git a/types/services/RepairService.d.ts b/types/services/RepairService.d.ts new file mode 100644 index 0000000..d3f1b35 --- /dev/null +++ b/types/services/RepairService.d.ts @@ -0,0 +1,73 @@ +import { QuestHelper } from "../helpers/QuestHelper"; +import { RepairHelper } from "../helpers/RepairHelper"; +import { TraderHelper } from "../helpers/TraderHelper"; +import { IPmcData } from "../models/eft/common/IPmcData"; +import { Item } from "../models/eft/common/tables/IItem"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +import { RepairKitsInfo } from "../models/eft/repair/IRepairActionDataRequest"; +import { RepairItem } from "../models/eft/repair/ITraderRepairActionDataRequest"; +import { IRepairConfig } from "../models/spt/config/IRepairConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { PaymentService } from "./PaymentService"; +export declare class RepairService { + protected logger: ILogger; + protected databaseServer: DatabaseServer; + protected questHelper: QuestHelper; + protected traderHelper: TraderHelper; + protected paymentService: PaymentService; + protected repairHelper: RepairHelper; + protected configServer: ConfigServer; + repairConfig: IRepairConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, questHelper: QuestHelper, traderHelper: TraderHelper, paymentService: PaymentService, repairHelper: RepairHelper, configServer: ConfigServer); + /** + * Use trader to repair an items durability + * @param sessionID Session id + * @param pmcData profile to find item to repair in + * @param repairItemDetails details of the item to repair + * @param traderId Trader being used to repair item + * @returns RepairDetails object + */ + repairItemByTrader(sessionID: string, pmcData: IPmcData, repairItemDetails: RepairItem, traderId: string): RepairDetails; + /** + * + * @param sessionID Session id + * @param pmcData profile to take money from + * @param repairedItemId Repaired item id + * @param repairCost Cost to repair item in roubles + * @param traderId Id of the trader who repaired the item / who is paid + * @param output + */ + payForRepair(sessionID: string, pmcData: IPmcData, repairedItemId: string, repairCost: number, traderId: string, output: IItemEventRouterResponse): void; + /** + * Add skill points to profile after repairing an item + * @param sessionId Session id + * @param repairDetails details of item repaired, cost/item + * @param pmcData Profile to add points to + * @param output IItemEventRouterResponse + */ + addRepairSkillPoints(sessionId: string, repairDetails: RepairDetails, pmcData: IPmcData, output: IItemEventRouterResponse): void; + /** + * + * @param sessionId Session id + * @param pmcData Profile to update repaired item in + * @param repairKits Array of Repair kits to use + * @param itemToRepairId Item id to repair + * @param output IItemEventRouterResponse + * @returns Details of repair, item/price + */ + repairItemByKit(sessionId: string, pmcData: IPmcData, repairKits: RepairKitsInfo[], itemToRepairId: string, output: IItemEventRouterResponse): RepairDetails; + /** + * Update repair kits Resource object if it doesn't exist + * @param repairKitDetails Repair kit details from db + * @param repairKitInInventory Repair kit to update + */ + protected addMaxResourceToKitIfMissing(repairKitDetails: ITemplateItem, repairKitInInventory: Item): void; +} +export declare class RepairDetails { + repairCost?: number; + repairedItem: Item; + repairedItemIsArmor: boolean; +} diff --git a/types/services/SeasonalEventService.d.ts b/types/services/SeasonalEventService.d.ts new file mode 100644 index 0000000..ac765ff --- /dev/null +++ b/types/services/SeasonalEventService.d.ts @@ -0,0 +1,72 @@ +import { BotHelper } from "../helpers/BotHelper"; +import { Config } from "../models/eft/common/IGlobals"; +import { Inventory } from "../models/eft/common/tables/IBotType"; +import { ISeasonalEvent, ISeasonalEventConfig } from "../models/spt/config/ISeasonalEventConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "./LocalisationService"; +export declare class SeasonalEventService { + protected logger: ILogger; + protected databaseServer: DatabaseServer; + protected localisationService: LocalisationService; + protected botHelper: BotHelper; + protected configServer: ConfigServer; + protected seasonalEventConfig: ISeasonalEventConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, localisationService: LocalisationService, botHelper: BotHelper, configServer: ConfigServer); + protected get events(): Record; + protected get christmasEventItems(): string[]; + /** + * Get an array of christmas items found in bots inventories as loot + * @returns array + */ + getChristmasEventItems(): string[]; + itemIsChristmasRelated(itemId: string): boolean; + /** + * is christmas event active + * @returns true if active + */ + christmasEventEnabled(): boolean; + /** + * Is detection of seasonal events enabled (halloween / christmas) + * @returns true if seasonal events should be checked for + */ + isAutomaticEventDetectionEnabled(): boolean; + /** + * Get a dictionary of gear changes to apply to bots for a specific event e.g. Christmas/Halloween + * @param eventName Name of event to get gear changes for + * @returns bots with equipment changes + */ + protected getEventBotGear(eventName: string): Record>>; + /** + * Get the dates each seasonal event starts and ends at + * @returns Record with event name + start/end date + */ + getEventDetails(): ISeasonalEvent[]; + /** + * Check if current date falls inside any of the seasons events pased in, if so, handle them + */ + checkForAndEnableSeasonalEvents(): void; + /** + * Iterate through bots inventory and loot to find and remove christmas items (as defined in SeasonalEventService) + * @param nodeInventory Bots inventory to iterate over + * @param botRole the role of the bot being processed + */ + removeChristmasItemsFromBotInventory(nodeInventory: Inventory, botRole: string): void; + /** + * Make adjusted to server code based on the name of the event passed in + * @param globalConfig globals.json + * @param eventName Name of the event to enable. e.g. Christmas + */ + protected updateGlobalEvents(globalConfig: Config, eventName: string): void; + /** + * Read in data from seasonalEvents.json and add found equipment items to bots + * @param eventName Name of the event to read equipment in from config + */ + protected addEventGearToScavs(eventName: string): void; + protected addPumpkinsToScavBackpacks(): void; + /** + * Set Khorovod(dancing tree) chance to 100% on all maps that support it + */ + protected enableDancingTree(): void; +} diff --git a/types/services/TraderPurchasePersisterService.d.ts b/types/services/TraderPurchasePersisterService.d.ts new file mode 100644 index 0000000..7e7c88f --- /dev/null +++ b/types/services/TraderPurchasePersisterService.d.ts @@ -0,0 +1,34 @@ +import { ProfileHelper } from "../helpers/ProfileHelper"; +import { TraderPurchaseData } from "../models/eft/profile/IAkiProfile"; +import { ITraderConfig } from "../models/spt/config/ITraderConfig"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { TimeUtil } from "../utils/TimeUtil"; +/** + * Help with storing limited item purchases from traders in profile to persist them over server restarts + */ +export declare class TraderPurchasePersisterService { + protected logger: ILogger; + protected timeUtil: TimeUtil; + protected profileHelper: ProfileHelper; + protected configServer: ConfigServer; + protected traderConfig: ITraderConfig; + constructor(logger: ILogger, timeUtil: TimeUtil, profileHelper: ProfileHelper, configServer: ConfigServer); + /** + * Get the purchases made from a trader for this profile before the last trader reset + * @param sessionId Session id + * @param traderId Trader to loop up purchases for + * @returns Dict of assort id and count purchased + */ + getProfileTraderPurchases(sessionId: string, traderId: string): Record; + /** + * Remove all trader purchase records from all profiles that exist + * @param traderId Traders id + */ + resetTraderPurchasesStoredInProfile(traderId: string): void; + /** + * Iterate over all server profiles and remove specific trader purchase data that has passed the trader refesh time + * @param traderId Trader id + */ + removeStalePurchasesFromProfiles(traderId: string): void; +} diff --git a/types/services/mod/httpListener/HttpListenerMod.d.ts b/types/services/mod/httpListener/HttpListenerMod.d.ts new file mode 100644 index 0000000..2cdfbda --- /dev/null +++ b/types/services/mod/httpListener/HttpListenerMod.d.ts @@ -0,0 +1,10 @@ +/// +import { IncomingMessage, ServerResponse } from "http"; +import { IHttpListener } from "../../../servers/http/IHttpListener"; +export declare class HttpListenerMod implements IHttpListener { + private canHandleOverride; + private handleOverride; + constructor(canHandleOverride: (sessionId: string, req: IncomingMessage) => boolean, handleOverride: (sessionId: string, req: IncomingMessage, resp: ServerResponse) => void); + canHandle(sessionId: string, req: IncomingMessage): boolean; + handle(sessionId: string, req: IncomingMessage, resp: ServerResponse): void; +} diff --git a/types/services/mod/httpListener/HttpListenerModService.d.ts b/types/services/mod/httpListener/HttpListenerModService.d.ts new file mode 100644 index 0000000..9dd3473 --- /dev/null +++ b/types/services/mod/httpListener/HttpListenerModService.d.ts @@ -0,0 +1,8 @@ +/// +import { IncomingMessage, ServerResponse } from "http"; +import { DependencyContainer } from "tsyringe"; +export declare class HttpListenerModService { + protected container: DependencyContainer; + constructor(container: DependencyContainer); + registerHttpListener(name: string, canHandleOverride: (sessionId: string, req: IncomingMessage) => boolean, handleOverride: (sessionId: string, req: IncomingMessage, resp: ServerResponse) => void): void; +} diff --git a/types/services/mod/onLoad/OnLoadMod.d.ts b/types/services/mod/onLoad/OnLoadMod.d.ts index 53fb062..82909c3 100644 --- a/types/services/mod/onLoad/OnLoadMod.d.ts +++ b/types/services/mod/onLoad/OnLoadMod.d.ts @@ -3,6 +3,6 @@ export declare class OnLoadMod extends OnLoad { private onLoadOverride; private getRouteOverride; constructor(onLoadOverride: () => void, getRouteOverride: () => string); - onLoad(): void; + onLoad(): Promise; getRoute(): string; } diff --git a/types/services/mod/onUpdate/OnUpdateMod.d.ts b/types/services/mod/onUpdate/OnUpdateMod.d.ts index ee89043..edd2a2c 100644 --- a/types/services/mod/onUpdate/OnUpdateMod.d.ts +++ b/types/services/mod/onUpdate/OnUpdateMod.d.ts @@ -3,6 +3,6 @@ export declare class OnUpdateMod extends OnUpdate { private onUpdateOverride; private getRouteOverride; constructor(onUpdateOverride: (timeSinceLastRun: number) => boolean, getRouteOverride: () => string); - onUpdate(timeSinceLastRun: number): boolean; + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/utils/App.d.ts b/types/utils/App.d.ts index dcc2669..b947c83 100644 --- a/types/utils/App.d.ts +++ b/types/utils/App.d.ts @@ -1,15 +1,17 @@ -import { TimeUtil } from "./TimeUtil"; import { OnLoad } from "../di/OnLoad"; import { OnUpdate } from "../di/OnUpdate"; import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; +import { TimeUtil } from "./TimeUtil"; export declare class App { protected logger: ILogger; protected timeUtil: TimeUtil; + protected localisationService: LocalisationService; protected onLoadComponents: OnLoad[]; protected onUpdateComponents: OnUpdate[]; protected onUpdateLastRun: {}; - constructor(logger: ILogger, timeUtil: TimeUtil, onLoadComponents: OnLoad[], onUpdateComponents: OnUpdate[]); - load(): void; - protected update(onUpdateComponents: OnUpdate[]): void; + constructor(logger: ILogger, timeUtil: TimeUtil, localisationService: LocalisationService, onLoadComponents: OnLoad[], onUpdateComponents: OnUpdate[]); + load(): Promise; + protected update(onUpdateComponents: OnUpdate[]): Promise; protected logUpdateException(err: any, updateable: OnUpdate): void; } diff --git a/types/utils/DatabaseImporter.d.ts b/types/utils/DatabaseImporter.d.ts index 483e135..0c39aa8 100644 --- a/types/utils/DatabaseImporter.d.ts +++ b/types/utils/DatabaseImporter.d.ts @@ -3,22 +3,35 @@ import { IDatabaseTables } from "../models/spt/server/IDatabaseTables"; import { ILogger } from "../models/spt/utils/ILogger"; import { ImageRouter } from "../routers/ImageRouter"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { LocalisationService } from "../services/LocalisationService"; import { JsonUtil } from "./JsonUtil"; import { VFS } from "./VFS"; export declare class DatabaseImporter extends OnLoad { protected logger: ILogger; protected vfs: VFS; protected jsonUtil: JsonUtil; + protected localisationService: LocalisationService; protected databaseServer: DatabaseServer; protected imageRouter: ImageRouter; - constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, databaseServer: DatabaseServer, imageRouter: ImageRouter); - onLoad(): void; + constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, localisationService: LocalisationService, databaseServer: DatabaseServer, imageRouter: ImageRouter); + onLoad(): Promise; /** * Read all json files in database folder and map into a json object * @param filepath path to database folder */ - protected hydrateDatabase(filepath: string): void; + protected hydrateDatabase(filepath: string): Promise; getRoute(): string; + /** + * Load files into js objects recursively (asynchronous) + * @param filepath Path to folder with files + * @returns + */ + loadRecursiveAsync(filepath: string): Promise; + /** + * Load files into js objects recursively (synchronous) + * @param filepath Path to folder with files + * @returns + */ loadRecursive(filepath: string): IDatabaseTables; loadImages(filepath: string): void; } diff --git a/types/utils/HttpFileUtil.d.ts b/types/utils/HttpFileUtil.d.ts new file mode 100644 index 0000000..afc8409 --- /dev/null +++ b/types/utils/HttpFileUtil.d.ts @@ -0,0 +1,8 @@ +/// +import { ServerResponse } from "http"; +import { HttpServerHelper } from "../helpers/HttpServerHelper"; +export declare class HttpFileUtil { + protected httpServerHelper: HttpServerHelper; + constructor(httpServerHelper: HttpServerHelper); + sendFile(resp: ServerResponse, file: any): void; +} diff --git a/types/utils/HttpResponseUtil.d.ts b/types/utils/HttpResponseUtil.d.ts index 29502be..3a78618 100644 --- a/types/utils/HttpResponseUtil.d.ts +++ b/types/utils/HttpResponseUtil.d.ts @@ -1,10 +1,13 @@ -import { JsonUtil } from "./JsonUtil"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { INullResponseData } from "../models/eft/httpResponse/INullResponseData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +import { BackendErrorCodes } from "../models/enums/BackendErrorCodes"; +import { LocalisationService } from "../services/LocalisationService"; +import { JsonUtil } from "./JsonUtil"; export declare class HttpResponseUtil { protected jsonUtil: JsonUtil; - constructor(jsonUtil: JsonUtil); + protected localisationService: LocalisationService; + constructor(jsonUtil: JsonUtil, localisationService: LocalisationService); protected clearString(s: string): any; noBody(data: any): any; getBody(data: T, err?: number, errmsg?: any): IGetBodyResponseData; @@ -12,5 +15,5 @@ export declare class HttpResponseUtil { emptyResponse(): IGetBodyResponseData; nullResponse(): INullResponseData; emptyArrayResponse(): IGetBodyResponseData; - appendErrorToOutput(output: IItemEventRouterResponse, message?: string, title?: string): IItemEventRouterResponse; + appendErrorToOutput(output: IItemEventRouterResponse, message?: string, errorCode?: BackendErrorCodes): IItemEventRouterResponse; } diff --git a/types/utils/JsonUtil.d.ts b/types/utils/JsonUtil.d.ts index 71e95f6..2591142 100644 --- a/types/utils/JsonUtil.d.ts +++ b/types/utils/JsonUtil.d.ts @@ -6,6 +6,7 @@ export declare class JsonUtil { protected hashUtil: HashUtil; protected logger: ILogger; protected fileHashes: any; + protected jsonCacheExists: boolean; constructor(vfs: VFS, hashUtil: HashUtil, logger: ILogger); /** * From object to string diff --git a/types/utils/Logger.d.ts b/types/utils/Logger.d.ts index 3d9013f..1088701 100644 --- a/types/utils/Logger.d.ts +++ b/types/utils/Logger.d.ts @@ -53,6 +53,12 @@ export declare class WinstonLogger implements ILogger { warning(data: string | Record): Promise; success(data: string | Record): Promise; info(data: string | Record): Promise; + /** + * Log to console text with a customisable text and background color. Background defaults to black + * @param data text to log + * @param textColor color of text + * @param backgroundColor color of background + */ logWithColor(data: string | Record, textColor: LogTextColor, backgroundColor?: LogBackgroundColor): Promise; debug(data: string | Record, onlyShowInConsole?: boolean): Promise; } diff --git a/types/utils/RagfairOfferHolder.d.ts b/types/utils/RagfairOfferHolder.d.ts new file mode 100644 index 0000000..46d9e23 --- /dev/null +++ b/types/utils/RagfairOfferHolder.d.ts @@ -0,0 +1,24 @@ +import { IRagfairOffer } from "../models/eft/ragfair/IRagfairOffer"; +export declare class RagfairOfferHolder { + private offersById; + private offersByTemplate; + private offersByTrader; + constructor(); + getOfferById(id: string): IRagfairOffer; + getOffersByTemplate(templateId: string): Array; + getOffersByTrader(traderId: string): Array; + getOffers(): Array; + addOffers(offers: Array): void; + addOffer(offer: IRagfairOffer): void; + removeOffer(offer: IRagfairOffer): void; + removeOffers(offers: Array): void; + removeOfferByTrader(traderId: string): void; + /** + * Get an array of stale offers that are still shown to player + * @returns IRagfairOffer array + */ + getStaleOffers(time: number): Array; + private addOfferByTemplates; + private addOfferByTrader; + protected isStale(offer: IRagfairOffer, time: number): boolean; +} diff --git a/types/utils/RandomUtil.d.ts b/types/utils/RandomUtil.d.ts index 633e472..aa556e3 100644 --- a/types/utils/RandomUtil.d.ts +++ b/types/utils/RandomUtil.d.ts @@ -110,6 +110,12 @@ export declare class RandomUtil { getIntEx(max: number): number; getFloat(min: number, max: number): number; getBool(): boolean; + /** + * Check if number passes a check out of 100 + * @param chancePercent value check needs to be above + * @returns true if value passes check + */ + getChance100(chancePercent: number): boolean; getStringArrayValue(arr: string[]): string; getArrayValue(arr: T[]): T; getKey(node: any): string; diff --git a/types/utils/Watermark.d.ts b/types/utils/Watermark.d.ts index c6dc120..f870cf1 100644 --- a/types/utils/Watermark.d.ts +++ b/types/utils/Watermark.d.ts @@ -1,20 +1,15 @@ import { ICoreConfig } from "../models/spt/config/ICoreConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; +import { LocalisationService } from "../services/LocalisationService"; export declare class WatermarkLocale { - protected locales: { - "en-US": { - description: string[]; - warning: string[]; - modding: string[]; - }; - "zh-CN": { - description: string[]; - warning: string[]; - modding: string[]; - }; + protected localisationService: LocalisationService; + constructor(localisationService: LocalisationService); + protected watermark: { + description: string[]; + warning: string[]; + modding: string[]; }; - getLocale(): string; getDescription(): string[]; getWarning(): string[]; getModding(): string[]; @@ -22,9 +17,10 @@ export declare class WatermarkLocale { export declare class Watermark { protected logger: ILogger; protected configServer: ConfigServer; + protected localisationService: LocalisationService; protected watermarkLocale?: WatermarkLocale; protected akiConfig: ICoreConfig; - constructor(logger: ILogger, configServer: ConfigServer, watermarkLocale?: WatermarkLocale); + constructor(logger: ILogger, configServer: ConfigServer, localisationService: LocalisationService, watermarkLocale?: WatermarkLocale); protected text: string[]; protected versionLabel: string; initialize(): void; @@ -34,7 +30,11 @@ export declare class Watermark { * @returns string */ getVersionTag(withEftVersion?: boolean): string; - getVersionLabel(): string; + /** + * Get text shown in game on screen, can't be translated as it breaks bsgs client when certian characters are used + * @returns string + */ + getInGameVersionLabel(): string; /** Set window title */ setTitle(): void; /** Reset console cursor to top */