From 3b60118bac6fda391b43e388f815aa35b6514c85 Mon Sep 17 00:00:00 2001 From: StuckInLimbo Date: Thu, 18 May 2023 15:57:25 -0400 Subject: [PATCH] Update types for 3.5.6 --- types/callbacks/DataCallbacks.d.ts | 20 +- types/callbacks/DialogueCallbacks.d.ts | 21 +- types/callbacks/GameCallbacks.d.ts | 6 +- types/callbacks/HandbookCallbacks.d.ts | 4 +- types/callbacks/HealthCallbacks.d.ts | 9 + types/callbacks/HideoutCallbacks.d.ts | 59 ++--- types/callbacks/HttpCallbacks.d.ts | 4 +- types/callbacks/InsuranceCallbacks.d.ts | 4 +- types/callbacks/MatchCallbacks.d.ts | 19 +- types/callbacks/ModCallbacks.d.ts | 11 +- types/callbacks/PresetCallbacks.d.ts | 4 +- types/callbacks/ProfileCallbacks.d.ts | 2 + types/callbacks/RagfairCallbacks.d.ts | 19 +- types/callbacks/SaveCallbacks.d.ts | 15 +- types/callbacks/TradeCallbacks.d.ts | 3 + types/callbacks/TraderCallbacks.d.ts | 16 +- types/context/ApplicationContext.d.ts | 11 + types/context/ContextVariableType.d.ts | 6 +- types/controllers/BotController.d.ts | 20 +- .../controllers/CustomizationController.d.ts | 35 ++- types/controllers/DialogueController.d.ts | 22 +- types/controllers/GameController.d.ts | 74 ++++-- types/controllers/HealthController.d.ts | 43 +++- types/controllers/HideoutController.d.ts | 148 ++++++++++-- types/controllers/InraidController.d.ts | 29 ++- types/controllers/InsuranceController.d.ts | 12 +- types/controllers/InventoryController.d.ts | 55 ++++- types/controllers/LauncherController.d.ts | 12 +- types/controllers/LocationController.d.ts | 23 +- types/controllers/MatchController.d.ts | 36 ++- types/controllers/ProfileController.d.ts | 11 +- types/controllers/QuestController.d.ts | 74 +++++- types/controllers/RagfairController.d.ts | 45 +++- .../RepeatableQuestController.d.ts | 49 +++- types/controllers/TradeController.d.ts | 25 +- types/controllers/TraderController.d.ts | 16 +- types/controllers/WishlistController.d.ts | 2 +- types/di/OnLoad.d.ts | 4 +- types/di/OnLoadOnUpdate.d.ts | 7 - types/di/OnUpdate.d.ts | 4 +- .../generators/BotEquipmentModGenerator.d.ts | 202 ++++++++++++++++ types/generators/BotGenerator.d.ts | 91 ++++---- types/generators/BotInventoryGenerator.d.ts | 46 +++- types/generators/BotLevelGenerator.d.ts | 29 +++ types/generators/BotLootGenerator.d.ts | 34 ++- types/generators/BotWeaponGenerator.d.ts | 42 +++- types/generators/LocationGenerator.d.ts | 44 +++- types/generators/LootGenerator.d.ts | 18 +- types/generators/PMCLootGenerator.d.ts | 26 ++- types/generators/PlayerScavGenerator.d.ts | 14 +- types/generators/RagfairAssortGenerator.d.ts | 4 +- types/generators/RagfairOfferGenerator.d.ts | 46 +++- types/generators/ScavCaseRewardGenerator.d.ts | 11 +- .../implementations/UbglExternalMagGen.d.ts | 10 + types/helpers/AssortHelper.d.ts | 24 +- types/helpers/BotDifficultyHelper.d.ts | 2 +- types/helpers/BotGeneratorHelper.d.ts | 220 ++---------------- types/helpers/BotHelper.d.ts | 32 ++- types/helpers/BotWeaponGeneratorHelper.d.ts | 29 ++- types/helpers/DialogueHelper.d.ts | 6 +- types/helpers/DurabilityLimitsHelper.d.ts | 10 +- types/helpers/GameEventHelper.d.ts | 22 +- types/helpers/HandbookHelper.d.ts | 35 +-- types/helpers/HealthHelper.d.ts | 24 +- types/helpers/HideoutHelper.d.ts | 134 ++++++++++- types/helpers/InRaidHelper.d.ts | 55 ++++- types/helpers/InventoryHelper.d.ts | 54 ++++- types/helpers/ItemHelper.d.ts | 89 +++++-- types/helpers/NotificationSendHelper.d.ts | 28 ++- types/helpers/PaymentHelper.d.ts | 7 +- types/helpers/PresetHelper.d.ts | 2 + types/helpers/ProfileHelper.d.ts | 29 ++- types/helpers/QuestHelper.d.ts | 151 +++++++----- types/helpers/RagfairOfferHelper.d.ts | 27 ++- types/helpers/RagfairSellHelper.d.ts | 18 +- types/helpers/RagfairServerHelper.d.ts | 2 +- types/helpers/RagfairSortHelper.d.ts | 2 +- types/helpers/RepairHelper.d.ts | 11 +- types/helpers/TradeHelper.d.ts | 24 +- types/helpers/TraderAssortHelper.d.ts | 14 +- types/helpers/TraderHelper.d.ts | 111 ++++----- types/helpers/WeightedRandomHelper.d.ts | 4 + types/loaders/BundleLoader.d.ts | 8 + types/loaders/ModTypeCheck.d.ts | 43 ++++ types/loaders/PostAkiModLoader.d.ts | 18 +- types/loaders/PostDBModLoader.d.ts | 12 +- types/loaders/PreAkiModLoader.d.ts | 41 +--- .../eft/bot/IRandomisedBotLevelResult.d.ts | 4 + types/models/eft/common/IGlobals.d.ts | 136 ++++++++++- types/models/eft/common/ILocationBase.d.ts | 3 + types/models/eft/common/ILooseLoot.d.ts | 10 +- types/models/eft/common/tables/IBotBase.d.ts | 46 ++-- types/models/eft/common/tables/IBotType.d.ts | 24 +- types/models/eft/common/tables/IItem.d.ts | 14 +- .../eft/common/tables/IProfileTemplate.d.ts | 2 + types/models/eft/common/tables/IQuest.d.ts | 12 +- .../eft/common/tables/IRepeatableQuests.d.ts | 3 +- .../eft/common/tables/ITemplateItem.d.ts | 34 ++- types/models/eft/common/tables/ITrader.d.ts | 14 +- .../eft/customization/IGetSuitsResponse.d.ts | 2 +- types/models/eft/dialog/IChatServer.d.ts | 16 ++ .../eft/dialog/IClearMailMessageRequest.d.ts | 3 + .../eft/dialog/IDeleteFriendRequest.d.ts | 3 + .../dialog/IFriendRequestSendResponse.d.ts | 5 + .../dialog/IGetFriendListDataResponse.d.ts | 2 +- .../IGetMailDialogViewResponseData.d.ts | 3 +- .../eft/dialog/IRemoveMailMessageRequest.d.ts | 3 + .../models/eft/game/IGameConfigResponse.d.ts | 2 + .../eft/game/IGetItemPricesResponse.d.ts | 5 + types/models/eft/health/Effect.d.ts | 4 +- types/models/eft/health/IWorkoutData.d.ts | 4 + .../hideout/IHandleQTEEventRequestData.d.ts | 8 + types/models/eft/hideout/IHideoutArea.d.ts | 38 ++- ...ContinuousProductionStartRequestData.d.ts} | 2 +- .../IHideoutImproveAreaRequestData.d.ts | 13 ++ .../eft/hideout/IHideoutProduction.d.ts | 6 +- types/models/eft/hideout/IQteData.d.ts | 38 +++ .../hideout/IRecordShootingRangePoints.d.ts | 4 + .../IGetInsuranceCostResponseData.d.ts | 2 +- .../eft/inventory/IAddItemRequestData.d.ts | 7 +- .../eft/inventory/IAddItemTempObject.d.ts | 7 + .../IInventoryBaseActionRequestData.d.ts | 2 +- .../eft/itemEvent/IItemEventRouterBase.d.ts | 39 ++-- .../eft/launcher/IRemoveProfileData.d.ts | 2 +- .../eft/match/IAcceptGroupInviteRequest.d.ts | 3 + .../eft/match/IAcceptGroupInviteResponse.d.ts | 16 ++ .../eft/match/ICancelGroupInviteRequest.d.ts | 3 + .../eft/match/IEndOfflineRaidRequestData.d.ts | 2 +- .../IGetRaidConfigurationRequestData.d.ts | 32 +++ types/models/eft/match/IJoinMatchResult.d.ts | 4 +- .../match/IRemovePlayerFromGroupRequest.d.ts | 3 + .../eft/match/ISendGroupInviteRequest.d.ts | 4 + .../match/IStartOffineRaidRequestData.d.ts | 30 --- types/models/eft/notifier/INotifier.d.ts | 2 +- .../IPresetBuildActionRequestData.d.ts | 12 +- .../profile/GetProfileStatusResponseData.d.ts | 8 +- types/models/eft/profile/IAkiProfile.d.ts | 40 +++- .../models/eft/profile/IConnectResponse.d.ts | 6 + .../profile/IGetProfileSettingsRequest.d.ts | 3 + .../eft/quests/IFailQuestRequestData.d.ts | 5 + types/models/eft/ragfair/IRagfairOffer.d.ts | 1 + .../trade/IProcessSellTradeRequestData.d.ts | 1 + types/models/enums/AirdropType.d.ts | 6 + types/models/enums/BaseClasses.d.ts | 11 +- types/models/enums/ConfigTypes.d.ts | 4 +- types/models/enums/ELocationName.d.ts | 1 + types/models/enums/ExitStatis.d.ts | 7 + types/models/enums/HideoutAreas.d.ts | 4 +- types/models/enums/HideoutEventActions.d.ts | 4 +- types/models/enums/ItemEventActions.d.ts | 3 +- types/models/enums/QuestRewardType.d.ts | 3 +- types/models/enums/QuestStatus.d.ts | 3 +- types/models/enums/Traders.d.ts | 3 +- types/models/enums/WildSpawnTypeNumber.d.ts | 61 ++--- types/models/external/HttpFramework.d.ts | 2 +- .../models/external/IPostAkiLoadModAsync.d.ts | 4 + .../models/external/IPostDBLoadModAsync.d.ts | 4 + .../models/external/IPreAkiLoadModAsync.d.ts | 4 + .../models/spt/bots/BotGenerationDetails.d.ts | 18 ++ .../models/spt/bots/GenerateWeaponResult.d.ts | 3 +- .../{BotLootCache.d.ts => IBotLootCache.d.ts} | 2 +- .../models/spt/callbacks/IDataCallbacks.d.ts | 3 +- .../spt/callbacks/IDialogueCallbacks.d.ts | 22 +- .../spt/callbacks/IHideoutCallbacks.d.ts | 4 +- .../models/spt/callbacks/IMatchCallbacks.d.ts | 25 -- .../spt/callbacks/ITraderCallbacks.d.ts | 3 +- types/models/spt/config/IAirdropConfig.d.ts | 11 +- types/models/spt/config/IBotConfig.d.ts | 27 ++- types/models/spt/config/IBotDurability.d.ts | 20 +- types/models/spt/config/ICoreConfig.d.ts | 3 + types/models/spt/config/IHideoutConfig.d.ts | 6 +- types/models/spt/config/IHttpConfig.d.ts | 3 + types/models/spt/config/IInsuranceConfig.d.ts | 1 + types/models/spt/config/IInventoryConfig.d.ts | 2 + types/models/spt/config/ILocationConfig.d.ts | 28 +++ .../models/spt/config/ILostOnDeathConfig.d.ts | 21 ++ .../models/spt/config/IPlayerScavConfig.d.ts | 1 + types/models/spt/config/IPmChatResponse.d.ts | 13 ++ types/models/spt/config/IPmcConfig.d.ts | 9 +- types/models/spt/config/IQuestConfig.d.ts | 33 ++- types/models/spt/config/IRagfairConfig.d.ts | 57 ++++- types/models/spt/config/IRepairConfig.d.ts | 18 ++ .../spt/config/ISeasonalEventConfig.d.ts | 6 + types/models/spt/config/ITraderConfig.d.ts | 16 +- types/models/spt/mod/IMod.d.ts | 10 - types/models/spt/mod/IModLoader.d.ts | 2 - types/models/spt/mod/IPackageJsonData.d.ts | 3 +- types/models/spt/mod/NewItemDetails.d.ts | 2 + types/models/spt/server/IDatabaseTables.d.ts | 6 +- types/models/spt/server/ILocaleBase.d.ts | 49 +--- types/models/spt/server/ISettingsBase.d.ts | 5 + types/models/spt/services/LootRequest.d.ts | 2 +- types/routers/EventOutputHolder.d.ts | 34 ++- types/routers/ItemEventRouter.d.ts | 16 +- .../CustomizationItemEventRouter.d.ts | 4 +- .../item_events/HealthItemEventRouter.d.ts | 4 +- .../item_events/InsuranceItemEventRouter.d.ts | 4 +- .../item_events/InventoryItemEventRouter.d.ts | 4 +- .../item_events/NoteItemEventRouter.d.ts | 4 +- .../PresetBuildItemEventRouter.d.ts | 4 +- .../item_events/RagfairItemEventRouter.d.ts | 4 +- .../item_events/RepairItemEventRouter.d.ts | 4 +- .../item_events/TradeItemEventRouter.d.ts | 4 +- .../item_events/WishlistItemEventRouter.d.ts | 4 +- .../save_load/HealthSaveLoadRouter.d.ts | 2 +- .../save_load/InraidSaveLoadRouter.d.ts | 2 +- .../save_load/InsuranceSaveLoadRouter.d.ts | 2 +- .../save_load/ProfileSaveLoadRouter.d.ts | 2 +- .../routers/serializers/ImageSerializer.d.ts | 2 +- types/servers/HttpServer.d.ts | 9 +- types/servers/RagfairServer.d.ts | 8 +- types/servers/SaveServer.d.ts | 56 ++++- types/servers/http/AkiHttpListener.d.ts | 8 +- types/services/BotEquipmentFilterService.d.ts | 52 +++-- .../services/BotEquipmentModPoolService.d.ts | 65 ++++++ types/services/BotGenerationCacheService.d.ts | 18 +- types/services/BotLootCacheService.d.ts | 22 +- types/services/BotWeaponModLimitService.d.ts | 54 +++++ types/services/CustomLocationWaveService.d.ts | 42 ++++ types/services/FenceService.d.ts | 70 ++++-- types/services/InsuranceService.d.ts | 33 ++- types/services/ItemBaseClassService.d.ts | 39 ++++ types/services/LocaleService.d.ts | 5 +- types/services/LocalisationService.d.ts | 9 +- .../services/MatchBotDetailsCacheService.d.ts | 23 ++ types/services/OpenZoneService.d.ts | 28 +++ types/services/PaymentService.d.ts | 27 ++- types/services/PlayerService.d.ts | 4 +- types/services/PmcChatResponseService.d.ts | 91 ++++++++ types/services/ProfileFixerService.d.ts | 26 ++- types/services/RagfairCategoriesService.d.ts | 6 +- types/services/RagfairLinkedItemService.d.ts | 15 +- types/services/RagfairOfferService.d.ts | 25 +- types/services/RagfairPriceService.d.ts | 46 +++- .../services/RagfairRequiredItemsService.d.ts | 2 +- types/services/RepairService.d.ts | 65 +++++- types/services/SeasonalEventService.d.ts | 114 +++++++++ .../TraderPurchasePersisterService.d.ts | 34 +++ types/services/mod/onLoad/OnLoadMod.d.ts | 4 +- types/services/mod/onUpdate/OnUpdateMod.d.ts | 4 +- types/utils/App.d.ts | 4 +- .../utils/{AyncQueue.d.ts => AsyncQueue.d.ts} | 0 types/utils/DatabaseImporter.d.ts | 37 ++- types/utils/EncodingUtil.d.ts | 15 ++ types/utils/ImporterUtil.d.ts | 21 ++ types/utils/JsonUtil.d.ts | 8 +- types/utils/RagfairOfferHolder.d.ts | 24 ++ types/utils/RandomUtil.d.ts | 1 + types/utils/UUidGenerator.d.ts | 2 +- types/utils/VFS.d.ts | 7 +- types/utils/Watermark.d.ts | 6 +- types/utils/collections/queue/Queue.d.ts | 12 + types/utils/decorators/Singleton.d.ts | 4 - types/utils/decorators/constructor.d.ts | 4 - .../AbstractWinstonLogger.d.ts} | 31 ++- types/utils/logging/WinstonMainLogger.d.ts | 13 ++ types/utils/logging/WinstonRequestLogger.d.ts | 14 ++ 257 files changed, 4101 insertions(+), 1345 deletions(-) delete mode 100644 types/di/OnLoadOnUpdate.d.ts create mode 100644 types/generators/BotEquipmentModGenerator.d.ts create mode 100644 types/generators/BotLevelGenerator.d.ts create mode 100644 types/generators/weapongen/implementations/UbglExternalMagGen.d.ts create mode 100644 types/loaders/ModTypeCheck.d.ts create mode 100644 types/models/eft/bot/IRandomisedBotLevelResult.d.ts create mode 100644 types/models/eft/dialog/IChatServer.d.ts create mode 100644 types/models/eft/dialog/IClearMailMessageRequest.d.ts create mode 100644 types/models/eft/dialog/IDeleteFriendRequest.d.ts create mode 100644 types/models/eft/dialog/IFriendRequestSendResponse.d.ts create mode 100644 types/models/eft/dialog/IRemoveMailMessageRequest.d.ts create mode 100644 types/models/eft/game/IGetItemPricesResponse.d.ts create mode 100644 types/models/eft/health/IWorkoutData.d.ts create mode 100644 types/models/eft/hideout/IHandleQTEEventRequestData.d.ts rename types/models/eft/hideout/{IHideoutContinousProductionStartRequestData.d.ts => IHideoutContinuousProductionStartRequestData.d.ts} (59%) create mode 100644 types/models/eft/hideout/IHideoutImproveAreaRequestData.d.ts create mode 100644 types/models/eft/hideout/IQteData.d.ts create mode 100644 types/models/eft/hideout/IRecordShootingRangePoints.d.ts create mode 100644 types/models/eft/inventory/IAddItemTempObject.d.ts create mode 100644 types/models/eft/match/IAcceptGroupInviteRequest.d.ts create mode 100644 types/models/eft/match/IAcceptGroupInviteResponse.d.ts create mode 100644 types/models/eft/match/ICancelGroupInviteRequest.d.ts create mode 100644 types/models/eft/match/IGetRaidConfigurationRequestData.d.ts create mode 100644 types/models/eft/match/IRemovePlayerFromGroupRequest.d.ts create mode 100644 types/models/eft/match/ISendGroupInviteRequest.d.ts delete mode 100644 types/models/eft/match/IStartOffineRaidRequestData.d.ts create mode 100644 types/models/eft/profile/IConnectResponse.d.ts create mode 100644 types/models/eft/profile/IGetProfileSettingsRequest.d.ts create mode 100644 types/models/eft/quests/IFailQuestRequestData.d.ts create mode 100644 types/models/enums/AirdropType.d.ts create mode 100644 types/models/enums/ExitStatis.d.ts create mode 100644 types/models/external/IPostAkiLoadModAsync.d.ts create mode 100644 types/models/external/IPostDBLoadModAsync.d.ts create mode 100644 types/models/external/IPreAkiLoadModAsync.d.ts create mode 100644 types/models/spt/bots/BotGenerationDetails.d.ts rename types/models/spt/bots/{BotLootCache.d.ts => IBotLootCache.d.ts} (94%) delete mode 100644 types/models/spt/callbacks/IMatchCallbacks.d.ts create mode 100644 types/models/spt/config/ILostOnDeathConfig.d.ts create mode 100644 types/models/spt/config/IPmChatResponse.d.ts delete mode 100644 types/models/spt/mod/IMod.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/MatchBotDetailsCacheService.d.ts create mode 100644 types/services/OpenZoneService.d.ts create mode 100644 types/services/PmcChatResponseService.d.ts create mode 100644 types/services/SeasonalEventService.d.ts create mode 100644 types/services/TraderPurchasePersisterService.d.ts rename types/utils/{AyncQueue.d.ts => AsyncQueue.d.ts} (100%) create mode 100644 types/utils/EncodingUtil.d.ts create mode 100644 types/utils/ImporterUtil.d.ts create mode 100644 types/utils/RagfairOfferHolder.d.ts create mode 100644 types/utils/collections/queue/Queue.d.ts delete mode 100644 types/utils/decorators/Singleton.d.ts delete mode 100644 types/utils/decorators/constructor.d.ts rename types/utils/{Logger.d.ts => logging/AbstractWinstonLogger.d.ts} (62%) create mode 100644 types/utils/logging/WinstonMainLogger.d.ts create mode 100644 types/utils/logging/WinstonRequestLogger.d.ts diff --git a/types/callbacks/DataCallbacks.d.ts b/types/callbacks/DataCallbacks.d.ts index 2efcf81..26f5899 100644 --- a/types/callbacks/DataCallbacks.d.ts +++ b/types/callbacks/DataCallbacks.d.ts @@ -1,14 +1,16 @@ +import { HideoutController } from "../controllers/HideoutController"; +import { RagfairController } from "../controllers/RagfairController"; 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 { IGetItemPricesResponse } from "../models/eft/game/IGetItemPricesResponse"; 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"; @@ -18,7 +20,9 @@ import { HttpResponseUtil } from "../utils/HttpResponseUtil"; export declare class DataCallbacks { protected httpResponse: HttpResponseUtil; protected databaseServer: DatabaseServer; - constructor(httpResponse: HttpResponseUtil, databaseServer: DatabaseServer); + protected ragfairController: RagfairController; + protected hideoutController: HideoutController; + constructor(httpResponse: HttpResponseUtil, databaseServer: DatabaseServer, ragfairController: RagfairController, hideoutController: HideoutController); /** * Handles client/settings * @returns ISettingsBase @@ -54,7 +58,17 @@ export declare class DataCallbacks { 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; + /** + * Handle client/hideout/qte/list + */ + getQteList(url: string, info: IEmptyRequestData, sessionID: string): string; + /** + * Handle client/items/prices/ + * Called when viewing a traders assorts + * TODO - fully implement this + */ + getItemPrices(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; } diff --git a/types/callbacks/DialogueCallbacks.d.ts b/types/callbacks/DialogueCallbacks.d.ts index 7b2eeae..5630859 100644 --- a/types/callbacks/DialogueCallbacks.d.ts +++ b/types/callbacks/DialogueCallbacks.d.ts @@ -1,7 +1,11 @@ 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 { IClearMailMessageRequest } from "../models/eft/dialog/IClearMailMessageRequest"; +import { IDeleteFriendRequest } from "../models/eft/dialog/IDeleteFriendRequest"; import { IFriendRequestData } from "../models/eft/dialog/IFriendRequestData"; +import { IFriendRequestSendResponse } from "../models/eft/dialog/IFriendRequestSendResponse"; import { IGetAllAttachmentsRequestData } from "../models/eft/dialog/IGetAllAttachmentsRequestData"; import { IGetAllAttachmentsResponse } from "../models/eft/dialog/IGetAllAttachmentsResponse"; import { IGetChatServerListRequestData } from "../models/eft/dialog/IGetChatServerListRequestData"; @@ -12,6 +16,7 @@ import { IGetMailDialogViewRequestData } from "../models/eft/dialog/IGetMailDial import { IGetMailDialogViewResponseData } from "../models/eft/dialog/IGetMailDialogViewResponseData"; import { IPinDialogRequestData } from "../models/eft/dialog/IPinDialogRequestData"; import { IRemoveDialogRequestData } from "../models/eft/dialog/IRemoveDialogRequestData"; +import { IRemoveMailMessageRequest } from "../models/eft/dialog/IRemoveMailMessageRequest"; import { ISendMessageRequest } from "../models/eft/dialog/ISendMessageRequest"; import { ISetDialogReadRequestData } from "../models/eft/dialog/ISetDialogReadRequestData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; @@ -20,7 +25,7 @@ import { DialogueInfo } from "../models/eft/profile/IAkiProfile"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { TimeUtil } from "../utils/TimeUtil"; -export declare class DialogueCallbacks extends OnUpdate { +export declare class DialogueCallbacks implements OnUpdate { protected hashUtil: HashUtil; protected timeUtil: TimeUtil; protected httpResponse: HttpResponseUtil; @@ -35,10 +40,14 @@ export declare class DialogueCallbacks extends OnUpdate { * Handles client/chatServer/list * @returns */ - getChatServerList(url: string, info: IGetChatServerListRequestData, sessionID: string): IGetBodyResponseData; + getChatServerList(url: string, info: IGetChatServerListRequestData, sessionID: string): IGetBodyResponseData; + /** Handle client/mail/dialog/list */ getMailDialogList(url: string, info: IGetMailDialogListRequestData, sessionID: string): IGetBodyResponseData; + /** Handle client/mail/dialog/view */ getMailDialogView(url: string, info: IGetMailDialogViewRequestData, sessionID: string): IGetBodyResponseData; + /** Handle client/mail/dialog/info */ getMailDialogInfo(url: string, info: IGetMailDialogInfoRequestData, sessionID: string): IGetBodyResponseData; + /** Handle client/mail/dialog/remove */ removeDialog(url: string, info: IRemoveDialogRequestData, sessionID: string): IGetBodyResponseData; pinDialog(url: string, info: IPinDialogRequestData, sessionID: string): IGetBodyResponseData; unpinDialog(url: string, info: IPinDialogRequestData, sessionID: string): IGetBodyResponseData; @@ -48,10 +57,14 @@ export declare class DialogueCallbacks extends OnUpdate { * @returns IGetAllAttachmentsResponse */ getAllAttachments(url: string, info: IGetAllAttachmentsRequestData, sessionID: string): IGetBodyResponseData; + /** Handle client/friend/request/list/outbox */ listOutbox(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; listInbox(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - friendRequest(url: string, request: IFriendRequestData, sessionID: string): INullResponseData; + sendFriendRequest(url: string, request: IFriendRequestData, sessionID: string): IGetBodyResponseData; + deleteFriend(url: string, request: IDeleteFriendRequest, sessionID: string): INullResponseData; sendMessage(url: string, request: ISendMessageRequest, sessionID: string): IGetBodyResponseData; - onUpdate(timeSinceLastRun: number): boolean; + clearMail(url: string, request: IClearMailMessageRequest, sessionID: string): IGetBodyResponseData; + removeMail(url: string, request: IRemoveMailMessageRequest, sessionID: string): IGetBodyResponseData; + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/callbacks/GameCallbacks.d.ts b/types/callbacks/GameCallbacks.d.ts index 3a6b7e6..a1ce037 100644 --- a/types/callbacks/GameCallbacks.d.ts +++ b/types/callbacks/GameCallbacks.d.ts @@ -11,13 +11,15 @@ 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"; +import { SaveServer } from "../servers/SaveServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; import { Watermark } from "../utils/Watermark"; declare class GameCallbacks { protected httpResponse: HttpResponseUtil; protected watermark: Watermark; + protected saveServer: SaveServer; protected gameController: GameController; - constructor(httpResponse: HttpResponseUtil, watermark: Watermark, gameController: GameController); + constructor(httpResponse: HttpResponseUtil, watermark: Watermark, saveServer: SaveServer, gameController: GameController); /** * Handle client/game/version/validate * @returns INullResponseData @@ -30,6 +32,7 @@ declare class GameCallbacks { gameStart(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; /** * Handle client/game/logout + * Save profiles on game close * @returns IGameLogoutResponseData */ gameLogout(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; @@ -39,6 +42,7 @@ declare class GameCallbacks { */ getGameConfig(url: string, info: IGameEmptyCrcRequestData, sessionID: string): IGetBodyResponseData; getServer(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + getCurrentGroup(url: string, info: IEmptyRequestData, sessionID: string): any; validateGameVersion(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; /** * Handle client/game/keepalive diff --git a/types/callbacks/HandbookCallbacks.d.ts b/types/callbacks/HandbookCallbacks.d.ts index 891e375..6bd3909 100644 --- a/types/callbacks/HandbookCallbacks.d.ts +++ b/types/callbacks/HandbookCallbacks.d.ts @@ -1,8 +1,8 @@ import { HandbookController } from "../controllers/HandbookController"; import { OnLoad } from "../di/OnLoad"; -export declare class HandbookCallbacks extends OnLoad { +export declare class HandbookCallbacks implements 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 7edf03e..bd3e507 100644 --- a/types/callbacks/HealthCallbacks.d.ts +++ b/types/callbacks/HealthCallbacks.d.ts @@ -7,6 +7,7 @@ import { IOffraidHealRequestData } from "../models/eft/health/IOffraidHealReques import { ISyncHealthRequestData } from "../models/eft/health/ISyncHealthRequestData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +import { IWorkoutData } from "../models/eft/health/IWorkoutData"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; export declare class HealthCallbacks { protected httpResponse: HttpResponseUtil; @@ -21,6 +22,14 @@ export declare class HealthCallbacks { * @returns empty response, no data sent back to client */ syncHealth(url: string, info: ISyncHealthRequestData, sessionID: string): IGetBodyResponseData; + /** + * Custom aki server request found in modules/QTEPatch.cs + * @param url + * @param info HealthListener.Instance.CurrentHealth class + * @param sessionID session id + * @returns empty response, no data sent back to client + */ + handleWorkoutEffects(url: string, info: IWorkoutData, sessionID: string): IGetBodyResponseData; /** * Handle Eat * @returns IItemEventRouterResponse diff --git a/types/callbacks/HideoutCallbacks.d.ts b/types/callbacks/HideoutCallbacks.d.ts index e39e806..d0247f9 100644 --- a/types/callbacks/HideoutCallbacks.d.ts +++ b/types/callbacks/HideoutCallbacks.d.ts @@ -1,7 +1,9 @@ import { HideoutController } from "../controllers/HideoutController"; import { OnUpdate } from "../di/OnUpdate"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { IHideoutContinousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHandleQTEEventRequestData } from "../models/eft/hideout/IHandleQTEEventRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinuousProductionStartRequestData"; +import { IHideoutImproveAreaRequestData } from "../models/eft/hideout/IHideoutImproveAreaRequestData"; import { IHideoutPutItemInRequestData } from "../models/eft/hideout/IHideoutPutItemInRequestData"; import { IHideoutScavCaseStartRequestData } from "../models/eft/hideout/IHideoutScavCaseStartRequestData"; import { IHideoutSingleProductionStartRequestData } from "../models/eft/hideout/IHideoutSingleProductionStartRequestData"; @@ -10,10 +12,11 @@ import { IHideoutTakeProductionRequestData } from "../models/eft/hideout/IHideou import { IHideoutToggleAreaRequestData } from "../models/eft/hideout/IHideoutToggleAreaRequestData"; import { IHideoutUpgradeCompleteRequestData } from "../models/eft/hideout/IHideoutUpgradeCompleteRequestData"; import { IHideoutUpgradeRequestData } from "../models/eft/hideout/IHideoutUpgradeRequestData"; +import { IRecordShootingRangePoints } from "../models/eft/hideout/IRecordShootingRangePoints"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IHideoutConfig } from "../models/spt/config/IHideoutConfig"; import { ConfigServer } from "../servers/ConfigServer"; -export declare class HideoutCallbacks extends OnUpdate { +export declare class HideoutCallbacks implements OnUpdate { protected hideoutController: HideoutController; protected configServer: ConfigServer; protected hideoutConfig: IHideoutConfig; @@ -21,76 +24,52 @@ export declare class HideoutCallbacks extends OnUpdate { 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; + continuousProductionStart(pmcData: IPmcData, body: IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** * Handle HideoutTakeProduction - * @param pmcData - * @param body - * @param sessionID - * @returns */ takeProduction(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; - onUpdate(timeSinceLastRun: number): boolean; + /** + * Handle HideoutQuickTimeEvent + */ + handleQTEEvent(pmcData: IPmcData, request: IHandleQTEEventRequestData, sessionId: string): IItemEventRouterResponse; + /** + * Handle client/game/profile/items/moving - RecordShootingRangePoints + */ + recordShootingRangePoints(pmcData: IPmcData, request: IRecordShootingRangePoints, sessionId: string): IItemEventRouterResponse; + /** + * Handle client/game/profile/items/moving - RecordShootingRangePoints + */ + improveArea(pmcData: IPmcData, request: IHideoutImproveAreaRequestData, sessionId: string): IItemEventRouterResponse; + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/callbacks/HttpCallbacks.d.ts b/types/callbacks/HttpCallbacks.d.ts index 43928a1..10794fa 100644 --- a/types/callbacks/HttpCallbacks.d.ts +++ b/types/callbacks/HttpCallbacks.d.ts @@ -1,9 +1,9 @@ import { OnLoad } from "../di/OnLoad"; import { HttpServer } from "../servers/HttpServer"; -export declare class HttpCallbacks extends OnLoad { +export declare class HttpCallbacks implements OnLoad { protected httpServer: HttpServer; constructor(httpServer: HttpServer); - onLoad(): void; + onLoad(): Promise; getRoute(): string; getImage(): string; } diff --git a/types/callbacks/InsuranceCallbacks.d.ts b/types/callbacks/InsuranceCallbacks.d.ts index a171e1c..aea0756 100644 --- a/types/callbacks/InsuranceCallbacks.d.ts +++ b/types/callbacks/InsuranceCallbacks.d.ts @@ -10,7 +10,7 @@ import { IInsuranceConfig } from "../models/spt/config/IInsuranceConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { InsuranceService } from "../services/InsuranceService"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -export declare class InsuranceCallbacks extends OnUpdate { +export declare class InsuranceCallbacks implements OnUpdate { protected insuranceController: InsuranceController; protected insuranceService: InsuranceService; protected httpResponse: HttpResponseUtil; @@ -27,6 +27,6 @@ export declare class InsuranceCallbacks extends OnUpdate { * @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/MatchCallbacks.d.ts b/types/callbacks/MatchCallbacks.d.ts index 10fbc44..70a0d60 100644 --- a/types/callbacks/MatchCallbacks.d.ts +++ b/types/callbacks/MatchCallbacks.d.ts @@ -3,14 +3,19 @@ import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { INullResponseData } from "../models/eft/httpResponse/INullResponseData"; +import { IAcceptGroupInviteRequest } from "../models/eft/match/IAcceptGroupInviteRequest"; +import { IAcceptGroupInviteResponse } from "../models/eft/match/IAcceptGroupInviteResponse"; +import { ICancelGroupInviteRequest } from "../models/eft/match/ICancelGroupInviteRequest"; import { ICreateGroupRequestData } from "../models/eft/match/ICreateGroupRequestData"; import { IEndOfflineRaidRequestData } from "../models/eft/match/IEndOfflineRaidRequestData"; import { IGetGroupStatusRequestData } from "../models/eft/match/IGetGroupStatusRequestData"; import { IGetProfileRequestData } from "../models/eft/match/IGetProfileRequestData"; +import { IGetRaidConfigurationRequestData } from "../models/eft/match/IGetRaidConfigurationRequestData"; import { IJoinMatchRequestData } from "../models/eft/match/IJoinMatchRequestData"; import { IJoinMatchResult } from "../models/eft/match/IJoinMatchResult"; import { IPutMetricsRequestData } from "../models/eft/match/IPutMetricsRequestData"; -import { IStartOfflineRaidRequestData } from "../models/eft/match/IStartOffineRaidRequestData"; +import { IRemovePlayerFromGroupRequest } from "../models/eft/match/IRemovePlayerFromGroupRequest"; +import { ISendGroupInviteRequest } from "../models/eft/match/ISendGroupInviteRequest"; import { IUpdatePingRequestData } from "../models/eft/match/IUpdatePingRequestData"; import { DatabaseServer } from "../servers/DatabaseServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; @@ -26,9 +31,12 @@ export declare class MatchCallbacks { exitToMenu(url: string, info: IEmptyRequestData, sessionID: string): INullResponseData; startGroupSearch(url: string, info: IEmptyRequestData, sessionID: string): INullResponseData; stopGroupSearch(url: string, info: IEmptyRequestData, sessionID: string): INullResponseData; - sendGroupInvite(url: string, info: any, sessionID: string): INullResponseData; - acceptGroupInvite(url: string, info: any, sessionID: string): INullResponseData; - cancelGroupInvite(url: string, info: any, sessionID: string): INullResponseData; + sendGroupInvite(url: string, info: ISendGroupInviteRequest, sessionID: string): IGetBodyResponseData; + /** Handle client/match/group/invite/accept */ + acceptGroupInvite(url: string, info: IAcceptGroupInviteRequest, sessionID: string): IGetBodyResponseData; + /** Handle client/match/group/invite/cancel */ + cancelGroupInvite(url: string, info: ICancelGroupInviteRequest, sessionID: string): IGetBodyResponseData; + cancelAllGroupInvite(url: string, info: any, sessionID: string): INullResponseData; putMetrics(url: string, info: IPutMetricsRequestData, sessionID: string): INullResponseData; getProfile(url: string, info: IGetProfileRequestData, sessionID: string): IGetBodyResponseData; serverAvailable(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData | IGetBodyResponseData; @@ -41,6 +49,7 @@ export declare class MatchCallbacks { getGroupStatus(url: string, info: IGetGroupStatusRequestData, sessionID: string): IGetBodyResponseData; createGroup(url: string, info: ICreateGroupRequestData, sessionID: string): IGetBodyResponseData; deleteGroup(url: string, info: any, sessionID: string): INullResponseData; - startOfflineRaid(url: string, info: IStartOfflineRaidRequestData, sessionID: string): INullResponseData; + removePlayerFromGroup(url: string, info: IRemovePlayerFromGroupRequest, sessionID: string): INullResponseData; endOfflineRaid(url: string, info: IEndOfflineRaidRequestData, sessionID: string): INullResponseData; + getRaidConfiguration(url: string, info: IGetRaidConfigurationRequestData, sessionID: string): INullResponseData; } diff --git a/types/callbacks/ModCallbacks.d.ts b/types/callbacks/ModCallbacks.d.ts index aec2f59..d1ec7f7 100644 --- a/types/callbacks/ModCallbacks.d.ts +++ b/types/callbacks/ModCallbacks.d.ts @@ -3,20 +3,19 @@ import { PostAkiModLoader } from "../loaders/PostAkiModLoader"; import { IHttpConfig } from "../models/spt/config/IHttpConfig"; 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 { +declare class ModCallbacks implements OnLoad { protected logger: ILogger; protected httpResponse: HttpResponseUtil; protected httpFileUtil: HttpFileUtil; protected postAkiModLoader: PostAkiModLoader; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected httpConfig: IHttpConfig; - constructor(logger: ILogger, httpResponse: HttpResponseUtil, httpFileUtil: HttpFileUtil, 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; - getBundle(url: string, info: any, sessionID: string): string; } export { ModCallbacks }; diff --git a/types/callbacks/PresetCallbacks.d.ts b/types/callbacks/PresetCallbacks.d.ts index 4553f8f..37bf4e8 100644 --- a/types/callbacks/PresetCallbacks.d.ts +++ b/types/callbacks/PresetCallbacks.d.ts @@ -1,8 +1,8 @@ import { PresetController } from "../controllers/PresetController"; import { OnLoad } from "../di/OnLoad"; -export declare class PresetCallbacks extends OnLoad { +export declare class PresetCallbacks implements OnLoad { protected presetController: PresetController; constructor(presetController: PresetController); - onLoad(): void; + onLoad(): Promise; getRoute(): string; } diff --git a/types/callbacks/ProfileCallbacks.d.ts b/types/callbacks/ProfileCallbacks.d.ts index 183bb0a..9a5848e 100644 --- a/types/callbacks/ProfileCallbacks.d.ts +++ b/types/callbacks/ProfileCallbacks.d.ts @@ -5,6 +5,7 @@ import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyRespons import { INullResponseData } from "../models/eft/httpResponse/INullResponseData"; import { IGetMiniProfileRequestData } from "../models/eft/launcher/IGetMiniProfileRequestData"; import { GetProfileStatusResponseData } from "../models/eft/profile/GetProfileStatusResponseData"; +import { IGetProfileSettingsRequest } from "../models/eft/profile/IGetProfileSettingsRequest"; import { IProfileChangeNicknameRequestData } from "../models/eft/profile/IProfileChangeNicknameRequestData"; import { IProfileChangeVoiceRequestData } from "../models/eft/profile/IProfileChangeVoiceRequestData"; import { IProfileCreateRequestData } from "../models/eft/profile/IProfileCreateRequestData"; @@ -64,6 +65,7 @@ export declare class ProfileCallbacks { * @returns */ getProfileStatus(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; + getProfileSettings(url: string, info: IGetProfileSettingsRequest, sessionId: string): IGetBodyResponseData; searchFriend(url: string, info: ISearchFriendRequestData, sessionID: string): IGetBodyResponseData; getMiniProfile(url: string, info: IGetMiniProfileRequestData, sessionID: string): string; getAllMiniProfiles(url: string, info: any, sessionID: string): string; diff --git a/types/callbacks/RagfairCallbacks.d.ts b/types/callbacks/RagfairCallbacks.d.ts index 37f3807..97713e7 100644 --- a/types/callbacks/RagfairCallbacks.d.ts +++ b/types/callbacks/RagfairCallbacks.d.ts @@ -1,5 +1,6 @@ +import { OnLoad } from "../di/OnLoad"; +import { OnUpdate } from "../di/OnUpdate"; import { RagfairController } from "../controllers/RagfairController"; -import { OnLoadOnUpdate } from "../di/OnLoadOnUpdate"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; import { IPmcData } from "../models/eft/common/IPmcData"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; @@ -14,7 +15,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"; @@ -22,23 +22,26 @@ import { JsonUtil } from "../utils/JsonUtil"; /** * Handle ragfair related callback events */ -export declare class RagfairCallbacks extends OnLoadOnUpdate { +export declare class RagfairCallbacks implements OnLoad, OnUpdate { 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>; 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; + /** + * Handle /client/items/prices + * Called when clicking an item to list on flea + */ + getFleaPrices(url: string, request: IEmptyRequestData, sessionID: string): IGetBodyResponseData>; + onUpdate(timeSinceLastRun: number): Promise; sendReport(url: string, info: ISendRagfairReportRequestData, sessionID: string): INullResponseData; } diff --git a/types/callbacks/SaveCallbacks.d.ts b/types/callbacks/SaveCallbacks.d.ts index bbb6e53..1997f46 100644 --- a/types/callbacks/SaveCallbacks.d.ts +++ b/types/callbacks/SaveCallbacks.d.ts @@ -1,9 +1,14 @@ -import { OnLoadOnUpdate } from "../di/OnLoadOnUpdate"; +import { OnLoad } from "../di/OnLoad"; +import { OnUpdate } from "../di/OnUpdate"; +import { ICoreConfig } from "../models/spt/config/ICoreConfig"; +import { ConfigServer } from "../servers/ConfigServer"; import { SaveServer } from "../servers/SaveServer"; -export declare class SaveCallbacks extends OnLoadOnUpdate { +export declare class SaveCallbacks implements OnLoad, OnUpdate { protected saveServer: SaveServer; - constructor(saveServer: SaveServer); - onLoad(): void; + protected configServer: ConfigServer; + protected coreConfig: ICoreConfig; + constructor(saveServer: SaveServer, configServer: ConfigServer); + onLoad(): Promise; getRoute(): string; - onUpdate(secondsSinceLastRun: number): boolean; + onUpdate(secondsSinceLastRun: number): Promise; } diff --git a/types/callbacks/TradeCallbacks.d.ts b/types/callbacks/TradeCallbacks.d.ts index 272ae46..4291da8 100644 --- a/types/callbacks/TradeCallbacks.d.ts +++ b/types/callbacks/TradeCallbacks.d.ts @@ -6,6 +6,9 @@ import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRag export declare class TradeCallbacks { protected tradeController: TradeController; constructor(tradeController: TradeController); + /** + * Handle client/game/profile/items/moving TradingConfirm + */ processTrade(pmcData: IPmcData, body: IProcessBaseTradeRequestData, sessionID: string): IItemEventRouterResponse; processRagfairTrade(pmcData: IPmcData, body: IProcessRagfairTradeRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/callbacks/TraderCallbacks.d.ts b/types/callbacks/TraderCallbacks.d.ts index 40a1455..1e75add 100644 --- a/types/callbacks/TraderCallbacks.d.ts +++ b/types/callbacks/TraderCallbacks.d.ts @@ -1,22 +1,18 @@ +import { OnLoad } from "../di/OnLoad"; +import { OnUpdate } from "../di/OnUpdate"; import { TraderController } from "../controllers/TraderController"; -import { OnLoadOnUpdate } from "../di/OnLoadOnUpdate"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; -import { IBarterScheme, ITraderAssort, ITraderBase } from "../models/eft/common/tables/ITrader"; +import { ITraderAssort, ITraderBase } from "../models/eft/common/tables/ITrader"; import { IGetBodyResponseData } from "../models/eft/httpResponse/IGetBodyResponseData"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -export declare class TraderCallbacks extends OnLoadOnUpdate { +export declare class TraderCallbacks implements OnLoad, OnUpdate { 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/context/ApplicationContext.d.ts b/types/context/ApplicationContext.d.ts index a155bcd..0a81be0 100644 --- a/types/context/ApplicationContext.d.ts +++ b/types/context/ApplicationContext.d.ts @@ -3,6 +3,17 @@ 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 activePlayerSessionId = this.applicationContext.getLatestValue(ContextVariableType.SESSION_ID).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 a7dd9b5..49f3267 100644 --- a/types/context/ContextVariableType.d.ts +++ b/types/context/ContextVariableType.d.ts @@ -2,7 +2,9 @@ export declare enum ContextVariableType { /** Logged in users session id */ SESSION_ID = 0, /** Currently acive raid information */ - MATCH_INFO = 1, + RAID_CONFIGURATION = 1, /** Timestamp when client first connected */ - CLIENT_START_TIMESTAMP = 2 + 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 92317c3..eebe85f 100644 --- a/types/controllers/BotController.d.ts +++ b/types/controllers/BotController.d.ts @@ -2,7 +2,7 @@ import { ApplicationContext } from "../context/ApplicationContext"; import { BotGenerator } from "../generators/BotGenerator"; import { BotDifficultyHelper } from "../helpers/BotDifficultyHelper"; import { BotHelper } from "../helpers/BotHelper"; -import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; +import { ProfileHelper } from "../helpers/ProfileHelper"; import { IGenerateBotsRequestData } from "../models/eft/bot/IGenerateBotsRequestData"; import { IBotBase } from "../models/eft/common/tables/IBotBase"; import { IBotCore } from "../models/eft/common/tables/IBotCore"; @@ -13,6 +13,7 @@ import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { BotGenerationCacheService } from "../services/BotGenerationCacheService"; import { LocalisationService } from "../services/LocalisationService"; +import { MatchBotDetailsCacheService } from "../services/MatchBotDetailsCacheService"; import { JsonUtil } from "../utils/JsonUtil"; export declare class BotController { protected logger: ILogger; @@ -21,20 +22,25 @@ export declare class BotController { protected botHelper: BotHelper; protected botDifficultyHelper: BotDifficultyHelper; protected botGenerationCacheService: BotGenerationCacheService; + protected matchBotDetailsCacheService: MatchBotDetailsCacheService; protected localisationService: LocalisationService; - protected weightedRandomHelper: WeightedRandomHelper; + protected profileHelper: ProfileHelper; protected configServer: ConfigServer; protected applicationContext: ApplicationContext; protected jsonUtil: JsonUtil; protected botConfig: IBotConfig; static readonly pmcTypeLabel = "PMC"; - constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, botGenerationCacheService: BotGenerationCacheService, localisationService: LocalisationService, weightedRandomHelper: WeightedRandomHelper, configServer: ConfigServer, applicationContext: ApplicationContext, jsonUtil: JsonUtil); + constructor(logger: ILogger, databaseServer: DatabaseServer, botGenerator: BotGenerator, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, botGenerationCacheService: BotGenerationCacheService, matchBotDetailsCacheService: MatchBotDetailsCacheService, localisationService: LocalisationService, 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 @@ -51,6 +57,12 @@ export declare class BotController { * @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 diff --git a/types/controllers/CustomizationController.d.ts b/types/controllers/CustomizationController.d.ts index 5fe51e3..e08a91b 100644 --- a/types/controllers/CustomizationController.d.ts +++ b/types/controllers/CustomizationController.d.ts @@ -1,22 +1,49 @@ import { ProfileHelper } from "../helpers/ProfileHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { ISuit } from "../models/eft/common/tables/ITrader"; -import { IBuyClothingRequestData } from "../models/eft/customization/IBuyClothingRequestData"; +import { ClothingItem, IBuyClothingRequestData } from "../models/eft/customization/IBuyClothingRequestData"; import { IWearClothingRequestData } from "../models/eft/customization/IWearClothingRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { ILogger } from "../models/spt/utils/ILogger"; 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 eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected saveServer: SaveServer; + protected localisationService: LocalisationService; protected profileHelper: ProfileHelper; - constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, 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; + wearClothing(pmcData: IPmcData, wearClothingRequest: IWearClothingRequestData, sessionID: string): IItemEventRouterResponse; + buyClothing(pmcData: IPmcData, buyClothingRequest: IBuyClothingRequestData, sessionId: string): IItemEventRouterResponse; + protected getTraderClothingOffer(sessionId: string, offerId: string): ISuit; + /** + * Has an outfit been purchased by a player + * @param suitId clothing id + * @param sessionID Session id + * @returns true/false + */ + protected outfitAlreadyPurchased(suitId: string, sessionID: string): boolean; + /** + * Update output object and player profile with purchase details + * @param sessionId Session id + * @param pmcData Player profile + * @param clothingItems Clothing purchased + * @param output Client response + */ + protected payForClothingItems(sessionId: string, pmcData: IPmcData, clothingItems: ClothingItem[], output: IItemEventRouterResponse): void; + /** + * Update output object and player profile with purchase details for single piece of clothing + * @param sessionId Session id + * @param pmcData Player profile + * @param clothingItem Clothing item purchased + * @param output Client response + * @returns + */ + protected payForClothingItem(sessionId: string, pmcData: IPmcData, clothingItem: ClothingItem, output: IItemEventRouterResponse): void; protected getAllTraderSuits(sessionID: string): ISuit[]; } diff --git a/types/controllers/DialogueController.d.ts b/types/controllers/DialogueController.d.ts index 9c8b728..577375d 100644 --- a/types/controllers/DialogueController.d.ts +++ b/types/controllers/DialogueController.d.ts @@ -2,7 +2,7 @@ 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 { DialogueInfo, Message } from "../models/eft/profile/IAkiProfile"; +import { DialogueInfo, IAkiProfile, IUserDialogInfo, Message } from "../models/eft/profile/IAkiProfile"; import { SaveServer } from "../servers/SaveServer"; import { TimeUtil } from "../utils/TimeUtil"; export declare class DialogueController { @@ -27,6 +27,7 @@ export declare class DialogueController { */ 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 @@ -34,6 +35,7 @@ export declare class DialogueController { * @returns IGetMailDialogViewResponseData object */ generateDialogueView(dialogueID: string, sessionID: string): IGetMailDialogViewResponseData; + protected getProfilesForMail(pmcProfile: IAkiProfile, dialogUsers: IUserDialogInfo[]): IUserDialogInfo[]; /** * Get a count of messages with attachments from a particular dialog * @param sessionID Session id @@ -71,8 +73,20 @@ export declare class DialogueController { */ protected getMessagesWithAttachments(messages: Message[]): Message[]; /** - * Delete expired items. triggers when updating traders. - * @param sessionID Session id + * Delete expired items from all messages in player profile. triggers when updating traders. + * @param sessionId Session id */ - protected removeExpiredItems(sessionID: string): void; + protected removeExpiredItemsFromMessages(sessionId: string): void; + /** + * Removes expired items from a message in player profile + * @param sessionId Session id + * @param dialogueId Dialog id + */ + protected removeExpiredItemsFromMessage(sessionId: string, dialogueId: string): void; + /** + * Has a dialog message expired + * @param message Message to check expiry of + * @returns true or false + */ + protected messageHasExpired(message: Message): boolean; } diff --git a/types/controllers/GameController.d.ts b/types/controllers/GameController.d.ts index f4f5849..739c48b 100644 --- a/types/controllers/GameController.d.ts +++ b/types/controllers/GameController.d.ts @@ -1,59 +1,89 @@ import { ApplicationContext } from "../context/ApplicationContext"; -import { GameEventHelper } from "../helpers/GameEventHelper"; +import { HideoutHelper } from "../helpers/HideoutHelper"; import { HttpServerHelper } from "../helpers/HttpServerHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; +import { PreAkiModLoader } from "../loaders/PreAkiModLoader"; import { IEmptyRequestData } from "../models/eft/common/IEmptyRequestData"; -import { Config } from "../models/eft/common/IGlobals"; +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 { ISeasonalEvent } from "../models/spt/config/ISeasonalEventConfig"; +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 { LocaleService } from "../services/LocaleService"; +import { CustomLocationWaveService } from "../services/CustomLocationWaveService"; import { LocalisationService } from "../services/LocalisationService"; +import { OpenZoneService } from "../services/OpenZoneService"; import { ProfileFixerService } from "../services/ProfileFixerService"; -import { Watermark } from "../utils/Watermark"; +import { SeasonalEventService } from "../services/SeasonalEventService"; +import { JsonUtil } from "../utils/JsonUtil"; +import { TimeUtil } from "../utils/TimeUtil"; export declare class GameController { protected logger: ILogger; protected databaseServer: DatabaseServer; - protected watermark: Watermark; + protected jsonUtil: JsonUtil; + protected timeUtil: TimeUtil; + protected preAkiModLoader: PreAkiModLoader; protected httpServerHelper: HttpServerHelper; - protected localeService: LocaleService; + protected hideoutHelper: HideoutHelper; protected profileHelper: ProfileHelper; protected profileFixerService: ProfileFixerService; protected localisationService: LocalisationService; - protected gameEventHelper: GameEventHelper; + protected customLocationWaveService: CustomLocationWaveService; + protected openZoneService: OpenZoneService; + protected seasonalEventService: SeasonalEventService; protected applicationContext: ApplicationContext; protected configServer: ConfigServer; protected httpConfig: IHttpConfig; protected coreConfig: ICoreConfig; - constructor(logger: ILogger, databaseServer: DatabaseServer, watermark: Watermark, httpServerHelper: HttpServerHelper, localeService: LocaleService, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, localisationService: LocalisationService, gameEventHelper: GameEventHelper, applicationContext: ApplicationContext, configServer: ConfigServer); + protected locationConfig: ILocationConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, jsonUtil: JsonUtil, timeUtil: TimeUtil, preAkiModLoader: PreAkiModLoader, httpServerHelper: HttpServerHelper, hideoutHelper: HideoutHelper, profileHelper: ProfileHelper, profileFixerService: ProfileFixerService, localisationService: LocalisationService, customLocationWaveService: CustomLocationWaveService, openZoneService: OpenZoneService, seasonalEventService: SeasonalEventService, applicationContext: ApplicationContext, configServer: ConfigServer); gameStart(_url: string, _info: IEmptyRequestData, sessionID: string, startTimeStampMS: number): void; /** - * Check if current date falls inside any of the seasons events pased in, if so, handle them - * @param seasonalEvents events to check for + * BSG have two values for shotgun dispersion, we make sure both have the same value */ - protected checkForAndEnableSeasonalEvents(seasonalEvents: ISeasonalEvent[]): void; + protected fixShotgunDispersions(): 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 + * Players set botReload to a high value and don't expect the crazy fast reload speeds, give them a warn about it + * @param pmcProfile Player profile */ - protected updateGlobalEvents(globalConfig: Config, eventName: string): void; + protected warnOnActiveBotReloadSkill(pmcProfile: IPmcData): 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 + * When player logs in, iterate over all active effects and reduce timer + * TODO - add body part HP regen + * @param pmcProfile */ - protected addEventGearToScavs(eventName: string): void; + protected updateProfileHealthValues(pmcProfile: IPmcData): void; /** - * Set Khorovod(dancing tree) chance to 100% on all maps that support it + * Waves with an identical min/max values spawn nothing, the number of bots that spawn is the difference between min and max */ - protected enableDancingTree(): void; + protected fixBrokenOfflineMapWaves(): void; + /** + * Make Rogues spawn later to allow for scavs to spawn first instead of rogues filling up all spawn positions + */ + protected fixRoguesSpawningInstantlyOnLighthouse(): void; + /** + * Find and split waves with large numbers of bots into smaller waves - BSG appears to reduce the size of these waves to one bot when they're waiting to spawn for too long + */ + protected splitBotWavesIntoSingleWaves(): 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 */ @@ -61,6 +91,6 @@ export declare class GameController { protected logProfileDetails(fullProfile: IAkiProfile): void; getGameConfig(sessionID: string): IGameConfigResponse; getServer(): IServerDetails[]; - protected addPumpkinsToScavBackpacks(): void; + getCurrentGroup(sessionId: any): any; getValidGameVersion(): ICheckVersionResponse; } diff --git a/types/controllers/HealthController.d.ts b/types/controllers/HealthController.d.ts index ce67993..7c149cc 100644 --- a/types/controllers/HealthController.d.ts +++ b/types/controllers/HealthController.d.ts @@ -1,23 +1,28 @@ -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 { IWorkoutData } from "../models/eft/health/IWorkoutData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; -import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ILogger } from "../models/spt/utils/ILogger"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { LocalisationService } from "../services/LocalisationService"; +import { PaymentService } from "../services/PaymentService"; +import { JsonUtil } from "../utils/JsonUtil"; export declare class HealthController { protected logger: ILogger; + protected jsonUtil: JsonUtil; protected eventOutputHolder: EventOutputHolder; protected itemHelper: ItemHelper; protected paymentService: PaymentService; protected inventoryHelper: InventoryHelper; + protected localisationService: LocalisationService; protected healthHelper: HealthHelper; - constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, itemHelper: ItemHelper, paymentService: PaymentService, inventoryHelper: InventoryHelper, healthHelper: HealthHelper); + constructor(logger: ILogger, jsonUtil: JsonUtil, eventOutputHolder: EventOutputHolder, itemHelper: ItemHelper, paymentService: PaymentService, inventoryHelper: InventoryHelper, localisationService: LocalisationService, healthHelper: HealthHelper); /** * stores in-raid player health * @param pmcData Player profile @@ -25,7 +30,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 @@ -34,13 +39,35 @@ export declare class HealthController { * @returns */ offraidHeal(pmcData: IPmcData, body: IOffraidHealRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Consume food/water outside of a raid + * @param pmcData Player profile + * @param body request Object + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ offraidEat(pmcData: IPmcData, body: IOffraidEatRequestData, sessionID: string): IItemEventRouterResponse; /** * 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; + /** + * applies skills from hideout workout. + * @param pmcData Player profile + * @param info Request data + * @param sessionID + */ + applyWorkoutChanges(pmcData: IPmcData, info: IWorkoutData, sessionId: string): void; + /** + * Iterate over treatment request diff and find effects to remove from player limbs + * @param sessionId + * @param profile Profile to update + * @param treatmentRequest client request + * @param output response to send to client + */ + protected removeEffectsAfterPostRaidHeal(sessionId: string, profile: IPmcData, treatmentRequest: IHealthTreatmentRequestData, output: IItemEventRouterResponse): void; } diff --git a/types/controllers/HideoutController.d.ts b/types/controllers/HideoutController.d.ts index 5b6507b..5a3a273 100644 --- a/types/controllers/HideoutController.d.ts +++ b/types/controllers/HideoutController.d.ts @@ -7,7 +7,9 @@ import { ProfileHelper } from "../helpers/ProfileHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { HideoutArea, Product } from "../models/eft/common/tables/IBotBase"; import { HideoutUpgradeCompleteRequestData } from "../models/eft/hideout/HideoutUpgradeCompleteRequestData"; -import { IHideoutContinousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHandleQTEEventRequestData } from "../models/eft/hideout/IHandleQTEEventRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinuousProductionStartRequestData"; +import { IHideoutImproveAreaRequestData } from "../models/eft/hideout/IHideoutImproveAreaRequestData"; import { IHideoutProduction } from "../models/eft/hideout/IHideoutProduction"; import { IHideoutPutItemInRequestData } from "../models/eft/hideout/IHideoutPutItemInRequestData"; import { IHideoutScavCaseStartRequestData } from "../models/eft/hideout/IHideoutScavCaseStartRequestData"; @@ -16,6 +18,8 @@ import { IHideoutTakeItemOutRequestData } from "../models/eft/hideout/IHideoutTa import { IHideoutTakeProductionRequestData } from "../models/eft/hideout/IHideoutTakeProductionRequestData"; import { IHideoutToggleAreaRequestData } from "../models/eft/hideout/IHideoutToggleAreaRequestData"; import { IHideoutUpgradeRequestData } from "../models/eft/hideout/IHideoutUpgradeRequestData"; +import { IQteData } from "../models/eft/hideout/IQteData"; +import { IRecordShootingRangePoints } from "../models/eft/hideout/IRecordShootingRangePoints"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IHideoutConfig } from "../models/spt/config/IHideoutConfig"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -23,6 +27,7 @@ import { EventOutputHolder } from "../routers/EventOutputHolder"; 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 { HashUtil } from "../utils/HashUtil"; @@ -49,12 +54,28 @@ export declare class HideoutController { protected localisationService: LocalisationService; protected configServer: ConfigServer; protected jsonUtil: JsonUtil; + protected fenceService: FenceService; 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, 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; + 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, fenceService: FenceService); /** + * Start a hideout area upgrade + * @param pmcData Player profile + * @param request upgrade start request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + startUpgrade(pmcData: IPmcData, request: IHideoutUpgradeRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Complete a hideout area upgrade + * @param pmcData Player profile + * @param request Completed upgrade request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + upgradeComplete(pmcData: IPmcData, request: HideoutUpgradeCompleteRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Handle HideoutPutItemsInAreaSlots * Create item in hideout slot item array, remove item from player inventory * @param pmcData Profile data * @param addItemToHideoutRequest reqeust from client to place item in area slot @@ -62,7 +83,14 @@ export declare class HideoutController { * @returns IItemEventRouterResponse object */ putItemsInAreaSlots(pmcData: IPmcData, addItemToHideoutRequest: IHideoutPutItemInRequestData, sessionID: string): IItemEventRouterResponse; - takeItemsFromAreaSlots(pmcData: IPmcData, body: IHideoutTakeItemOutRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Remove item from hideout area and place into player inventory + * @param pmcData Player profile + * @param request Take item out of area request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + takeItemsFromAreaSlots(pmcData: IPmcData, request: IHideoutTakeItemOutRequestData, sessionID: string): IItemEventRouterResponse; /** * Find resource item in hideout area, add copy to player inventory, remove Item from hideout slot * @param sessionID Session id @@ -73,7 +101,21 @@ export declare class HideoutController { * @returns IItemEventRouterResponse response */ protected removeResourceFromArea(sessionID: string, pmcData: IPmcData, removeResourceRequest: IHideoutTakeItemOutRequestData, output: IItemEventRouterResponse, hideoutArea: HideoutArea): IItemEventRouterResponse; - toggleArea(pmcData: IPmcData, body: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Toggle area on/off + * @param pmcData Player profile + * @param request Toggle area request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + toggleArea(pmcData: IPmcData, request: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Start production for an item from hideout area + * @param pmcData Player profile + * @param body Start prodution of single item request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ singleProductionStart(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** * Handles event after clicking 'start' on the scav case hideout page @@ -83,24 +125,96 @@ export declare class HideoutController { * @returns item event router response */ scavCaseProductionStart(pmcData: IPmcData, body: IHideoutScavCaseStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Adjust scav case time based on fence standing + * + * @param pmcData Player profile + * @param productionTime Time to complete scav case in seconds + * @returns Adjusted scav case time in seconds + */ + protected getScavCaseTime(pmcData: IPmcData, productionTime: number): number; /** * Add generated scav case rewards to player profile * @param pmcData player profile to add rewards to * @param rewards reward items to add to profile + * @param recipeId recipe id to save into Production dict */ - protected addScavCaseRewardsToProfile(pmcData: IPmcData, rewards: Product[]): void; - continuousProductionStart(pmcData: IPmcData, body: IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; - takeProduction(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; - protected handleRecipie(sessionID: string, recipe: IHideoutProduction, pmcData: IPmcData, body: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; + protected addScavCaseRewardsToProfile(pmcData: IPmcData, rewards: Product[], recipeId: string): void; + /** + * Start production of continuously created item + * @param pmcData Player profile + * @param request Continious production request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + continuousProductionStart(pmcData: IPmcData, request: IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Take completed item out of hideout area and place into player inventory + * @param pmcData Player profile + * @param request Remove production from area request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + takeProduction(pmcData: IPmcData, request: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Take recipe-type production out of hideout area and place into player inventory + * @param sessionID Session id + * @param recipe Completed recipe of item + * @param pmcData Player profile + * @param request Remove production from area request + * @param output Output object to update + * @returns IItemEventRouterResponse + */ + protected handleRecipe(sessionID: string, recipe: IHideoutProduction, pmcData: IPmcData, request: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; /** * Handles giving rewards stored in player profile to player after clicking 'get rewards' - * @param sessionID - * @param pmcData - * @param body - * @param output - * @returns + * @param sessionID Session id + * @param pmcData Player profile + * @param request Get rewards from scavcase craft request + * @param output Output object to update + * @returns IItemEventRouterResponse + */ + protected handleScavCase(sessionID: string, pmcData: IPmcData, request: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; + /** + * Start area production for item + * @param pmcData Player profile + * @param request Start production request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + registerProduction(pmcData: IPmcData, request: IHideoutSingleProductionStartRequestData | IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Get quick time event list for hideout + * // TODO - implement this + * @param sessionId Session id + * @returns IQteData array + */ + getQteList(sessionId: string): IQteData[]; + /** + * Handle HideoutQuickTimeEvent on client/game/profile/items/moving + * Called after completing workout at gym + * @param sessionId Session id + * @param pmcData Profile to adjust + * @param request QTE result object + */ + handleQTEEventOutcome(sessionId: string, pmcData: IPmcData, request: IHandleQTEEventRequestData): IItemEventRouterResponse; + /** + * Record a high score from the shooting range into a player profiles overallcounters + * @param sessionId Session id + * @param pmcData Profile to update + * @param request shooting range score request + * @returns IItemEventRouterResponse + */ + recordShootingRangePoints(sessionId: string, pmcData: IPmcData, request: IRecordShootingRangePoints): IItemEventRouterResponse; + /** + * Handle client/game/profile/items/moving - HideoutImproveArea + * @param sessionId Session id + * @param pmcData profile to improve area in + * @param request improve area request data + */ + improveArea(sessionId: string, pmcData: IPmcData, request: IHideoutImproveAreaRequestData): IItemEventRouterResponse; + /** + * Function called every x seconds as part of onUpdate event */ - protected handleScavCase(sessionID: string, pmcData: IPmcData, body: IHideoutTakeProductionRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; - registerProduction(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData | IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; update(): void; } diff --git a/types/controllers/InraidController.d.ts b/types/controllers/InraidController.d.ts index 39a6396..23ca135 100644 --- a/types/controllers/InraidController.d.ts +++ b/types/controllers/InraidController.d.ts @@ -1,7 +1,9 @@ +import { ApplicationContext } from "../context/ApplicationContext"; import { PlayerScavGenerator } from "../generators/PlayerScavGenerator"; import { HealthHelper } from "../helpers/HealthHelper"; import { InRaidHelper } from "../helpers/InRaidHelper"; import { ItemHelper } from "../helpers/ItemHelper"; +import { NotificationSendHelper } from "../helpers/NotificationSendHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { QuestHelper } from "../helpers/QuestHelper"; import { TraderHelper } from "../helpers/TraderHelper"; @@ -16,6 +18,9 @@ import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { InsuranceService } from "../services/InsuranceService"; +import { LocaleService } from "../services/LocaleService"; +import { MatchBotDetailsCacheService } from "../services/MatchBotDetailsCacheService"; +import { PmcChatResponseService } from "../services/PmcChatResponseService"; import { JsonUtil } from "../utils/JsonUtil"; import { TimeUtil } from "../utils/TimeUtil"; /** @@ -27,20 +32,25 @@ export declare class InraidController { protected jsonUtil: JsonUtil; protected timeUtil: TimeUtil; protected databaseServer: DatabaseServer; + protected localeService: LocaleService; + protected pmcChatResponseService: PmcChatResponseService; + protected matchBotDetailsCacheService: MatchBotDetailsCacheService; protected questHelper: QuestHelper; protected itemHelper: ItemHelper; protected profileHelper: ProfileHelper; protected playerScavGenerator: PlayerScavGenerator; + protected notificationSendHelper: NotificationSendHelper; protected healthHelper: HealthHelper; 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); + constructor(logger: ILogger, saveServer: SaveServer, jsonUtil: JsonUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, localeService: LocaleService, pmcChatResponseService: PmcChatResponseService, matchBotDetailsCacheService: MatchBotDetailsCacheService, questHelper: QuestHelper, itemHelper: ItemHelper, profileHelper: ProfileHelper, playerScavGenerator: PlayerScavGenerator, notificationSendHelper: NotificationSendHelper, healthHelper: HealthHelper, traderHelper: TraderHelper, insuranceService: InsuranceService, inRaidHelper: InRaidHelper, applicationContext: ApplicationContext, configServer: ConfigServer); /** - * Save locationid to active profiles inraid object + * Save locationId to active profiles inraid object AND app context * @param sessionID Session id * @param info Register player request */ @@ -59,18 +69,18 @@ export declare class InraidController { */ 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 + * Make changes to pmc profile after they've died in raid, + * 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 + * Adjust player characters bodypart hp post-raid * @param postRaidSaveRequest post raid data * @param pmcData player profile */ @@ -87,6 +97,7 @@ export declare class InraidController { * @param offraidData post-raid data of raid */ protected savePlayerScavProgress(sessionID: string, offraidData: ISaveProgressRequestData): void; + protected sendLostInsuranceMessage(sessionID: string): void; /** * Is the player dead after a raid - dead is anything other than "survived" / "runner" * @param statusOnExit exit value from offraidData object diff --git a/types/controllers/InsuranceController.d.ts b/types/controllers/InsuranceController.d.ts index 54f31b5..af6e68d 100644 --- a/types/controllers/InsuranceController.d.ts +++ b/types/controllers/InsuranceController.d.ts @@ -31,13 +31,23 @@ export declare class InsuranceController { protected configServer: ConfigServer; protected insuranceConfig: IInsuranceConfig; 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); + /** + * Process insurance items prior to being given to player in mail + */ processReturn(): void; + /** + * Add insurance to an item + * @param pmcData Player profile + * @param body Insurance request + * @param sessionID Session id + * @returns IItemEventRouterResponse object to send to client + */ insure(pmcData: IPmcData, body: IInsureRequestData, sessionID: string): IItemEventRouterResponse; /** * Calculate insurance cost * @param info request object * @param sessionID session id - * @returns response object to send to client + * @returns IGetInsuranceCostResponseData object to send to client */ cost(info: IGetInsuranceCostRequestData, sessionID: string): IGetInsuranceCostResponseData; } diff --git a/types/controllers/InventoryController.d.ts b/types/controllers/InventoryController.d.ts index e1c08c0..9bc6594 100644 --- a/types/controllers/InventoryController.d.ts +++ b/types/controllers/InventoryController.d.ts @@ -102,6 +102,10 @@ export declare class InventoryController { foldItem(pmcData: IPmcData, body: IInventoryFoldRequestData, sessionID: string): IItemEventRouterResponse; /** * Toggles "Toggleable" items like night vision goggles and face shields. + * @param pmcData player profile + * @param body Toggle request + * @param sessionID Session id + * @returns IItemEventRouterResponse */ toggleItem(pmcData: IPmcData, body: IInventoryToggleRequestData, sessionID: string): IItemEventRouterResponse; /** @@ -112,7 +116,14 @@ export declare class InventoryController { * @returns client response object */ tagItem(pmcData: IPmcData, body: IInventoryTagRequestData, sessionID: string): IItemEventRouterResponse; - bindItem(pmcData: IPmcData, body: IInventoryBindRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Bind an inventory item to the quick access menu at bottom of player screen + * @param pmcData Player profile + * @param bindRequest Reqeust object + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + bindItem(pmcData: IPmcData, bindRequest: IInventoryBindRequestData, sessionID: string): IItemEventRouterResponse; /** * Handles examining an item * @param pmcData player profile @@ -129,12 +140,44 @@ export declare class InventoryController { protected getExaminedItemTpl(body: IInventoryExamineRequestData): string; readEncyclopedia(pmcData: IPmcData, body: IInventoryReadEncyclopediaRequestData, sessionID: string): IItemEventRouterResponse; /** - * Handles sorting of Inventory. + * Handle ApplyInventoryChanges + * Sorts supplied items. + * @param pmcData Player profile + * @param request sort request + * @param sessionID Session id + * @returns IItemEventRouterResponse */ - sortInventory(pmcData: IPmcData, body: IInventorySortRequestData, sessionID: string): IItemEventRouterResponse; - createMapMarker(pmcData: IPmcData, body: IInventoryCreateMarkerRequestData, sessionID: string): IItemEventRouterResponse; - deleteMapMarker(pmcData: IPmcData, body: IInventoryDeleteMarkerRequestData, sessionID: string): IItemEventRouterResponse; - editMapMarker(pmcData: IPmcData, body: IInventoryEditMarkerRequestData, sessionID: string): IItemEventRouterResponse; + sortInventory(pmcData: IPmcData, request: IInventorySortRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Add note to a map + * @param pmcData Player profile + * @param request Add marker request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + createMapMarker(pmcData: IPmcData, request: IInventoryCreateMarkerRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Delete a map marker + * @param pmcData Player profile + * @param request Delete marker request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + deleteMapMarker(pmcData: IPmcData, request: IInventoryDeleteMarkerRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Edit an existing map marker + * @param pmcData Player profile + * @param request Edit marker request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + editMapMarker(pmcData: IPmcData, request: IInventoryEditMarkerRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Strip out characters from note string that are not: letter/numbers/unicode/spaces + * @param mapNoteText Marker text to sanitise + * @returns Sanitised map marker text + */ + protected sanitiseMapMarkerText(mapNoteText: string): string; /** * Handle event fired when a container is unpacked (currently only the halloween pumpkin) * @param pmcData Profile data diff --git a/types/controllers/LauncherController.d.ts b/types/controllers/LauncherController.d.ts index 1af1f56..e8d2311 100644 --- a/types/controllers/LauncherController.d.ts +++ b/types/controllers/LauncherController.d.ts @@ -3,20 +3,28 @@ import { IChangeRequestData } from "../models/eft/launcher/IChangeRequestData"; import { ILoginRequestData } from "../models/eft/launcher/ILoginRequestData"; import { IRegisterData } from "../models/eft/launcher/IRegisterData"; import { Info } from "../models/eft/profile/IAkiProfile"; +import { IConnectResponse } from "../models/eft/profile/IConnectResponse"; import { ICoreConfig } from "../models/spt/config/ICoreConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; +import { LocalisationService } from "../services/LocalisationService"; import { HashUtil } from "../utils/HashUtil"; export declare class LauncherController { protected hashUtil: HashUtil; protected saveServer: SaveServer; protected httpServerHelper: HttpServerHelper; protected databaseServer: DatabaseServer; + protected localisationService: LocalisationService; protected configServer: ConfigServer; protected coreConfig: ICoreConfig; - constructor(hashUtil: HashUtil, saveServer: SaveServer, httpServerHelper: HttpServerHelper, databaseServer: DatabaseServer, configServer: ConfigServer); - connect(): any; + constructor(hashUtil: HashUtil, saveServer: SaveServer, httpServerHelper: HttpServerHelper, databaseServer: DatabaseServer, localisationService: LocalisationService, configServer: ConfigServer); + connect(): IConnectResponse; + /** + * Get descriptive text for each of the profile edtions a player can choose + * @returns + */ + protected getProfileDescriptions(): Record; find(sessionIdKey: string): Info; login(info: ILoginRequestData): string; register(info: IRegisterData): string; diff --git a/types/controllers/LocationController.d.ts b/types/controllers/LocationController.d.ts index b6feba8..bd9815c 100644 --- a/types/controllers/LocationController.d.ts +++ b/types/controllers/LocationController.d.ts @@ -1,9 +1,12 @@ import { LocationGenerator } from "../generators/LocationGenerator"; import { LootGenerator } from "../generators/LootGenerator"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; import { ILocationBase } from "../models/eft/common/ILocationBase"; import { ILocationsGenerateAllResponse } from "../models/eft/common/ILocationsSourceDestinationBase"; +import { AirdropTypeEnum } from "../models/enums/AirdropType"; import { IAirdropConfig } from "../models/spt/config/IAirdropConfig"; import { LootItem } from "../models/spt/services/LootItem"; +import { LootRequest } from "../models/spt/services/LootRequest"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; @@ -14,6 +17,7 @@ import { TimeUtil } from "../utils/TimeUtil"; export declare class LocationController { protected jsonUtil: JsonUtil; protected hashUtil: HashUtil; + protected weightedRandomHelper: WeightedRandomHelper; protected logger: ILogger; protected locationGenerator: LocationGenerator; protected localisationService: LocalisationService; @@ -22,14 +26,29 @@ export declare class LocationController { protected timeUtil: TimeUtil; protected configServer: ConfigServer; protected airdropConfig: IAirdropConfig; - constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, logger: ILogger, locationGenerator: LocationGenerator, localisationService: LocalisationService, lootGenerator: LootGenerator, databaseServer: DatabaseServer, timeUtil: TimeUtil, configServer: ConfigServer); + constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, weightedRandomHelper: WeightedRandomHelper, logger: ILogger, locationGenerator: LocationGenerator, localisationService: LocalisationService, lootGenerator: LootGenerator, databaseServer: DatabaseServer, timeUtil: TimeUtil, configServer: ConfigServer); get(location: string): ILocationBase; generate(name: string): ILocationBase; + /** + * Get all maps base location properties without loot data + * @returns ILocationsGenerateAllResponse + */ generateAll(): ILocationsGenerateAllResponse; /** * Get loot for an airdop container * Generates it randomly based on config/airdrop.json values - * @returns Array of LootItem + * @returns Array of LootItem objects */ getAirdropLoot(): LootItem[]; + /** + * Randomly pick a type of airdrop loot using weighted values from config + * @returns airdrop type value + */ + protected chooseAirdropType(): AirdropTypeEnum; + /** + * Get the configuration for a specific type of airdrop + * @param airdropType Type of airdrop to get settings for + * @returns LootRequest + */ + protected getAirdropLootConfigByType(airdropType: AirdropTypeEnum): LootRequest; } diff --git a/types/controllers/MatchController.d.ts b/types/controllers/MatchController.d.ts index 2b0d150..55e2029 100644 --- a/types/controllers/MatchController.d.ts +++ b/types/controllers/MatchController.d.ts @@ -6,10 +6,9 @@ import { ICreateGroupRequestData } from "../models/eft/match/ICreateGroupRequest import { IEndOfflineRaidRequestData } from "../models/eft/match/IEndOfflineRaidRequestData"; import { IGetGroupStatusRequestData } from "../models/eft/match/IGetGroupStatusRequestData"; import { IGetProfileRequestData } from "../models/eft/match/IGetProfileRequestData"; +import { IGetRaidConfigurationRequestData } from "../models/eft/match/IGetRaidConfigurationRequestData"; 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"; @@ -42,12 +41,37 @@ export declare class MatchController { joinMatch(info: IJoinMatchRequestData, sessionID: string): IJoinMatchResult[]; protected getMatch(location: string): any; getGroupStatus(info: IGetGroupStatusRequestData): any; - startOfflineRaid(info: IStartOfflineRaidRequestData, sessionID: string): void; + /** + * Handle /client/raid/configuration + * @param request + * @param sessionID + */ + startOfflineRaid(request: IGetRaidConfigurationRequestData, sessionID: string): void; /** * Convert a difficulty value from pre-raid screen to a bot difficulty - * @param botDifficulty dropdown difficulty + * @param botDifficulty dropdown difficulty value * @returns bot difficulty */ - protected convertDifficultyDropdownIntoBotDifficulty(botDifficulty: BotDifficulty): string; - endOfflineRaid(info: IEndOfflineRaidRequestData, sessionID: string): void; + protected convertDifficultyDropdownIntoBotDifficulty(botDifficulty: string): string; + endOfflineRaid(info: IEndOfflineRaidRequestData, sessionId: string): void; + /** + * Is extract by car + * @param extractName name of extract + * @returns true if car extract + */ + protected extractWasViaCar(extractName: string): boolean; + /** + * Handle when a player extracts using a car - Add rep to fence + * @param extractName name of the extract used + * @param pmcData Player profile + * @param sessionId Session id + */ + protected handleCarExtract(extractName: string, pmcData: IPmcData, sessionId: string): void; + /** + * Update players fence trader standing value in profile + * @param pmcData Player profile + * @param fenceId Id of fence trader + * @param extractName Name of extract used + */ + protected updateFenceStandingInProfile(pmcData: IPmcData, fenceId: string, extractName: string): void; } diff --git a/types/controllers/ProfileController.d.ts b/types/controllers/ProfileController.d.ts index 8c89a02..03d81d4 100644 --- a/types/controllers/ProfileController.d.ts +++ b/types/controllers/ProfileController.d.ts @@ -1,15 +1,20 @@ import { PlayerScavGenerator } from "../generators/PlayerScavGenerator"; +import { DialogueHelper } from "../helpers/DialogueHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; +import { QuestHelper } from "../helpers/QuestHelper"; import { TraderHelper } from "../helpers/TraderHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IMiniProfile } from "../models/eft/launcher/IMiniProfile"; +import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { IProfileChangeNicknameRequestData } from "../models/eft/profile/IProfileChangeNicknameRequestData"; import { IProfileChangeVoiceRequestData } from "../models/eft/profile/IProfileChangeVoiceRequestData"; import { IProfileCreateRequestData } from "../models/eft/profile/IProfileCreateRequestData"; import { ISearchFriendRequestData } from "../models/eft/profile/ISearchFriendRequestData"; import { ISearchFriendResponse } from "../models/eft/profile/ISearchFriendResponse"; import { IValidateNicknameRequestData } from "../models/eft/profile/IValidateNicknameRequestData"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { ProfileFixerService } from "../services/ProfileFixerService"; @@ -23,13 +28,17 @@ export declare class ProfileController { protected itemHelper: ItemHelper; protected profileFixerService: ProfileFixerService; protected playerScavGenerator: PlayerScavGenerator; + protected eventOutputHolder: EventOutputHolder; protected traderHelper: TraderHelper; + protected dialogueHelper: DialogueHelper; + protected questHelper: QuestHelper; protected profileHelper: ProfileHelper; - constructor(hashUtil: HashUtil, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileFixerService: ProfileFixerService, playerScavGenerator: PlayerScavGenerator, traderHelper: TraderHelper, profileHelper: ProfileHelper); + constructor(hashUtil: HashUtil, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileFixerService: ProfileFixerService, playerScavGenerator: PlayerScavGenerator, eventOutputHolder: EventOutputHolder, traderHelper: TraderHelper, dialogueHelper: DialogueHelper, questHelper: QuestHelper, profileHelper: ProfileHelper); getMiniProfiles(): IMiniProfile[]; getMiniProfile(sessionID: string): any; getCompleteProfile(sessionID: string): IPmcData[]; createProfile(info: IProfileCreateRequestData, sessionID: string): void; + protected givePlayerStartingQuestRewards(profileDetails: IAkiProfile, sessionID: string, response: IItemEventRouterResponse): void; /** * Generate a player scav object * pmc profile MUST exist first before pscav can be generated diff --git a/types/controllers/QuestController.d.ts b/types/controllers/QuestController.d.ts index 842207f..48efeef 100644 --- a/types/controllers/QuestController.d.ts +++ b/types/controllers/QuestController.d.ts @@ -4,7 +4,9 @@ import { ProfileHelper } from "../helpers/ProfileHelper"; 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 { Item } from "../models/eft/common/tables/IItem"; +import { AvailableForConditions, 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"; @@ -15,11 +17,14 @@ 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 httpResponseUtil: HttpResponseUtil; protected eventOutputHolder: EventOutputHolder; protected databaseServer: DatabaseServer; protected itemHelper: ItemHelper; @@ -29,9 +34,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, eventOutputHolder: EventOutputHolder, 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) @@ -41,10 +47,10 @@ export declare class QuestController { getClientQuests(sessionID: string): IQuest[]; /** * Is the quest for the opposite side the player is on - * @param side player side (usec/bear) - * @param questId questId to check + * @param playerSide Player side (usec/bear) + * @param questId QuestId to check */ - protected questIsForOtherSide(side: string, questId: string): boolean; + protected questIsForOtherSide(playerSide: string, questId: string): boolean; /** * Handle the client accepting a quest and starting it * Send starting rewards if any to player and @@ -55,7 +61,23 @@ export declare class QuestController { * @returns client response */ acceptQuest(pmcData: IPmcData, acceptedQuest: IAcceptQuestRequestData, sessionID: string): IItemEventRouterResponse; + /** + * 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 @@ -67,13 +89,20 @@ export declare class QuestController { */ completeQuest(pmcData: IPmcData, body: ICompleteQuestRequestData, sessionID: string): IItemEventRouterResponse; /** - * Send a popup to player on completion of a quest + * Send a popup to player on successful completion of a quest * @param sessionID session id - * @param pmcData player profile - * @param completedQuestId completed quest id - * @param questRewards rewards given to player + * @param pmcData Player profile + * @param completedQuestId Completed quest id + * @param questRewards Rewards given to player */ - protected sendDialogMessageOnQuestComplete(sessionID: string, pmcData: IPmcData, completedQuestId: string, questRewards: Reward[]): void; + protected sendSuccessDialogMessageOnQuestComplete(sessionID: string, pmcData: IPmcData, completedQuestId: string, questRewards: Reward[]): void; + /** + * Look for newly available quests after completing a quest with a requirement to wait x minutes (time-locked) before being available and add data to profile + * @param pmcData Player profile to update + * @param quests Quests to look for wait conditions in + * @param completedQuestId Quest just completed + */ + protected addTimeLockedQuestsToProfile(pmcData: IPmcData, quests: IQuest[], completedQuestId: string): void; /** * Returns a list of quests that should be failed when a quest is completed * @param completedQuestId quest completed id @@ -88,7 +117,30 @@ export declare class QuestController { * @param questsToFail quests to fail */ protected failQuests(sessionID: string, pmcData: IPmcData, questsToFail: IQuest[]): void; - handoverQuest(pmcData: IPmcData, body: IHandoverQuestRequestData, sessionID: string): IItemEventRouterResponse; + /** + * + * @param pmcData Player profile + * @param handoverQuestRequest handover item request + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + handoverQuest(pmcData: IPmcData, handoverQuestRequest: IHandoverQuestRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Show warning to user and write to log that repeatable quest failed a condition check + * @param handoverQuestRequest Quest request + * @param output Response to send to user + * @returns IItemEventRouterResponse + */ + protected showRepeatableQuestInvalidConditionError(handoverQuestRequest: IHandoverQuestRequestData, output: IItemEventRouterResponse): IItemEventRouterResponse; + /** + * Show warning to user and write to log quest item handed over did not match what is required + * @param handoverQuestRequest Quest request + * @param itemHandedOver Non-matching item found + * @param handoverRequirements Quest handover requirements + * @param output Response to send to user + * @returns IItemEventRouterResponse + */ + protected showQuestItemHandoverMatchError(handoverQuestRequest: IHandoverQuestRequestData, itemHandedOver: Item, handoverRequirements: AvailableForConditions, output: IItemEventRouterResponse): IItemEventRouterResponse; /** * Increment a backend counter stored value by an amount, * Create counter if it does not exist diff --git a/types/controllers/RagfairController.d.ts b/types/controllers/RagfairController.d.ts index 95702f2..b94ad20 100644 --- a/types/controllers/RagfairController.d.ts +++ b/types/controllers/RagfairController.d.ts @@ -67,16 +67,16 @@ export declare class RagfairController { protected configServer: ConfigServer; protected ragfairConfig: IRagfairConfig; 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, info: ISearchRequestData): IGetOffersResult; + 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 assorts + * @param traderAssorts Trader assorts * @param pmcProfile Player profile * @returns array of offers */ - protected getOffersForSearchType(searchRequest: ISearchRequestData, itemsToAdd: string[], assorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + 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 @@ -100,8 +100,14 @@ export declare class RagfairController { /** * 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; + /** + * Adjust ragfair offer stack count to match same value as traders assort stack count + * @param offer Flea offer to adjust + */ + protected setTraderOfferStackSize(offer: IRagfairOffer): void; protected isLinkedSearch(info: ISearchRequestData): boolean; protected isRequiredSearch(info: ISearchRequestData): boolean; update(): void; @@ -111,9 +117,38 @@ export declare class RagfairController { * @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; + /** + * List item(s) on flea for sale + * @param pmcData Player profile + * @param offerRequest Flea list creatio offer + * @param sessionID Session id + * @returns IItemEventRouterResponse + */ + addPlayerOffer(pmcData: IPmcData, offerRequest: IAddOfferRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Is the item to be listed on the flea valid + * @param offerRequest Client offer request + * @param errorMessage message to show to player when offer is invalid + * @returns Is offer valid + */ + protected isValidPlayerOfferRequest(offerRequest: IAddOfferRequestData, errorMessage: string): boolean; + /** + * Get the handbook price in roubles for the items being listed + * @param requirements + * @returns Rouble price + */ + protected calculateRequirementsPriceInRub(requirements: Requirement[]): number; + /** + * Using item ids from flea offer request, find corrispnding items from player inventory and return as array + * @param pmcData Player profile + * @param itemIdsFromFleaOfferRequest Ids from request + * @param errorMessage if item is not found, add error message to this parameter + * @returns Array of items from player inventory + */ + protected getItemsToListOnFleaFromInventory(pmcData: IPmcData, itemIdsFromFleaOfferRequest: string[], errorMessage: string): Item[]; createPlayerOffer(profile: IAkiProfile, requirements: Requirement[], items: Item[], sellInOnePiece: boolean, amountToSend: number): IRagfairOffer; getAllFleaPrices(): Record; + getStaticPrices(): Record; removeOffer(offerId: string, sessionID: string): IItemEventRouterResponse; extendOffer(info: IExtendOfferRequestData, sessionID: string): IItemEventRouterResponse; } diff --git a/types/controllers/RepeatableQuestController.d.ts b/types/controllers/RepeatableQuestController.d.ts index 333583b..171062d 100644 --- a/types/controllers/RepeatableQuestController.d.ts +++ b/types/controllers/RepeatableQuestController.d.ts @@ -1,3 +1,4 @@ +import { HandbookHelper } from "../helpers/HandbookHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; @@ -11,7 +12,7 @@ import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IRepeatableQuestChangeRequest } from "../models/eft/quests/IRepeatableQuestChangeRequest"; import { ELocationName } from "../models/enums/ELocationName"; -import { IQuestConfig, IRepeatableQuestConfig } from "../models/spt/config/IQuestConfig"; +import { IEliminationConfig, IQuestConfig, IRepeatableQuestConfig } from "../models/spt/config/IQuestConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { EventOutputHolder } from "../routers/EventOutputHolder"; import { ConfigServer } from "../servers/ConfigServer"; @@ -20,6 +21,7 @@ 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"; @@ -56,6 +58,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,6 +66,7 @@ export declare class RepeatableQuestController { protected presetHelper: PresetHelper; protected profileHelper: ProfileHelper; protected profileFixerService: ProfileFixerService; + protected handbookHelper: HandbookHelper; protected ragfairServerHelper: RagfairServerHelper; protected eventOutputHolder: EventOutputHolder; protected localisationService: LocalisationService; @@ -71,7 +75,7 @@ export declare class RepeatableQuestController { 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, eventOutputHolder: EventOutputHolder, localisationService: LocalisationService, 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, handbookHelper: HandbookHelper, 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. @@ -98,6 +102,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 @@ -106,17 +117,18 @@ export declare class RepeatableQuestController { /** * Just for debug reasons. Draws dailies a random assort of dailies extracted from dumps */ - generateDebugDailies(dailiesPool: any, factory: any, number: any): any; + generateDebugDailies(dailiesPool: any, factory: any, number: number): any; /** * Generates the base object of quest type format given as templates in assets/database/templates/repeatableQuests.json * The templates include Elimination, Completion and Extraction quest types * * @param {string} type quest type: "Elimination", "Completion" or "Extraction" * @param {string} traderId trader from which the quest will be provided + * @param {string} side scav daily or pmc daily/weekly quest * @returns {object} a object which contains the base elements for repeatable quests of the requests type * (needs to be filled with reward and conditions by called to make a valid quest) */ - generateRepeatableTemplate(type: string, traderId: string): IRepeatableQuest; + generateRepeatableTemplate(type: string, traderId: string, side: string): IRepeatableQuest; /** * Generates a valid Exploration quest * @@ -146,6 +158,19 @@ 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; + /** + * Get the relevant elimination config based on the current players PMC level + * @param pmcLevel Level of PMC character + * @param repeatableConfig Main repeatable config + * @returns IEliminationConfig + */ + protected getEliminationConfigByPmcLevel(pmcLevel: number, repeatableConfig: IRepeatableQuestConfig): IEliminationConfig; + /** + * Convert 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 @@ -185,10 +210,11 @@ export declare class RepeatableQuestController { * Used to create a quest pool during each cycle of repeatable quest generation. The pool will be subsequently * narrowed down during quest generation to avoid duplicate quests. Like duplicate extractions or elimination quests * where you have to e.g. kill scavs in same locations. - * - * @returns {object} the quest pool + * @param repeatableConfig main repeatable quest config + * @param pmcLevel level of pmc generating quest pool + * @returns IQuestTypePool */ - generateQuestPool(repeatableConfig: IRepeatableQuestConfig): IQuestTypePool; + generateQuestPool(repeatableConfig: IRepeatableQuestConfig, pmcLevel: number): IQuestTypePool; /** * Generate the reward for a mission. A reward can consist of * - Experience @@ -221,16 +247,17 @@ export declare class RepeatableQuestController { generateRewardItem(tpl: string, value: number, index: number, preset?: any): IReward; debugLogRepeatableQuestIds(pmcData: IPmcData): void; probabilityObjectArray(configArrayInput: ProbabilityObject[]): ProbabilityObjectArray; - changeRepeatableQuest(pmcDataIn: IPmcData, body: IRepeatableQuestChangeRequest, sessionID: string): IItemEventRouterResponse; + changeRepeatableQuest(pmcData: IPmcData, body: IRepeatableQuestChangeRequest, sessionID: string): IItemEventRouterResponse; /** - * Picks rewardable items from items.json. This means they need to fit into the inventory and they shouldn't be keys (debatable) - * @returns a list of rewardable items [[_tpl, itemTemplate],...] + * Picks rewardable items from items.json. This means they need to fit into the inventory and they shouldn't be keys (debatable) + * @param repeatableQuestConfig config file + * @returns a list of rewardable items [[_tpl, itemTemplate],...] */ protected getRewardableItems(repeatableQuestConfig: IRepeatableQuestConfig): [string, ITemplateItem][]; /** * Checks if an id is a valid item. Valid meaning that it's an item that may be a reward * or content of bot loot. Items that are tested as valid may be in a player backpack or stash. - * @param {*} tpl template id of item to check + * @param {string} tpl template id of item to check * @returns boolean: true if item is valid reward */ isValidRewardItem(tpl: string, repeatableQuestConfig: IRepeatableQuestConfig): boolean; diff --git a/types/controllers/TradeController.d.ts b/types/controllers/TradeController.d.ts index 0ed0556..8a0630b 100644 --- a/types/controllers/TradeController.d.ts +++ b/types/controllers/TradeController.d.ts @@ -1,21 +1,34 @@ -import { RagfairServer } from "../servers/RagfairServer"; +import { ItemHelper } from "../helpers/ItemHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { TradeHelper } from "../helpers/TradeHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRagfairTradeRequestData"; -import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { Upd } from "../models/eft/common/tables/IItem"; +import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IProcessBaseTradeRequestData } from "../models/eft/trade/IProcessBaseTradeRequestData"; -import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { IProcessRagfairTradeRequestData } from "../models/eft/trade/IProcessRagfairTradeRequestData"; +import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; +import { ITraderConfig } from "../models/spt/config/ITraderConfig"; import { ILogger } from "../models/spt/utils/ILogger"; +import { EventOutputHolder } from "../routers/EventOutputHolder"; +import { ConfigServer } from "../servers/ConfigServer"; +import { RagfairServer } from "../servers/RagfairServer"; +import { LocalisationService } from "../services/LocalisationService"; +import { HttpResponseUtil } from "../utils/HttpResponseUtil"; declare class TradeController { protected logger: ILogger; protected eventOutputHolder: EventOutputHolder; protected tradeHelper: TradeHelper; + protected itemHelper: ItemHelper; protected profileHelper: ProfileHelper; protected ragfairServer: RagfairServer; - constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, tradeHelper: TradeHelper, profileHelper: ProfileHelper, ragfairServer: RagfairServer); - confirmTrading(pmcData: IPmcData, body: IProcessBaseTradeRequestData, sessionID: string, foundInRaid?: boolean, upd?: Upd): IItemEventRouterResponse; + protected httpResponse: HttpResponseUtil; + protected localisationService: LocalisationService; + protected configServer: ConfigServer; + protected ragfairConfig: IRagfairConfig; + protected traderConfig: ITraderConfig; + constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, tradeHelper: TradeHelper, itemHelper: ItemHelper, profileHelper: ProfileHelper, ragfairServer: RagfairServer, httpResponse: HttpResponseUtil, localisationService: LocalisationService, configServer: ConfigServer); + confirmTrading(pmcData: IPmcData, request: IProcessBaseTradeRequestData, sessionID: string): IItemEventRouterResponse; confirmRagfairTrading(pmcData: IPmcData, body: IProcessRagfairTradeRequestData, sessionID: string): IItemEventRouterResponse; + protected confirmTradingInternal(pmcData: IPmcData, body: IProcessBaseTradeRequestData, sessionID: string, foundInRaid?: boolean, upd?: Upd): IItemEventRouterResponse; } export { TradeController }; diff --git a/types/controllers/TraderController.d.ts b/types/controllers/TraderController.d.ts index d7afe95..007901b 100644 --- a/types/controllers/TraderController.d.ts +++ b/types/controllers/TraderController.d.ts @@ -2,25 +2,25 @@ import { FenceBaseAssortGenerator } from "../generators/FenceBaseAssortGenerator import { ProfileHelper } from "../helpers/ProfileHelper"; import { TraderAssortHelper } from "../helpers/TraderAssortHelper"; import { TraderHelper } from "../helpers/TraderHelper"; -import { IBarterScheme, ITraderAssort, ITraderBase } from "../models/eft/common/tables/ITrader"; +import { ITraderAssort, ITraderBase } from "../models/eft/common/tables/ITrader"; 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 { protected logger: ILogger; protected databaseServer: DatabaseServer; protected traderAssortHelper: TraderAssortHelper; protected profileHelper: ProfileHelper; 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, fenceBaseAssortGenerator: FenceBaseAssortGenerator, jsonUtil: JsonUtil); + constructor(logger: ILogger, databaseServer: DatabaseServer, traderAssortHelper: TraderAssortHelper, profileHelper: ProfileHelper, traderHelper: TraderHelper, 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 @@ -40,7 +40,13 @@ export declare class TraderController { * @returns array if ITraderBase objects */ getAllTraders(sessionID: string): ITraderBase[]; + /** + * Order traders by their traderId (Ttid) + * @param traderA First trader to compare + * @param traderB Second trader to compare + * @returns 1,-1 or 0 + */ + protected sortByTraderId(traderA: ITraderBase, traderB: ITraderBase): number; getTrader(sessionID: string, traderID: string): ITraderBase; getAssort(sessionId: string, traderId: string): ITraderAssort; - getPurchasesData(sessionID: string, traderID: string): Record; } diff --git a/types/controllers/WishlistController.d.ts b/types/controllers/WishlistController.d.ts index 83be4b3..60c4a15 100644 --- a/types/controllers/WishlistController.d.ts +++ b/types/controllers/WishlistController.d.ts @@ -1,7 +1,7 @@ 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"; +import { IWishlistActionData } from "../models/eft/wishlist/IWishlistActionData"; export declare class WishlistController { protected eventOutputHolder: EventOutputHolder; constructor(eventOutputHolder: EventOutputHolder); diff --git a/types/di/OnLoad.d.ts b/types/di/OnLoad.d.ts index 064d07d..a5cdea3 100644 --- a/types/di/OnLoad.d.ts +++ b/types/di/OnLoad.d.ts @@ -1,4 +1,4 @@ -export declare class OnLoad { - onLoad(): void; +export interface OnLoad { + onLoad(): Promise; getRoute(): string; } diff --git a/types/di/OnLoadOnUpdate.d.ts b/types/di/OnLoadOnUpdate.d.ts deleted file mode 100644 index 8bd3dc3..0000000 --- a/types/di/OnLoadOnUpdate.d.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { OnLoad } from "./OnLoad"; -import { OnUpdate } from "./OnUpdate"; -export declare class OnLoadOnUpdate implements OnLoad, OnUpdate { - onUpdate(timeSinceLastRun: number): boolean; - onLoad(): void; - getRoute(): string; -} diff --git a/types/di/OnUpdate.d.ts b/types/di/OnUpdate.d.ts index 7fbbe09..e1ce375 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; +export interface OnUpdate { + onUpdate(timeSinceLastRun: number): Promise; getRoute(): string; } diff --git a/types/generators/BotEquipmentModGenerator.d.ts b/types/generators/BotEquipmentModGenerator.d.ts new file mode 100644 index 0000000..ad44c17 --- /dev/null +++ b/types/generators/BotEquipmentModGenerator.d.ts @@ -0,0 +1,202 @@ +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 { ItemBaseClassService } from "../services/ItemBaseClassService"; +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 itemBaseClassService: ItemBaseClassService; + 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, itemBaseClassService: ItemBaseClassService, 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 template 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 a1ac9ed..5236a12 100644 --- a/types/generators/BotGenerator.d.ts +++ b/types/generators/BotGenerator.d.ts @@ -1,41 +1,40 @@ import { BotDifficultyHelper } from "../helpers/BotDifficultyHelper"; import { BotHelper } from "../helpers/BotHelper"; -import { GameEventHelper } from "../helpers/GameEventHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; 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 { IBaseJsonSkills, IBaseSkill, IBotBase, Info, Health as PmcHealth, Skills as botSkills } from "../models/eft/common/tables/IBotBase"; +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 { SeasonalEventService } from "../services/SeasonalEventService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; import { RandomUtil } from "../utils/RandomUtil"; +import { TimeUtil } from "../utils/TimeUtil"; 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; protected randomUtil: RandomUtil; + protected timeUtil: TimeUtil; protected jsonUtil: JsonUtil; protected profileHelper: ProfileHelper; protected databaseServer: DatabaseServer; protected botInventoryGenerator: BotInventoryGenerator; + protected botLevelGenerator: BotLevelGenerator; protected botEquipmentFilterService: BotEquipmentFilterService; protected weightedRandomHelper: WeightedRandomHelper; protected botHelper: BotHelper; protected botDifficultyHelper: BotDifficultyHelper; - protected gameEventHelper: GameEventHelper; + 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, weightedRandomHelper: WeightedRandomHelper, botHelper: BotHelper, botDifficultyHelper: BotDifficultyHelper, gameEventHelper: GameEventHelper, configServer: ConfigServer); + constructor(logger: ILogger, hashUtil: HashUtil, randomUtil: RandomUtil, timeUtil: TimeUtil, 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 @@ -45,23 +44,12 @@ export declare class BotGenerator { */ generatePlayerScav(sessionId: string, role: string, difficulty: string, botTemplate: IBotType): IBotBase; /** - * Generate an array of bot objects based on a condition for a raid with - * @param sessionId session id - * @param condition request condition - * @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 */ - generateByCondition(sessionId: string, botCountToGenerate: number, difficulty: string, role: string, isPmc: boolean): IBotBase[]; - /** - * Get the PMCs wildSpawnType value - * @param role "usec" / "bear" - * @returns wildSpawnType value as string - */ - protected getPmcRoleByDescription(role: string): string; - /** - * 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 @@ -71,26 +59,24 @@ export declare class BotGenerator { * Create a IBotBase object with equipment/loot/exp etc * @param sessionId Session id * @param bot bots base file - * @param botRole Role bot will use (bear/usec for PMCs) - * @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, botRole: 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 @@ -98,12 +84,19 @@ export declare class BotGenerator { * @returns PmcHealth object */ 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 + * Get a bots skills with randomsied progress value between the min and max values + * @param botSkills Skills that should have their progress value randomised + * @returns */ - protected removeChristmasItemsFromBotInventory(nodeInventory: Inventory): void; + protected generateSkills(botSkills: IBaseJsonSkills): botSkills; + /** + * Randomise the progress value of passed in skills based on the min/max value + * @param skills Skills to randomise + * @param isCommonSkills Are the skills 'common' skills + * @returns Skills with randomised progress values as an array + */ + protected getSkillsWithRandomisedProgressValue(skills: Record, isCommonSkills: boolean): IBaseSkill[]; /** * Generate a random Id for a bot and apply to bots _id and aid value * @param bot bot to update @@ -112,11 +105,12 @@ 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 + * Randomise a bots game version and account category + * Chooses from all the game versions (standard, eod etc) + * Chooses account type (default, Sherpa, etc) + * @param botInfo bot info object to update */ - protected getPMCDifficulty(requestedDifficulty: string): string; + protected getRandomisedGameVersionAndCategory(botInfo: Info): void; /** * Add a side-specific (usec/bear) dogtag item to a bots inventory * @param bot bot to add dogtag to @@ -124,4 +118,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 e1efaf2..63935bb 100644 --- a/types/generators/BotInventoryGenerator.d.ts +++ b/types/generators/BotInventoryGenerator.d.ts @@ -1,15 +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 { @@ -20,22 +23,24 @@ 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, localisationService: LocalisationService, configServer: ConfigServer); + 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 templateInventory bot/x.json data from db - * @param equipmentChances Chances each item will be added to bot - * @param itemGenerationLimitsMinMax item gen limits for bot role + * @param botJsonTemplate Base json db file for the bot having its loot generated * @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, templateInventory: Inventory, equipmentChances: Chances, itemGenerationLimitsMinMax: Generation, botRole: string, isPmc: boolean): PmcInventory; + 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 @@ -47,9 +52,27 @@ export declare class BotInventoryGenerator { * @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): void; - protected generateEquipment(equipmentSlot: string, equipmentPool: Record, modPool: Mods, spawnChances: Chances, botRole: string, inventory: PmcInventory): void; + 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 @@ -58,9 +81,10 @@ export declare class BotInventoryGenerator { * @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): void; + 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 @@ -84,5 +108,5 @@ export declare class BotInventoryGenerator { protected addWeaponAndMagazinesToInventory(sessionId: string, weaponSlot: { slot: EquipmentSlots; shouldSpawn: boolean; - }, templateInventory: Inventory, botInventory: PmcInventory, equipmentChances: Chances, botRole: string, isPmc: boolean, itemGenerationLimitsMinMax: Generation): void; + }, 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 3352a46..c847d4d 100644 --- a/types/generators/BotLootGenerator.d.ts +++ b/types/generators/BotLootGenerator.d.ts @@ -1,10 +1,11 @@ import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper"; import { BotWeaponGeneratorHelper } from "../helpers/BotWeaponGeneratorHelper"; import { HandbookHelper } from "../helpers/HandbookHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; import { Inventory as PmcInventory } from "../models/eft/common/tables/IBotBase"; -import { Chances, Inventory, ItemMinMax, ModsChances } from "../models/eft/common/tables/IBotType"; +import { IBotType, Inventory, ModsChances } from "../models/eft/common/tables/IBotType"; import { Item } from "../models/eft/common/tables/IItem"; -import { ITemplateItem, Props } from "../models/eft/common/tables/ITemplateItem"; +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"; @@ -18,6 +19,7 @@ export declare class BotLootGenerator { protected logger: ILogger; protected hashUtil: HashUtil; protected randomUtil: RandomUtil; + protected itemHelper: ItemHelper; protected databaseServer: DatabaseServer; protected handbookHelper: HandbookHelper; protected botGeneratorHelper: BotGeneratorHelper; @@ -27,8 +29,17 @@ export declare class BotLootGenerator { 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, localisationService: LocalisationService, 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, itemHelper: ItemHelper, 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 botJsonTemplate Base json db file for the bot having its loot generated + * @param isPmc Will bot be a pmc + * @param botRole Role of bot, e.g. asssult + * @param botInventory Inventory to add loot to + * @param botLevel Level of bot + */ + generateLoot(sessionId: string, botJsonTemplate: IBotType, isPmc: boolean, botRole: string, botInventory: PmcInventory, 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 @@ -51,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 @@ -83,19 +94,6 @@ export declare class BotLootGenerator { * @returns true if item has reached spawn limit */ protected itemHasReachedSpawnLimit(itemTemplate: ITemplateItem, botRole: string, isPmc: boolean, limitCount: Record, itemSpawnLimits: Record): boolean; - /** - * Is the item an ammo box - * @param props props of the item to check - * @returns true if item is an ammo box - */ - protected isAmmoBox(props: Props): boolean; - /** - * Create an object that contains the ammo stack for an ammo box - * @param parentId ammo box id - * @param props ammo box props - * @returns Item object - */ - protected createAmmoForAmmoBox(parentId: string, props: Props): Item; /** * Randomise the stack size of a money object, uses different values for pmc or scavs * @param isPmc is this a PMC diff --git a/types/generators/BotWeaponGenerator.d.ts b/types/generators/BotWeaponGenerator.d.ts index 40284ea..3e9fe30 100644 --- a/types/generators/BotWeaponGenerator.d.ts +++ b/types/generators/BotWeaponGenerator.d.ts @@ -12,10 +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; @@ -28,11 +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, localisationService: LocalisationService, 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 @@ -43,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 @@ -62,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 @@ -85,9 +89,10 @@ export declare class BotWeaponGenerator { /** * Checks if all required slots are occupied on a weapon and all it's mods * @param weaponItemArray Weapon + mods + * @param botRole role of bot weapon is for * @returns true if valid */ - protected isWeaponValid(weaponItemArray: Item[]): boolean; + protected isWeaponValid(weaponItemArray: Item[], botRole: string): boolean; /** * Generates extra magazines or bullets (if magazine is internal) and adds them to TacticalVest and Pockets. * Additionally, adds extra bullets to SecuredContainer @@ -97,6 +102,13 @@ export declare class BotWeaponGenerator { * @param botRole The bot type we're getting generating extra mags for */ addExtraMagazinesToInventory(generatedWeaponResult: GenerateWeaponResult, magCounts: MinMax, inventory: PmcInventory, botRole: string): void; + /** + * Add Grendaes for UBGL to bots vest and secure container + * @param weaponMods Weapon array with mods + * @param generatedWeaponResult result of weapon generation + * @param inventory bot inventory to add grenades to + */ + protected addUbglGrenadesToBotInventory(weaponMods: Item[], generatedWeaponResult: GenerateWeaponResult, inventory: PmcInventory): void; /** * Add ammo to the secure container * @param stackCount How many stacks of ammo to add @@ -128,19 +140,27 @@ export declare class BotWeaponGenerator { protected getWeaponCaliber(weaponTemplate: ITemplateItem): string; /** * Fill existing magazines to full, while replacing their contents with specified ammo - * @param weaponMods - * @param magazine - * @param ammoTpl + * @param weaponMods Weapon with children + * @param magazine Magazine item + * @param cartridgeTpl Cartridge to insert into magazine */ - protected fillExistingMagazines(weaponMods: Item[], magazine: Item, ammoTpl: string): void; + protected fillExistingMagazines(weaponMods: Item[], magazine: Item, cartridgeTpl: string): void; + /** + * Add desired ammo tpl as item to weaponmods array, placed as child to UBGL + * @param weaponMods Weapon with children + * @param ubglMod UBGL item + * @param ubglAmmoTpl Grenade ammo tpl + */ + protected fillUbgl(weaponMods: Item[], ubglMod: Item, ubglAmmoTpl: string): void; /** * Add cartridge item to weapon Item array, if it already exists, update - * @param weaponMods Weapon items array to amend + * @param weaponWithMods Weapon items array to amend * @param magazine magazine item details we're adding cartridges to - * @param chosenAmmo cartridge to put into the magazine + * @param chosenAmmoTpl cartridge to put into the magazine * @param newStackSize how many cartridges should go into the magazine + * @param magazineTemplate magazines db template */ - protected addOrUpdateMagazinesChildWithAmmo(weaponMods: Item[], magazine: Item, chosenAmmo: string, newStackSize: number): void; + protected addOrUpdateMagazinesChildWithAmmo(weaponWithMods: Item[], magazine: Item, chosenAmmoTpl: string, magazineTemplate: ITemplateItem): void; /** * Fill each Camora with a bullet * @param weaponMods Weapon mods to find and update camora mod(s) from diff --git a/types/generators/LocationGenerator.d.ts b/types/generators/LocationGenerator.d.ts index cc61dcf..04b1599 100644 --- a/types/generators/LocationGenerator.d.ts +++ b/types/generators/LocationGenerator.d.ts @@ -1,14 +1,15 @@ 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"; -import { ILooseLoot, SpawnpointsForced, SpawnpointTemplate } from "../models/eft/common/ILooseLoot"; +import { ILooseLoot, Spawnpoint, SpawnpointsForced, SpawnpointTemplate } from "../models/eft/common/ILooseLoot"; import { Item } from "../models/eft/common/tables/IItem"; import { IStaticAmmoDetails, IStaticContainerProps, IStaticForcedProps, IStaticLootDetails } from "../models/eft/common/tables/ILootBase"; 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,22 @@ 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); + /** + * Choose loot to put into a static container + * @param containerIn + * @param staticForced + * @param staticLootDist + * @param staticAmmoDist + * @param locationName Name of the map to generate static loot for + * @returns IStaticContainerProps + */ generateContainerLoot(containerIn: IStaticContainerProps, staticForced: IStaticForcedProps[], staticLootDist: Record, staticAmmoDist: Record, locationName: string): IStaticContainerProps; protected getLooseLootMultiplerForLocation(location: string): number; protected getStaticLootMultiplerForLocation(location: string): number; @@ -47,7 +58,28 @@ export declare class LocationGenerator { * Add forced spawn point loot into loot parameter array * @param loot array to add forced loot to * @param forcedSpawnPoints forced loot to add + * @param name of map currently generating forced loot for */ - protected addForcedLoot(loot: SpawnpointTemplate[], forcedSpawnPoints: SpawnpointsForced[]): void; - protected createItem(tpl: string, staticAmmoDist: Record, parentId?: string): IContainerItem; + protected addForcedLoot(loot: SpawnpointTemplate[], forcedSpawnPoints: SpawnpointsForced[], locationName: string): void; + /** + * Create array of item (with child items) and return + * @param chosenComposedKey Key we want to look up items for + * @param spawnPoint Dynamic spawn point item we want will be placed in + * @returns IContainerItem + */ + protected createDynamicLootItem(chosenComposedKey: string, spawnPoint: Spawnpoint): IContainerItem; + /** + * Replace the _id value for base item + all children items parentid value + * @param itemWithChildren Item with mods to update + * @param newId new id to add on chidren of base item + */ + protected reparentItemAndChildren(itemWithChildren: Item[], newId?: string): void; + /** + * Find an item in array by its _tpl, handle differently if chosenTpl is a weapon + * @param items Items array to search + * @param chosenTpl Tpl we want to get item with + * @returns Item object + */ + protected getItemInArray(items: Item[], chosenTpl: string): Item; + protected createStaticLootItem(tpl: string, staticAmmoDist: Record, parentId?: string): IContainerItem; } diff --git a/types/generators/LootGenerator.d.ts b/types/generators/LootGenerator.d.ts index bc0d7ec..565ad32 100644 --- a/types/generators/LootGenerator.d.ts +++ b/types/generators/LootGenerator.d.ts @@ -6,31 +6,34 @@ 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"; +type ItemLimit = { + current: number; + max: number; +}; export declare class LootGenerator { protected logger: ILogger; protected hashUtil: HashUtil; 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 configuration options parameter * @param options parameters to adjust how loot is generated * @returns An array of loot items */ - createRandomloot(options: LootRequest): LootItem[]; + createRandomLoot(options: LootRequest): LootItem[]; /** - * Construct item limit record to hold max and current item count + * Construct item limit record to hold max and current item count for each item type * @param limits limits as defined in config * @returns record, key: item tplId, value: current/max item count allowed */ - protected initItemLimitCounter(limits: Record): Record; + protected initItemLimitCounter(limits: Record): Record; /** * Find a random item in items.json and add to result array * @param items items to choose from @@ -63,3 +66,4 @@ export declare class LootGenerator { max: number; }>, itemBlacklist: string[], result: LootItem[]): boolean; } +export {}; diff --git a/types/generators/PMCLootGenerator.d.ts b/types/generators/PMCLootGenerator.d.ts index b9f2a83..7a258df 100644 --- a/types/generators/PMCLootGenerator.d.ts +++ b/types/generators/PMCLootGenerator.d.ts @@ -1,8 +1,10 @@ import { ItemHelper } from "../helpers/ItemHelper"; +import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { IBotConfig } from "../models/spt/config/IBotConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { ItemFilterService } from "../services/ItemFilterService"; +import { SeasonalEventService } from "../services/SeasonalEventService"; /** * Handle the generation of dynamic PMC loot in pockets and backpacks * and the removal of blacklisted items @@ -12,10 +14,32 @@ export declare class PMCLootGenerator { protected databaseServer: DatabaseServer; protected configServer: ConfigServer; protected itemFilterService: ItemFilterService; + protected seasonalEventService: SeasonalEventService; protected pocketLootPool: string[]; + protected vestLootPool: string[]; protected backpackLootPool: string[]; protected botConfig: IBotConfig; - constructor(itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer, itemFilterService: ItemFilterService); + constructor(itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer, itemFilterService: ItemFilterService, seasonalEventService: SeasonalEventService); + /** + * Create an array of loot items a PMC can have in their pockets + * @returns string array of tpls + */ generatePMCPocketLootPool(): string[]; + /** + * Create an array of loot items a PMC can have in their vests + * @returns string array of tpls + */ + generatePMCVestLootPool(): string[]; + /** + * Check if item has a width/height that lets it fit into a 1x2/2x1 slot + * 1x1 / 1x2 / 2x1 + * @param item Item to check size of + * @returns true if it fits + */ + protected itemFitsInto1By2Slot(item: ITemplateItem): boolean; + /** + * Create an array of loot items a PMC can have in their backpack + * @returns string array of tpls + */ generatePMCBackpackLootPool(): string[]; } diff --git a/types/generators/PlayerScavGenerator.d.ts b/types/generators/PlayerScavGenerator.d.ts index bb2c730..3641268 100644 --- a/types/generators/PlayerScavGenerator.d.ts +++ b/types/generators/PlayerScavGenerator.d.ts @@ -1,4 +1,7 @@ +import { BotGeneratorHelper } from "../helpers/BotGeneratorHelper"; import { BotHelper } from "../helpers/BotHelper"; +import { BotWeaponGeneratorHelper } from "../helpers/BotWeaponGeneratorHelper"; +import { ItemHelper } from "../helpers/ItemHelper"; import { ProfileHelper } from "../helpers/ProfileHelper"; import { IPmcData } from "../models/eft/common/IPmcData"; import { Skills, Stats } from "../models/eft/common/tables/IBotBase"; @@ -10,21 +13,30 @@ 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 { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; +import { RandomUtil } from "../utils/RandomUtil"; import { BotGenerator } from "./BotGenerator"; export declare class PlayerScavGenerator { protected logger: ILogger; + protected randomUtil: RandomUtil; protected databaseServer: DatabaseServer; + protected hashUtil: HashUtil; + protected itemHelper: ItemHelper; + protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + protected botGeneratorHelper: BotGeneratorHelper; protected saveServer: SaveServer; protected profileHelper: ProfileHelper; protected botHelper: BotHelper; 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, randomUtil: RandomUtil, databaseServer: DatabaseServer, hashUtil: HashUtil, itemHelper: ItemHelper, botWeaponGeneratorHelper: BotWeaponGeneratorHelper, botGeneratorHelper: BotGeneratorHelper, 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/RagfairAssortGenerator.d.ts b/types/generators/RagfairAssortGenerator.d.ts index db4811d..630e863 100644 --- a/types/generators/RagfairAssortGenerator.d.ts +++ b/types/generators/RagfairAssortGenerator.d.ts @@ -4,6 +4,7 @@ import { Item } from "../models/eft/common/tables/IItem"; import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { SeasonalEventService } from "../services/SeasonalEventService"; import { HashUtil } from "../utils/HashUtil"; import { JsonUtil } from "../utils/JsonUtil"; export declare class RagfairAssortGenerator { @@ -11,10 +12,11 @@ export declare class RagfairAssortGenerator { protected hashUtil: HashUtil; protected itemHelper: ItemHelper; protected databaseServer: DatabaseServer; + protected seasonalEventService: SeasonalEventService; protected configServer: ConfigServer; protected generatedAssortItems: Item[]; protected ragfairConfig: IRagfairConfig; - constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, configServer: ConfigServer); + constructor(jsonUtil: JsonUtil, hashUtil: HashUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, seasonalEventService: SeasonalEventService, configServer: ConfigServer); /** * Get an array of unique items that can be sold on the flea * @returns array of unique items diff --git a/types/generators/RagfairOfferGenerator.d.ts b/types/generators/RagfairOfferGenerator.d.ts index 23882d2..35fceff 100644 --- a/types/generators/RagfairOfferGenerator.d.ts +++ b/types/generators/RagfairOfferGenerator.d.ts @@ -7,7 +7,7 @@ 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, OfferRequirement } from "../models/eft/ragfair/IRagfairOffer"; -import { IRagfairConfig } from "../models/spt/config/IRagfairConfig"; +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"; @@ -88,13 +88,49 @@ 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 */ generateFleaOffersForTrader(traderID: string): void; - protected getItemCondition(userID: string, items: Item[], itemDetails: ITemplateItem): Item[]; + /** + * Get array of an item with its mods + condition properties (e.g durability) + * Apply randomisation adjustments to condition if item base is found in ragfair.json/dynamic/condition + * @param userID id of owner of item + * @param itemWithMods Item and mods, get condition of first item (only first array item is used) + * @param itemDetails db details of first item + * @returns + */ + protected getItemCondition(userID: string, itemWithMods: Item[], itemDetails: ITemplateItem): Item[]; + /** + * Get the relevant condition id if item tpl matches in ragfair.json/condition + * @param tpl Item to look for matching condition object + * @returns condition id + */ + protected getDynamicConditionIdForTpl(tpl: string): string; + /** + * Alter an items condition based on its item base type + * @param conditionSettingsId also the parentId of item being altered + * @param item Item to adjust condition details of + * @param itemDetails db item details of first item in array + */ + protected randomiseItemCondition(conditionSettingsId: string, item: Item, itemDetails: ITemplateItem): void; + /** + * Adjust an items durability/maxDurability value + * @param item item (weapon/armor) to adjust + * @param multiplier Value to multiple durability by + */ + protected randomiseDurabilityValues(item: Item, multiplier: number): void; /** * Add missing conditions to an item if needed * Durabiltiy for repairable items @@ -102,7 +138,7 @@ export declare class RagfairOfferGenerator { * @param item item to add conditions to * @returns Item with conditions added */ - protected addMissingCondition(item: Item): Item; + protected addMissingConditions(item: Item): Item; /** * Create a barter-based barter scheme, if not possible, fall back to making barter scheme currency based * @param offerItems Items for sale in offer @@ -110,7 +146,7 @@ export declare class RagfairOfferGenerator { */ protected createBarterRequirement(offerItems: Item[]): IBarterScheme[]; /** - * Get an array of flea prices + item tpl, cached in generator class + * Get an array of flea prices + item tpl, cached in generator class inside `allowedFleaPriceItemsForBarter` * @returns array with tpl/price values */ protected getFleaPricesAsArray(): { diff --git a/types/generators/ScavCaseRewardGenerator.d.ts b/types/generators/ScavCaseRewardGenerator.d.ts index 89cb5c8..394eeb0 100644 --- a/types/generators/ScavCaseRewardGenerator.d.ts +++ b/types/generators/ScavCaseRewardGenerator.d.ts @@ -2,7 +2,6 @@ import { ItemHelper } from "../helpers/ItemHelper"; import { Product } from "../models/eft/common/tables/IBotBase"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; import { IHideoutScavCase } from "../models/eft/hideout/IHideoutScavCase"; -import { IHideoutScavCaseStartRequestData } from "../models/eft/hideout/IHideoutScavCaseStartRequestData"; import { IScavCaseConfig } from "../models/spt/config/IScavCaseConfig"; import { RewardCountAndPriceDetails, ScavCaseRewardCountsAndPrices } from "../models/spt/hideout/ScavCaseRewardCountsAndPrices"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -28,21 +27,15 @@ export declare class ScavCaseRewardGenerator { constructor(logger: ILogger, randomUtil: RandomUtil, hashUtil: HashUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, ragfairPriceService: RagfairPriceService, itemFilterService: ItemFilterService, configServer: ConfigServer); /** * Create an array of rewards that will be given to the player upon completing their scav case build - * @param body client request + * @param recipeId recipe of the scav case craft * @returns Product array */ - generate(body: IHideoutScavCaseStartRequestData): Product[]; + generate(recipeId: string): Product[]; /** * Get all db items that are not blacklisted in scavcase config * @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/weapongen/implementations/UbglExternalMagGen.d.ts b/types/generators/weapongen/implementations/UbglExternalMagGen.d.ts new file mode 100644 index 0000000..75395be --- /dev/null +++ b/types/generators/weapongen/implementations/UbglExternalMagGen.d.ts @@ -0,0 +1,10 @@ +import { BotWeaponGeneratorHelper } from "../../../helpers/BotWeaponGeneratorHelper"; +import { IInventoryMagGen } from "../IInventoryMagGen"; +import { InventoryMagGen } from "../InventoryMagGen"; +export declare class UbglExternalMagGen implements IInventoryMagGen { + protected botWeaponGeneratorHelper: BotWeaponGeneratorHelper; + constructor(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..bc66b09 100644 --- a/types/helpers/AssortHelper.d.ts +++ b/types/helpers/AssortHelper.d.ts @@ -1,29 +1,43 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { ITraderAssort } from "../models/eft/common/tables/ITrader"; +import { QuestStatus } from "../models/enums/QuestStatus"; 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 - * @param traderId traders id - * @param assort assort items from a trader + * @param traderId traders id the assort belongs to + * @param traderAssorts All assort items from same trader + * @param mergedQuestAssorts Dict of quest assort to quest id unlocks for all traders * @returns assort items minus locked quest assorts */ - stripLockedQuestAssort(pmcProfile: IPmcData, traderId: string, assort: ITraderAssort, flea?: boolean): ITraderAssort; + stripLockedQuestAssort(pmcProfile: IPmcData, traderId: string, traderAssorts: ITraderAssort, mergedQuestAssorts: Record>, flea?: boolean): ITraderAssort; + /** + * Get a quest id + the statuses quest can be in to unlock assort + * @param mergedQuestAssorts quest assorts to search for assort id + * @param assortId Assort to look for linked quest id + * @returns quest id + array of quest status the assort should show for + */ + protected getQuestIdAndStatusThatShowAssort(mergedQuestAssorts: Record>, assortId: string): { + questId: string; + status: QuestStatus[]; + }; /** * Remove assorts from a trader that have not been unlocked yet * @param pmcProfile player profile * @param traderId traders id * @param assort traders assorts - * @returns traders assorts minus locked loyality assorts + * @returns traders assorts minus locked loyalty assorts */ stripLockedLoyaltyAssort(pmcProfile: IPmcData, traderId: string, assort: ITraderAssort): ITraderAssort; /** diff --git a/types/helpers/BotDifficultyHelper.d.ts b/types/helpers/BotDifficultyHelper.d.ts index a58ebdb..df2c269 100644 --- a/types/helpers/BotDifficultyHelper.d.ts +++ b/types/helpers/BotDifficultyHelper.d.ts @@ -20,7 +20,7 @@ export declare class BotDifficultyHelper { 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 type bot type to retrieve difficulty of * @param difficulty difficulty to get settings for (easy/normal etc) * @returns Difficulty object */ diff --git a/types/helpers/BotGeneratorHelper.d.ts b/types/helpers/BotGeneratorHelper.d.ts index 899669e..4eec4dd 100644 --- a/types/helpers/BotGeneratorHelper.d.ts +++ b/types/helpers/BotGeneratorHelper.d.ts @@ -1,214 +1,44 @@ +import { ApplicationContext } from "../context/ApplicationContext"; 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 { LocalisationService } from "../services/LocalisationService"; -import { HashUtil } from "../utils/HashUtil"; 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 applicationContext: ApplicationContext; 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, localisationService: LocalisationService, 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[]; - /** - * @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 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, 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 - * @param equipmentBlacklist equipment not allowed to be used by the bot - * @param botEquipmentRole bot type to generate pool for (e.g. assault, pmcBot, pmc for usec/bear) - */ - generateDynamicModPool(itemDetails: ITemplateItem, modPool: Mods, equipmentBlacklist: EquipmentFilterDetails[], botEquipmentRole: string): 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, botRole: string): 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 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; - /** - * 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[]; + constructor(logger: ILogger, randomUtil: RandomUtil, databaseServer: DatabaseServer, durabilityLimitsHelper: DurabilityLimitsHelper, itemHelper: ItemHelper, applicationContext: ApplicationContext, localisationService: LocalisationService, configServer: ConfigServer); /** * Adds properties to an item * e.g. Repairable / HasHinge / Foldable / MaxDurability * @param itemTemplate Item extra properties are being generated for - * @param botRole Used by weapons to randomise the durability values. Null for non-equipped items + * @param botRole Used by weapons to randomize the durability values. Null for non-equipped items * @returns Item Upd object with extra properties */ 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 @@ -224,22 +54,16 @@ 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 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; - /** - * Can an item be added to an item without issue - * @param items items to check compatiblilities with - * @param tplToCheck tpl of the item to check for incompatibilities + * Can item be added to another item without conflict + * @param items Items to check compatibilities 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 + * @returns false if no incompatibilities, also has incompatibility reason */ - isItemIncompatibleWithCurrentItems(items: Item[], tplToCheck: string, equipmentSlot: string): boolean; + isItemIncompatibleWithCurrentItems(items: Item[], tplToCheck: string, equipmentSlot: string): { + incompatible: boolean; + reason: string; + }; /** * Convert a bots role to the equipment role used in config/bot.json * @param botRole Role to convert diff --git a/types/helpers/BotHelper.d.ts b/types/helpers/BotHelper.d.ts index a7f779e..3b49501 100644 --- a/types/helpers/BotHelper.d.ts +++ b/types/helpers/BotHelper.d.ts @@ -1,5 +1,6 @@ +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"; @@ -22,11 +23,11 @@ export declare class BotHelper { */ getBotTemplate(role: string): IBotType; /** - * Randomise the chance the PMC will attack their own side + * Randomize 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; + randomizePmcHostility(difficultySettings: Difficulty): void; /** * Is the passed in bot role a PMC (usec/bear/pmc) * @param botRole bot role to check @@ -59,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 randomization settings for bot from config/bot.json + * @param botLevel level of bot + * @param botEquipConfig bot equipment json + * @returns RandomisationDetails + */ + getBotRandomizationDetails(botLevel: number, botEquipConfig: EquipmentFilters): RandomisationDetails; + /** + * Choose between sptBear and sptUsec at random based on the % defined in botConfig.pmc.isUsec + * @returns pmc role + */ + getRandomizedPmcRole(): string; + /** + * Get the corresponding 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 randomized PMC side based on bot config value 'isUsec' + * @returns pmc side as string + */ + protected getRandomizedPmcSide(): string; } diff --git a/types/helpers/BotWeaponGeneratorHelper.d.ts b/types/helpers/BotWeaponGeneratorHelper.d.ts index 7e25f56..8a3784b 100644 --- a/types/helpers/BotWeaponGeneratorHelper.d.ts +++ b/types/helpers/BotWeaponGeneratorHelper.d.ts @@ -2,8 +2,10 @@ import { MinMax } from "../models/common/MinMax"; import { Inventory } from "../models/eft/common/tables/IBotBase"; import { Item } from "../models/eft/common/tables/IItem"; import { Grid, ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { EquipmentSlots } from "../models/enums/EquipmentSlots"; 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,21 +18,22 @@ 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 + * Get a randomized number of bullets for a specific magazine * @param magCounts min and max count of magazines * @param magTemplate magazine to generate bullet count for * @returns bullet count number */ - getRandomisedBulletCount(magCounts: MinMax, magTemplate: ITemplateItem): number; + getRandomizedBulletCount(magCounts: MinMax, magTemplate: ITemplateItem): number; /** - * Get a randomised count of magazines + * Get a randomized count of magazines * @param magCounts min and max value returned value can be between - * @returns numberical value of magazine count + * @returns numerical value of magazine count */ - getRandomisedMagazineCount(magCounts: MinMax): number; + getRandomizedMagazineCount(magCounts: MinMax): number; /** * Is this magazine cylinder related (revolvers and grenade launchers) * @param magazineParentName the name of the magazines parent @@ -46,12 +49,13 @@ export declare class BotWeaponGeneratorHelper { */ createMagazine(magazineTpl: string, ammoTpl: string, magTemplate: ITemplateItem): Item[]; /** - * Add a specific number of cartrdiges to a bots inventory (vest/pocket) + * Add a specific number of cartridges to a bots inventory (defaults to vest and pockets) * @param ammoTpl Ammo tpl to add to vest/pockets * @param cartridgeCount number of cartridges to add to vest/pockets * @param inventory bot inventory to add cartridges to + * @param equipmentSlotsToAddTo what equipment slots should bullets be added into */ - addBulletsToVestAndPockets(ammoTpl: string, cartridgeCount: number, inventory: Inventory): void; + addAmmoIntoEquipmentSlots(ammoTpl: string, cartridgeCount: number, inventory: Inventory, equipmentSlotsToAddTo?: EquipmentSlots[]): void; /** * Get a weapons default magazine template id * @param weaponTemplate weapon to get default magazine for @@ -59,12 +63,13 @@ export declare class BotWeaponGeneratorHelper { */ getWeaponsDefaultMagazineTpl(weaponTemplate: ITemplateItem): string; /** - * Adds an item with all its childern into specified equipmentSlots, wherever it fits. - * @param equipmentSlots + * TODO - move into BotGeneratorHelper, this is not the class for it + * Adds an item with all its children into specified equipmentSlots, wherever it fits. + * @param equipmentSlots Slot to add item+children into * @param parentId * @param parentTpl - * @param itemWithChildren - * @param inventory + * @param itemWithChildren Item to add + * @param inventory Inventory to add item+children into * @returns a `boolean` indicating item was added */ addItemWithChildrenToEquipmentSlot(equipmentSlots: string[], parentId: string, parentTpl: string, itemWithChildren: Item[], inventory: Inventory): boolean; diff --git a/types/helpers/DialogueHelper.d.ts b/types/helpers/DialogueHelper.d.ts index 88a726e..1f00e38 100644 --- a/types/helpers/DialogueHelper.d.ts +++ b/types/helpers/DialogueHelper.d.ts @@ -4,6 +4,7 @@ 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"; @@ -15,8 +16,9 @@ export declare class DialogueHelper { protected databaseServer: DatabaseServer; protected notifierHelper: NotifierHelper; protected notificationSendHelper: NotificationSendHelper; + protected localisationService: LocalisationService; protected itemHelper: ItemHelper; - constructor(logger: ILogger, 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. @@ -29,7 +31,7 @@ export declare class DialogueHelper { /** * Get the preview contents of the last message in a dialogue. * @param dialogue - * @returns + * @returns MessagePreview */ getMessagePreview(dialogue: Dialogue): MessagePreview; /** diff --git a/types/helpers/DurabilityLimitsHelper.d.ts b/types/helpers/DurabilityLimitsHelper.d.ts index 07a5db1..7122376 100644 --- a/types/helpers/DurabilityLimitsHelper.d.ts +++ b/types/helpers/DurabilityLimitsHelper.d.ts @@ -9,10 +9,10 @@ export declare class DurabilityLimitsHelper { protected configServer: ConfigServer; protected botConfig: IBotConfig; constructor(randomUtil: RandomUtil, botHelper: BotHelper, configServer: ConfigServer); - getRandomisedMaxWeaponDurability(itemTemplate: ITemplateItem, botRole: string): number; - getRandomisedMaxArmorDurability(itemTemplate: ITemplateItem, botRole: string): number; - getRandomisedWeaponDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; - getRandomisedArmorDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; + getRandomizedMaxWeaponDurability(itemTemplate: ITemplateItem, botRole: string): number; + getRandomizedMaxArmorDurability(itemTemplate: ITemplateItem, botRole: string): number; + getRandomizedWeaponDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; + getRandomizedArmorDurability(itemTemplate: ITemplateItem, botRole: string, maxDurability: number): number; protected generateMaxWeaponDurability(botRole: string): number; protected generateMaxPmcArmorDurability(itemMaxDurability: number): number; protected getLowestMaxWeaponFromConfig(botRole: string): number; @@ -23,4 +23,6 @@ export declare class DurabilityLimitsHelper { protected getMaxWeaponDeltaFromConfig(botRole: string): number; protected getMinArmorDeltaFromConfig(botRole: string): number; protected getMaxArmorDeltaFromConfig(botRole: string): number; + protected getMinArmorLimitPercentFromConfig(botRole: string): number; + protected getMinWeaponLimitPercentFromConfig(botRole: string): number; } diff --git a/types/helpers/GameEventHelper.d.ts b/types/helpers/GameEventHelper.d.ts index fa25eff..f502c95 100644 --- a/types/helpers/GameEventHelper.d.ts +++ b/types/helpers/GameEventHelper.d.ts @@ -1,4 +1,4 @@ -import { ISeasonalEvent, ISeasonalEventConfig } from "../models/spt/config/ISeasonalEventConfig"; +import { ISeasonalEventConfig } from "../models/spt/config/ISeasonalEventConfig"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; export declare class GameEventHelper { @@ -6,24 +6,4 @@ export declare class GameEventHelper { protected configServer: ConfigServer; protected seasonalEventConfig: ISeasonalEventConfig; constructor(databaseServer: DatabaseServer, configServer: ConfigServer); - get events(): Record; - get christmasEventItems(): string[]; - itemIsChristmasRelated(itemId: string): boolean; - christmasEventEnabled(): boolean; - /** - * Get the dates each seasonal event starts and ends - * @returns Record with event name + start/end date - */ - getEventDetails(): ISeasonalEvent[]; - /** - * 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 - */ - getEventBotGear(eventName: string): Record>>; } diff --git a/types/helpers/HandbookHelper.d.ts b/types/helpers/HandbookHelper.d.ts index 1ab7800..dd9ce09 100644 --- a/types/helpers/HandbookHelper.d.ts +++ b/types/helpers/HandbookHelper.d.ts @@ -1,16 +1,17 @@ import { DatabaseServer } from "../servers/DatabaseServer"; -declare class LookupItem { - byId: Record; - byParent: Record; +declare class LookupItem { + readonly byId: Map; + readonly byParent: Map; constructor(); } export declare class LookupCollection { - items: LookupItem; - categories: LookupItem; + readonly items: LookupItem; + readonly categories: LookupItem; constructor(); } export declare class HandbookHelper { protected databaseServer: DatabaseServer; + protected lookupCacheGenerated: boolean; protected handbookPriceCache: LookupCollection; constructor(databaseServer: DatabaseServer); hydrateLookup(): void; @@ -35,18 +36,18 @@ export declare class HandbookHelper { isCategory(category: string): boolean; childrenCategories(x: string): string[]; /** - * Convert currency into roubles - * @param {number} value - * @param {string} currencyFrom - * @returns get rouble value of inputted currency - */ - 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..7a6d41d 100644 --- a/types/helpers/HealthHelper.d.ts +++ b/types/helpers/HealthHelper.d.ts @@ -1,6 +1,6 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { ISyncHealthRequestData } from "../models/eft/health/ISyncHealthRequestData"; -import { IAkiProfile } from "../models/eft/profile/IAkiProfile"; +import { Effects, IAkiProfile } from "../models/eft/profile/IAkiProfile"; import { IHealthConfig } from "../models/spt/config/IHealthConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; @@ -16,7 +16,7 @@ export declare class HealthHelper { protected healthConfig: IHealthConfig; constructor(jsonUtil: JsonUtil, logger: ILogger, timeUtil: TimeUtil, saveServer: SaveServer, configServer: ConfigServer); /** - * Resets the profiles vitality/healh and vitality/effects properties to their defaults + * Resets the profiles vitality/health and vitality/effects properties to their defaults * @param sessionID Session Id * @returns updated profile */ @@ -24,28 +24,34 @@ export declare class HealthHelper { /** * Update player profile with changes from request object * @param pmcData Player profile - * @param info Request object + * @param request Heal request * @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, request: ISyncHealthRequestData, sessionID: string, addEffects?: boolean, deleteExistingEffects?: boolean): void; + /** + * Adjust hydration/energy/temperate and body part hp values in player profile to values in profile.vitality + * @param pmcData Profile to update + * @param sessionId Session id + */ protected saveHealth(pmcData: IPmcData, sessionID: string): void; /** * Save effects to profile * Works by removing all effects and adding them back from profile - * Remoces empty 'Effects' objects if found + * Removes empty 'Effects' objects if found * @param pmcData Player profile - * @param sessionID Session id + * @param sessionId Session id + * @param bodyPartsWithEffects dict of body parts with effects that should be added to profile * @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, bodyPartsWithEffects: Effects, 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 + * @param duration How long the effect has left in seconds (-1 by default, no duration). */ - protected addEffect(pmcData: IPmcData, effectBodyPart: string, effectType: string): void; + protected addEffect(pmcData: IPmcData, effectBodyPart: string, effectType: string, duration?: number): void; protected isEmpty(map: any): boolean; } diff --git a/types/helpers/HideoutHelper.d.ts b/types/helpers/HideoutHelper.d.ts index 9d51fed..fed487c 100644 --- a/types/helpers/HideoutHelper.d.ts +++ b/types/helpers/HideoutHelper.d.ts @@ -1,10 +1,12 @@ import { IPmcData } from "../models/eft/common/IPmcData"; -import { Common, HideoutArea, Production, Productive } from "../models/eft/common/tables/IBotBase"; +import { Common, HideoutArea, IHideoutImprovement, Production, Productive } from "../models/eft/common/tables/IBotBase"; import { Upd } from "../models/eft/common/tables/IItem"; import { StageBonus } from "../models/eft/hideout/IHideoutArea"; -import { IHideoutContinousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../models/eft/hideout/IHideoutContinuousProductionStartRequestData"; +import { IHideoutProduction } from "../models/eft/hideout/IHideoutProduction"; import { IHideoutSingleProductionStartRequestData } from "../models/eft/hideout/IHideoutSingleProductionStartRequestData"; import { IHideoutTakeProductionRequestData } from "../models/eft/hideout/IHideoutTakeProductionRequestData"; +import { IAddItemRequestData } from "../models/eft/inventory/IAddItemRequestData"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IHideoutConfig } from "../models/spt/config/IHideoutConfig"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -15,7 +17,6 @@ import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; import { HashUtil } from "../utils/HashUtil"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; -import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; import { InventoryHelper } from "./InventoryHelper"; import { ProfileHelper } from "./ProfileHelper"; @@ -23,7 +24,6 @@ export declare class HideoutHelper { protected logger: ILogger; protected hashUtil: HashUtil; protected timeUtil: TimeUtil; - protected randomUtil: RandomUtil; protected databaseServer: DatabaseServer; protected eventOutputHolder: EventOutputHolder; protected httpResponse: HttpResponseUtil; @@ -36,11 +36,12 @@ export declare class HideoutHelper { static waterCollector: string; static bitcoin: string; static expeditionaryFuelTank: string; + static maxSkillPoint: number; protected hideoutConfig: IHideoutConfig; - 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; + constructor(logger: ILogger, hashUtil: HashUtil, timeUtil: TimeUtil, databaseServer: DatabaseServer, eventOutputHolder: EventOutputHolder, httpResponse: HttpResponseUtil, profileHelper: ProfileHelper, inventoryHelper: InventoryHelper, playerService: PlayerService, localisationService: LocalisationService, configServer: ConfigServer); + registerProduction(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData | IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; /** - * This convinience function intialies new Production Object + * This convenience function initializes new Production Object * with all the constants. */ initProduction(recipeId: string, productionTime: number): Production; @@ -81,6 +82,26 @@ export declare class HideoutHelper { isGeneratorOn: boolean; waterCollectorHasFilter: boolean; }): void; + /** + * Update a productions progress value based on the amount of time that has passed + * @param pmcData Player profile + * @param prodId Production id being crafted + * @param recipe Recipe data being crafted + * @param hideoutProperties + */ + protected updateProductionProgress(pmcData: IPmcData, prodId: string, recipe: IHideoutProduction, hideoutProperties: { + btcFarmCGs?: number; + isGeneratorOn: boolean; + waterCollectorHasFilter?: boolean; + }): void; + /** + * Check if a productions progress value matches its corresponding recipes production time value + * @param pmcData Player profile + * @param prodId Production id + * @param recipe Recipe being crafted + * @returns progress matches productionTime from recipe + */ + protected doesProgressMatchProductionTime(pmcData: IPmcData, prodId: string): boolean; /** * Update progress timer for scav case * @param pmcData Profile to update @@ -105,19 +126,112 @@ export declare class HideoutHelper { * Adjust water filter objects resourceValue or delete when they reach 0 resource * @param waterFilterArea water filter area to update * @param production production object - * @param isGeneratorOn is generatory enabled + * @param isGeneratorOn is generator enabled * @param pmcData Player profile * @returns Updated HideoutArea object */ protected updateWaterFilters(waterFilterArea: HideoutArea, production: Production, isGeneratorOn: boolean, pmcData: IPmcData): HideoutArea; + /** + * Get the water filter drain rate based on hideout bonues player has + * @param pmcData Player profile + * @returns Drain rate + */ + protected getWaterFilterDrainRate(pmcData: IPmcData): number; + /** + * Get the production time in seconds for the desired production + * @param prodId Id, e.g. Water collector id + * @returns seconds to produce item + */ + protected getProductionTimeSeconds(prodId: string): number; + /** + * Create a upd object using passed in parameters + * @param stackCount + * @param resourceValue + * @param resourceUnitsConsumed + * @returns Upd + */ protected getAreaUpdObject(stackCount: number, resourceValue: number, resourceUnitsConsumed: number): Upd; protected updateAirFilters(airFilterArea: HideoutArea, pmcData: IPmcData): void; protected updateBitcoinFarm(pmcData: IPmcData, btcFarmCGs: number, isGeneratorOn: boolean): Production; + /** + * Add bitcoin object to btc production products array and set progress time + * @param btcProd Bitcoin production object + * @param coinCraftTimeSeconds Time to craft a bitcoin + */ + protected addBtcToProduction(btcProd: Production, coinCraftTimeSeconds: number): void; + /** + * Get number of ticks that have passed since hideout areas were last processed, reduced when generator is off + * @param pmcData Player profile + * @param isGeneratorOn Is the generator on for the duration of elapsed time + * @returns Amount of time elapsed in seconds + */ + protected getTimeElapsedSinceLastServerTick(pmcData: IPmcData, isGeneratorOn: boolean): number; + /** + * Get a count of how many BTC can be gathered by the profile + * @param pmcData Profile to look up + * @returns coin slot count + */ protected getBTCSlots(pmcData: IPmcData): number; + /** + * Get a count of bitcoins player miner can hold + */ protected getManagementSkillsSlots(): number; - protected hasManagementSkillSlots(pmcData: IPmcData): boolean; + /** + * Does profile have elite hideout management skill + * @param pmcData Profile to look at + * @returns True if profile has skill + */ + protected hasEliteHideoutManagementSkill(pmcData: IPmcData): boolean; + /** + * Get the hideout management skill from player profile + * @param pmcData Profile to look at + * @returns Hideout management skill object + */ protected getHideoutManagementSkill(pmcData: IPmcData): Common; protected getHideoutManagementConsumptionBonus(pmcData: IPmcData): number; + /** + * Get the crafting skill details from player profile + * @param pmcData Player profile + * @returns crafting skill, null if not found + */ + protected getCraftingSkill(pmcData: IPmcData): Common; + /** + * Adjust craft time based on crafting skill level found in player profile + * @param pmcData Player profile + * @param productionTime Time to complete hideout craft in seconds + * @returns Adjusted craft time in seconds + */ + protected getCraftingSkillProductionTimeReduction(pmcData: IPmcData, productionTime: number): number; isProduction(productive: Productive): productive is Production; - getBTC(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; + /** + * Gather crafted BTC from hideout area and add to inventory + * Reset production start timestamp if hideout area at full coin capacity + * @param pmcData Player profile + * @param request Take production request + * @param sessionId Session id + * @returns IItemEventRouterResponse + */ + getBTC(pmcData: IPmcData, request: IHideoutTakeProductionRequestData, sessionId: string): IItemEventRouterResponse; + /** + * Create a single bitcoin request object + * @param pmcData Player profile + * @returns IAddItemRequestData + */ + protected createBitcoinRequest(pmcData: IPmcData): IAddItemRequestData; + /** + * Upgrade hideout wall from starting level to interactable level if enough time has passed + * @param pmcProfile Profile to upgrade wall in + */ + unlockHideoutWallInProfile(pmcProfile: IPmcData): void; + /** + * Hideout improvement is flagged as complete + * @param improvement hideout improvement object + * @returns true if complete + */ + protected hideoutImprovementIsComplete(improvement: IHideoutImprovement): boolean; + /** + * Iterate over hideout improvements not completed and check if they need to be adjusted + * @param pmcProfile Profile to adjust + */ + setHideoutImprovementsToCompleted(pmcProfile: IPmcData): void; } diff --git a/types/helpers/InRaidHelper.d.ts b/types/helpers/InRaidHelper.d.ts index 962df38..0de950c 100644 --- a/types/helpers/InRaidHelper.d.ts +++ b/types/helpers/InRaidHelper.d.ts @@ -2,22 +2,35 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { Victim } from "../models/eft/common/tables/IBotBase"; import { Item } from "../models/eft/common/tables/IItem"; import { ISaveProgressRequestData } from "../models/eft/inRaid/ISaveProgressRequestData"; +import { ILostOnDeathConfig } from "../models/spt/config/ILostOnDeathConfig"; import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; 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"; +import { ItemHelper } from "./ItemHelper"; import { PaymentHelper } from "./PaymentHelper"; export declare class InRaidHelper { protected logger: ILogger; protected saveServer: SaveServer; protected jsonUtil: JsonUtil; + protected itemHelper: ItemHelper; 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); + protected configServer: ConfigServer; + protected lostOnDeathConfig: ILostOnDeathConfig; + constructor(logger: ILogger, saveServer: SaveServer, jsonUtil: JsonUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, inventoryHelper: InventoryHelper, paymentHelper: PaymentHelper, localisationService: LocalisationService, profileFixerService: ProfileFixerService, configServer: ConfigServer); + /** + * Should quest items be removed from player inventory on death + * @returns True if items should be removed from inventory + */ + removeQuestItemsOnDeath(): boolean; /** * 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 @@ -31,6 +44,12 @@ export declare class InRaidHelper { * @returns adjusted karma level after kills are taken into account */ calculateFenceStandingChangeFromKills(existingFenceStanding: number, victims: Victim[]): number; + /** + * Get the standing gain/loss for killing an npc + * @param victim Who was killed by player + * @returns a numerical standing gain or loss + */ + protected getStandingChangeForKill(victim: Victim): number; /** * Reset a profile to a baseline, used post-raid * Reset points earned during session property @@ -38,10 +57,16 @@ export declare class InRaidHelper { * Remove Labs keycard * @param profileData Profile to update * @param saveProgressRequest post raid save data request data - * @param sessionID Sessino id + * @param sessionID Session id * @returns Reset profile object */ updateProfileBaseStats(profileData: IPmcData, saveProgressRequest: ISaveProgressRequestData, sessionID: string): IPmcData; + /** + * Take body part effects from client profile and apply to server profile + * @param saveProgressRequest post-raid request + * @param profileData player profile on server + */ + 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 @@ -58,9 +83,9 @@ export declare class InRaidHelper { * Adds SpawnedInSession property to items found in a raid * Removes SpawnedInSession for non-scav players if item was taken into raid with SpawnedInSession = true * @param preRaidProfile profile to update - * @param postRaidProfile profile to upate inventory contents of + * @param postRaidProfile profile to update inventory contents of * @param isPlayerScav Was this a p scav raid - * @returns + * @returns profile with FiR items properly tagged */ addSpawnedInSessionPropertyToItems(preRaidProfile: IPmcData, postRaidProfile: IPmcData, isPlayerScav: boolean): IPmcData; /** @@ -75,7 +100,7 @@ export declare class InRaidHelper { * Remove equipped items from pre-raid * Add new items found in raid to profile * Store insurance items in profile - * @param sessionID + * @param sessionID Session id * @param pmcData Profile to update * @param postRaidProfile Profile returned by client after a raid * @returns Updated profile @@ -86,15 +111,27 @@ export declare class InRaidHelper { * Used post-raid to remove items after death * @param pmcData Player profile * @param sessionID Session id - * @returns Player profile with pmc inventory cleared */ - deleteInventory(pmcData: IPmcData, sessionID: string): IPmcData; + deleteInventory(pmcData: IPmcData, sessionID: string): void; + /** + * Get an array of items from a profile that will be lost on death + * @param pmcProfile Profile to get items from + * @returns Array of items lost on death + */ + protected getInventoryItemsLostOnDeath(pmcProfile: IPmcData): Item[]; + /** + * Get items in vest/pocket/backpack inventory containers (excluding children) + * @param pmcData Player profile + * @returns Item array + */ + protected getBaseItemsInRigPocketAndBackpack(pmcData: IPmcData): Item[]; /** * Does the provided items slotId mean its kept on the player after death - * @param slotId slotid of item to check + * @pmcData Player profile + * @itemToCheck Item to check should be kept * @returns true if item is kept after death */ - isItemKeptAfterDeath(slotId: string): boolean; + protected isItemKeptAfterDeath(pmcData: IPmcData, itemToCheck: Item): boolean; /** * Return the equipped items from a players inventory * @param items Players inventory to search through diff --git a/types/helpers/InventoryHelper.d.ts b/types/helpers/InventoryHelper.d.ts index 6419f93..a2ee699 100644 --- a/types/helpers/InventoryHelper.d.ts +++ b/types/helpers/InventoryHelper.d.ts @@ -1,6 +1,7 @@ import { IPmcData } from "../models/eft/common/IPmcData"; import { Item } from "../models/eft/common/tables/IItem"; -import { IAddItemRequestData } from "../models/eft/inventory/IAddItemRequestData"; +import { AddItem, IAddItemRequestData } from "../models/eft/inventory/IAddItemRequestData"; +import { IAddItemTempObject } from "../models/eft/inventory/IAddItemTempObject"; import { IInventoryMergeRequestData } from "../models/eft/inventory/IInventoryMergeRequestData"; import { IInventoryMoveRequestData } from "../models/eft/inventory/IInventoryMoveRequestData"; import { IInventorySplitRequestData } from "../models/eft/inventory/IInventorySplitRequestData"; @@ -43,11 +44,48 @@ export declare class InventoryHelper { 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, localisationService: LocalisationService, configServer: ConfigServer); - addItem(pmcData: IPmcData, body: IAddItemRequestData, output: IItemEventRouterResponse, sessionID: string, callback: any, foundInRaid?: boolean, addUpd?: any): IItemEventRouterResponse; + /** + * BUG: Passing the same item multiple times with a count of 1 will cause multiples of that item to be added (e.g. x3 separate objects of tar cola with count of 1 = 9 tarcolas being added to inventory) + * @param pmcData Profile to add items to + * @param request request data to add items + * @param output response to send back to client + * @param sessionID Session id + * @param callback Code to execute later (function) + * @param foundInRaid Will results added to inventory be set as found in raid + * @param addUpd Additional upd properties for items being added to inventory + * @returns IItemEventRouterResponse + */ + addItem(pmcData: IPmcData, request: IAddItemRequestData, output: IItemEventRouterResponse, sessionID: string, callback: { + (): void; + }, foundInRaid?: boolean, addUpd?: any): IItemEventRouterResponse; + /** + * Add ammo to ammo boxes + * @param itemToAdd Item to check is ammo box + * @param parentId Ammo box parent id + * @param output IItemEventRouterResponse object + * @param sessionID Session id + * @param pmcData Profile to add ammobox to + */ + protected hydrateAmmoBoxWithAmmo(pmcData: IPmcData, itemToAdd: IAddItemTempObject, parentId: string, sessionID: string, output: IItemEventRouterResponse): void; + /** + * + * @param assortItems Items to add to inventory + * @param requestItem Details of purchased item to add to inventory + * @param result Array split stacks are added to + */ + protected splitStackIntoSmallerStacks(assortItems: Item[], requestItem: AddItem, result: IAddItemTempObject[]): void; + /** + * Remove item from player inventory + * @param pmcData Profile to remove item from + * @param itemId Items id to remove + * @param sessionID Session id + * @param output Existing IItemEventRouterResponse object to append data to, creates new one by default if not supplied + * @returns IItemEventRouterResponse + */ removeItem(pmcData: IPmcData, itemId: string, sessionID: string, output?: IItemEventRouterResponse): IItemEventRouterResponse; removeItemByCount(pmcData: IPmcData, itemId: string, count: number, sessionID: string, output?: IItemEventRouterResponse): IItemEventRouterResponse; - getItemSize(itemTpl: string, itemID: string, inventoryItem: Item[]): Record; - protected getSizeByInventoryItemHash(itemTpl: string, itemID: string, inventoryItemHash: InventoryHelper.InventoryItemHash): Record; + getItemSize(itemTpl: string, itemID: string, inventoryItem: Item[]): number[]; + protected getSizeByInventoryItemHash(itemTpl: string, itemID: string, inventoryItemHash: InventoryHelper.InventoryItemHash): number[]; protected getInventoryItemHash(inventoryItem: Item[]): InventoryHelper.InventoryItemHash; getContainerMap(containerW: number, containerH: number, itemList: Item[], containerId: string): number[][]; /** @@ -73,7 +111,13 @@ export declare class InventoryHelper { /** * Internal helper function to move item within the same profile_f. */ - moveItemInternal(inventoryItems: Item[], body: IInventoryMoveRequestData): void; + moveItemInternal(pmcData: IPmcData, inventoryItems: Item[], moveRequest: IInventoryMoveRequestData): void; + /** + * Update fast panel bindings when an item is moved into a container that doesnt allow quick slot access + * @param pmcData Player profile + * @param itemBeingMoved item being moved + */ + protected updateFastPanelBinding(pmcData: IPmcData, itemBeingMoved: Item): void; /** * Internal helper function to handle cartridges in inventory if any of them exist. */ diff --git a/types/helpers/ItemHelper.d.ts b/types/helpers/ItemHelper.d.ts index fc88a46..ba34062 100644 --- a/types/helpers/ItemHelper.d.ts +++ b/types/helpers/ItemHelper.d.ts @@ -5,12 +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; @@ -19,22 +22,32 @@ declare class ItemHelper { protected objectId: ObjectId; protected mathUtil: MathUtil; protected 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, 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 - * @returns boolean; true for items that may be in player posession and not quest items + * @returns boolean; true for items that may be in player possession and not quest items */ isValidItem(tpl: string, invalidBaseTypes?: string[]): boolean; /** * 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 classes + * @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 @@ -107,7 +120,7 @@ declare class ItemHelper { */ protected getRepairableItemQualityValue(itemDetails: ITemplateItem, repairable: Repairable, item: Item): number; /** - * Recursive function that looks at every item from parameter and gets their childrens Ids + * Recursive function that looks at every item from parameter and gets their childrens Ids + includes parent item in results * @param items * @param itemID * @returns an array of strings @@ -152,23 +165,25 @@ declare class ItemHelper { */ getChildId(item: Item): string; /** - * Can the pased in item be stacked + * Can the passed in item be stacked * @param tpl item to check * @returns true if it can be stacked */ isItemTplStackable(tpl: string): boolean; /** - * split item stack if it exceeds StackMaxSize + * split item stack if it exceeds its StackMaxSize property + * @param itemToSplit item being split into smaller stacks + * @returns Array of split items */ - splitStack(item: Item): Item[]; + splitStack(itemToSplit: Item): Item[]; /** * Find Barter items in the inventory - * @param {string} by + * @param {string} by tpl or id * @param {Object} pmcData * @param {string} barterItemId * @returns Array of Item objects */ - findBarterItems(by: string, pmcData: IPmcData, barterItemId: string): Item[]; + findBarterItems(by: "tpl" | "id", pmcData: IPmcData, barterItemId: string): Item[]; /** * * @param pmcData @@ -179,35 +194,65 @@ 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 - * @param {string} tpl - * @param {Array} tplsToCheck - * @returns boolean + * WARNING, SLOW. Recursively 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 Items tpl to check parents of + * @param {Array} tplsToCheck Tpl values to check if parents of item match + * @returns boolean Match found */ doesItemOrParentsIdMatch(tpl: string, tplsToCheck: string[]): boolean; /** - * Return true if item is a quest item - * @param {string} tpl - * @returns boolean + * Check if item is quest item + * @param tpl Items tpl to check quest status of + * @returns true if item is flagged as quest item */ isQuestItem(tpl: string): boolean; /** * Get the inventory size of an item - * @param items + * @param items Item with children * @param rootItemId * @returns ItemSize object (width and height) */ getItemSize(items: Item[], rootItemId: string): ItemHelper.ItemSize; /** * Get a random cartridge from an items Filter property - * @param item - * @returns + * @param item Db item template to look up Cartridge filter values from + * @returns Caliber of cartridge */ getRandomCompatibleCaliberTemplateId(item: ITemplateItem): string; - createRandomMagCartridges(magTemplate: ITemplateItem, parentId: string, staticAmmoDist: Record, caliber?: string): Item; + /** + * Add cartridges to the ammo box with correct max stack sizes + * @param ammoBox Box to add cartridges to + * @param ammoBoxDetails Item template from items db + */ + addCartridgesToAmmoBox(ammoBox: Item[], ammoBoxDetails: ITemplateItem): void; + /** + * Add child items (cartridges) to a magazine + * @param magazine Magazine to add child items to + * @param magTemplate Db template of magazine + * @param staticAmmoDist Cartridge distribution + * @param caliber Caliber of cartridge to add to magazine + * @param minSizePercent % the magazine must be filled to + */ + fillMagazineWithRandomCartridge(magazine: Item[], magTemplate: ITemplateItem, staticAmmoDist: Record, caliber?: string, minSizePercent?: number): void; + /** + * Add child items to a magazine of a specific cartridge + * @param magazine Magazine to add child items to + * @param magTemplate Db template of magazine + * @param cartridgeTpl Cartridge to add to magazine + * @param minSizePercent % the magazine must be filled to + */ + fillMagazineWithCartridge(magazine: Item[], magTemplate: ITemplateItem, cartridgeTpl: string, minSizePercent?: number): void; protected getRandomValidCaliber(magTemplate: ITemplateItem): string; protected drawAmmoTpl(caliber: string, staticAmmoDist: Record): string; - createCartidges(parentId: string, ammoTpl: string, stackCount: number): Item; + /** + * + * @param parentId container cartridges will be placed in + * @param ammoTpl Cartridge to insert + * @param stackCount Count of cartridges inside parent + * @param location Location inside parent (e.g. 0, 1) + * @returns Item + */ + createCartridges(parentId: string, ammoTpl: string, stackCount: number, location: number): Item; /** * Get the size of a stack, return 1 if no stack object count property found * @param item Item to get stack size of diff --git a/types/helpers/NotificationSendHelper.d.ts b/types/helpers/NotificationSendHelper.d.ts index 014ac95..d206a87 100644 --- a/types/helpers/NotificationSendHelper.d.ts +++ b/types/helpers/NotificationSendHelper.d.ts @@ -1,12 +1,36 @@ import { INotification } from "../models/eft/notifier/INotifier"; +import { Dialogue, IUserDialogInfo } from "../models/eft/profile/IAkiProfile"; +import { MessageType } from "../models/enums/MessageType"; +import { SaveServer } from "../servers/SaveServer"; import { WebSocketServer } from "../servers/WebSocketServer"; import { NotificationService } from "../services/NotificationService"; +import { HashUtil } from "../utils/HashUtil"; export declare class NotificationSendHelper { protected webSocketServer: WebSocketServer; + protected hashUtil: HashUtil; + protected saveServer: SaveServer; protected notificationService: NotificationService; - constructor(webSocketServer: WebSocketServer, notificationService: NotificationService); + constructor(webSocketServer: WebSocketServer, hashUtil: HashUtil, saveServer: SaveServer, notificationService: NotificationService); /** - * Send notification message to the appropiate channel + * Send notification message to the appropriate channel + * @param sessionID + * @param notificationMessage */ sendMessage(sessionID: string, notificationMessage: INotification): void; + /** + * Send a message directly to the player + * @param sessionId Session id + * @param senderDetails Who is sendin the message to player + * @param messageText Text to send player + * @param messageType Underlying type of message being sent + */ + sendMessageToPlayer(sessionId: string, senderDetails: IUserDialogInfo, messageText: string, messageType: MessageType): void; + /** + * Helper function for sendMessageToPlayer(), get new dialog for storage in profile or find existing by sender id + * @param sessionId Session id + * @param messageType Type of message to generate + * @param senderDetails Who is sending the message + * @returns Dialogue + */ + protected getDialog(sessionId: string, messageType: MessageType, senderDetails: IUserDialogInfo): Dialogue; } diff --git a/types/helpers/PaymentHelper.d.ts b/types/helpers/PaymentHelper.d.ts index 2d068a4..1534f4a 100644 --- a/types/helpers/PaymentHelper.d.ts +++ b/types/helpers/PaymentHelper.d.ts @@ -1,6 +1,11 @@ +import { IInventoryConfig } from "../models/spt/config/IInventoryConfig"; +import { ConfigServer } from "../servers/ConfigServer"; export declare class PaymentHelper { + protected configServer: ConfigServer; + protected inventoryConfig: IInventoryConfig; + constructor(configServer: ConfigServer); /** - * Check whether tpl is Money + * Is the passed in tpl money (also checks custom currencies in inventoryConfig.customMoneyTpls) * @param {string} tpl * @returns void */ 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..91e71ae 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,18 @@ 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); - resetProfileQuestCondition(sessionID: string, conditionId: string): void; + constructor(logger: ILogger, jsonUtil: JsonUtil, watermark: Watermark, timeUtil: TimeUtil, saveServer: SaveServer, databaseServer: DatabaseServer, itemHelper: ItemHelper, profileSnapshotService: ProfileSnapshotService); + /** + * Remove/reset started quest condtions in player profile + * @param sessionID Session id + * @param conditionIds Condition ids that need to be reset/removed + */ + resetProfileQuestCondition(sessionID: string, conditionIds: 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 @@ -37,11 +45,20 @@ export declare class ProfileHelper { * @returns updated profile array */ protected postRaidXpWorkaroundFix(sessionId: string, output: IPmcData[], pmcProfile: IPmcData, scavProfile: IPmcData): IPmcData[]; - isNicknameTaken(info: IValidateNicknameRequestData, sessionID: string): boolean; + /** + * Check if a nickname is used by another profile loaded by the server + * @param nicknameRequest + * @param sessionID Session id + * @returns True if already used + */ + isNicknameTaken(nicknameRequest: IValidateNicknameRequestData, sessionID: string): boolean; + protected profileHasInfoProperty(profile: IAkiProfile): boolean; + protected nicknameMatches(profileName: string, nicknameRequest: string): boolean; + protected sessionIdMatchesProfileId(profileId: string, sessionId: string): boolean; /** * Add experience to a PMC inside the players profile * @param sessionID Session id - * @param experienceToAdd Experiecne to add to PMC character + * @param experienceToAdd Experience to add to PMC character */ addExperienceToPmc(sessionID: string, experienceToAdd: number): void; getProfileByPmcId(pmcId: string): IPmcData; diff --git a/types/helpers/QuestHelper.d.ts b/types/helpers/QuestHelper.d.ts index edbd2e1..dcfc5ae 100644 --- a/types/helpers/QuestHelper.d.ts +++ b/types/helpers/QuestHelper.d.ts @@ -1,8 +1,10 @@ import { IPmcData } from "../models/eft/common/IPmcData"; +import { Quest } from "../models/eft/common/tables/IBotBase"; +import { Item } from "../models/eft/common/tables/IItem"; import { AvailableForConditions, AvailableForProps, IQuest, Reward } from "../models/eft/common/tables/IQuest"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; import { IAcceptQuestRequestData } from "../models/eft/quests/IAcceptQuestRequestData"; -import { ICompleteQuestRequestData } from "../models/eft/quests/ICompleteQuestRequestData"; +import { IFailQuestRequestData } from "../models/eft/quests/IFailQuestRequestData"; import { QuestStatus } from "../models/enums/QuestStatus"; import { IQuestConfig } from "../models/spt/config/IQuestConfig"; import { ILogger } from "../models/spt/utils/ILogger"; @@ -10,6 +12,7 @@ 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"; @@ -32,17 +35,18 @@ export declare class QuestHelper { 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, eventOutputHolder: EventOutputHolder, 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 + * Get status of a quest in player profile by its id * @param pmcData Profile to search - * @param questID Quest id to look up - * @returns QuestStauts enum + * @param questId Quest id to look up + * @returns QuestStatus enum */ - getQuestStatus(pmcData: IPmcData, questID: string): QuestStatus; + getQuestStatus(pmcData: IPmcData, questId: string): QuestStatus; /** * returns true is the level condition is satisfied * @param playerLevel Players level @@ -52,7 +56,7 @@ export declare class QuestHelper { doesPlayerLevelFulfilCondition(playerLevel: number, condition: AvailableForConditions): boolean; /** * Get the quests found in both arrays (inner join) - * @param before Array of qeusts #1 + * @param before Array of quests #1 * @param after Array of quests #2 * @returns Reduction of cartesian product between two quest arrays */ @@ -61,60 +65,64 @@ export declare class QuestHelper { * Increase skill points of a skill on player profile * @param sessionID Session id * @param pmcData Player profile - * @param output output object to send back to client * @param skillName Name of skill to increase skill points of * @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; + rewardSkillPoints(sessionID: string, pmcData: IPmcData, skillName: string, progressAmount: number): void; /** - * Debug Routine for showing some information on the - * quest list in question. + * Get quest name by quest id + * @param questId id to get + * @returns */ - dumpQuests(quests: any): void; + getQuestNameFromLocale(questId: string): string; /** - * Check if trader has sufficient loyalty to fullfill quest requirement + * Check if trader has sufficient loyalty to fulfill quest requirement * @param questProperties Quest props * @param profile Player profile - * @returns true if loyalty is high enough to fulfil quest requirement + * @returns true if loyalty is high enough to fulfill quest requirement */ traderStandingRequirementCheck(questProperties: AvailableForProps, profile: IPmcData): boolean; + /** + * take reward item from quest and set FiR status + fix stack sizes + fix mod Ids + * @param reward Reward item to fix + * @returns Fixed rewards + */ 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) + * @param status Quest status that holds the items (Started, Success, Fail) * @returns array of items with the correct maxStack */ - getQuestRewardItems(quest: IQuest, state: QuestStatus): Reward[]; + getQuestRewardItems(quest: IQuest, status: QuestStatus): Reward[]; /** - * 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 + * Look up quest in db by accepted quest id and construct a profile-ready object ready to store in profile + * @param pmcData Player profile + * @param newState State the new quest should be in when returned + * @param acceptedQuest Details of accepted quest from client */ - addQuestToPMCData(pmcData: IPmcData, newState: QuestStatus, acceptedQuest: IAcceptQuestRequestData): void; + getQuestReadyForProfile(pmcData: IPmcData, newState: QuestStatus, acceptedQuest: IAcceptQuestRequestData): Quest; /** - * TODO: what is going on here - * @param acceptedQuestId Quest to add to profile + * Get quests that can be shown to player after starting a quest + * @param startedQuestId Quest started by player * @param sessionID Session id - * @returns Array of quests in profile + quest passed in as param + * @returns Quests accessible to player incuding newly unlocked quests now quest (startedQuestId) was started */ - acceptedUnlocked(acceptedQuestId: string, sessionID: string): IQuest[]; + acceptedUnlocked(startedQuestId: string, sessionID: string): IQuest[]; /** - * TODO: what is going on here - * @param failedQuestId - * @param sessionID Session id + * Get quests that can be shown to player after failing a quest + * @param failedQuestId Id of the quest failed by player + * @param sessionId Session id * @returns */ - failedUnlocked(failedQuestId: string, sessionID: string): IQuest[]; + failedUnlocked(failedQuestId: string, sessionId: string): IQuest[]; /** - * Adjust quest money rewards by passed in multipler + * Adjust quest money rewards by passed in multiplier * @param quest Quest to multiple money rewards - * @param multipler Value to adjust money rewards by + * @param multiplier Value to adjust money rewards by * @returns Updated quest */ - applyMoneyBoost(quest: IQuest, multipler: number): IQuest; + applyMoneyBoost(quest: IQuest, multiplier: 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 @@ -126,11 +134,12 @@ export declare class QuestHelper { */ 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 + * Add item stack change object into output route event response + * @param output Response to add item change event into + * @param sessionId Session id + * @param item Item that was adjusted */ - getQuestsFromDb(): IQuest[]; + protected addItemStackSizeChangeIntoEventResponse(output: IItemEventRouterResponse, sessionId: string, item: Item): void; /** * Get quests, strip all requirement conditions except level * @param quests quests to process @@ -145,45 +154,69 @@ export declare class QuestHelper { getQuestWithOnlyLevelRequirementStartCondition(quest: IQuest): IQuest; /** * Fail a quest in a player profile - * @param pmcData Profile - * @param failRequest fail quest request data + * @param pmcData Player profile + * @param failRequest Fail quest request data * @param sessionID Session id * @returns Item event router response */ - failQuest(pmcData: IPmcData, failRequest: any, sessionID: string): IItemEventRouterResponse; + failQuest(pmcData: IPmcData, failRequest: IFailQuestRequestData, sessionID: string): IItemEventRouterResponse; /** - * Get quest by id from database - * @param questId questid to look for - * @param pmcData player profile + * Get List of All Quests from db + * NOT CLONED + * @returns Array of IQuest objects + */ + getQuestsFromDb(): IQuest[]; + /** + * Get quest by id from database (repeatables are stored in profile, check there if questId not found) + * @param questId Id of quest to find + * @param pmcData Player profile * @returns IQuest object */ getQuestFromDb(questId: string, pmcData: IPmcData): IQuest; + /** + * 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 + */ + getMessageIdForQuestStart(startedMessageTextId: string, questDescriptionId: string): string; /** * Get the locale Id from locale db for a quest message - * @param questMessageId Quest mesage id to look up + * @param questMessageId Quest message 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 + * Alter a quests state + Add a record to its status timers object * @param pmcData Profile to update - * @param newQuestState new state the qeust should be in - * @param questId id of the quest to alter the status of + * @param newQuestState New state the quest should be in + * @param questId Id of the quest to alter the status of */ updateQuestState(pmcData: IPmcData, newQuestState: QuestStatus, questId: string): void; /** - * Give player quest rewards - Skills/exp/trader standing/items/assort unlocks + * Give player quest rewards - Skills/exp/trader standing/items/assort unlocks - Returns reward items player earned * @param pmcData Player profile - * @param body complete quest request - * @param state State of the quest now its complete - * @param sessionID Seession id - * @returns array of reward objects + * @param questId questId of quest to get rewards for + * @param state State of the quest to get rewards for + * @param sessionId Session id + * @param questResponse Response to send back to client + * @returns Array of reward objects */ - applyQuestReward(pmcData: IPmcData, body: ICompleteQuestRequestData, state: QuestStatus, sessionID: string): Reward[]; + applyQuestReward(pmcData: IPmcData, questId: string, state: QuestStatus, sessionId: string, questResponse: IItemEventRouterResponse): Reward[]; /** - * Get the intel center bonus a player has + * WIP - Find hideout craft id and add to unlockedProductionRecipe array in player profile + * also update client response recipeUnlocked array with craft id + * @param pmcData Player profile + * @param craftUnlockReward Reward item from quest with craft unlock details + * @param questDetails Quest with craft unlock reward + * @param sessionID Session id + * @param response Response to send back to client + */ + protected findAndAddHideoutProductionIdToProfile(pmcData: IPmcData, craftUnlockReward: Reward, questDetails: IQuest, sessionID: string, response: IItemEventRouterResponse): void; + /** + * Get players intel center bonus from profile * @param pmcData player profile - * @returns bonus in percent + * @returns bonus as a percent */ protected getIntelCenterRewardBonus(pmcData: IPmcData): number; /** @@ -191,5 +224,11 @@ export declare class QuestHelper { * @param itemTpl item tpl to look for * @returns 'FindItem' condition id */ - getFindItemIdForQuestHandIn(itemTpl: string): string; + getFindItemIdForQuestHandIn(itemTpl: string): string[]; + /** + * Add all quests to a profile with the provided statuses + * @param pmcProfile profile to update + * @param statuses statuses quests should have + */ + addAllQuestsToProfile(pmcProfile: IPmcData, statuses: QuestStatus[]): void; } diff --git a/types/helpers/RagfairOfferHelper.d.ts b/types/helpers/RagfairOfferHelper.d.ts index b73f786..0e92762 100644 --- a/types/helpers/RagfairOfferHelper.d.ts +++ b/types/helpers/RagfairOfferHelper.d.ts @@ -46,8 +46,29 @@ export declare class RagfairOfferHelper { protected ragfairConfig: IRagfairConfig; protected questConfig: IQuestConfig; 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(info: ISearchRequestData, itemsToAdd: string[], assorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; - getOffersForBuild(info: ISearchRequestData, itemsToAdd: string[], assorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + getValidOffers(searchRequest: ISearchRequestData, itemsToAdd: string[], traderAssorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + /** + * Get offers from flea/traders specifically when building weapon preset + * @param searchRequest Search request data + * @param itemsToAdd string array of item tpls to search for + * @param traderAssorts All trader assorts player can access/buy + * @param pmcProfile Player profile + * @returns ITraderAssort + */ + getOffersForBuild(searchRequest: ISearchRequestData, itemsToAdd: string[], traderAssorts: Record, pmcProfile: IPmcData): IRagfairOffer[]; + /** + * Check if offer item is quest locked for current player by looking at sptQuestLocked property in traders barter_scheme + * @param offer Offer to check is quest locked + * @param traderAssorts all trader assorts for player + * @returns true if quest locked + */ + traderOfferItemQuestLocked(offer: IRagfairOffer, traderAssorts: Record): boolean; + /** + * Has a traders offer ran out of stock to sell to player + * @param offer Offer to check stock of + * @returns true if out of stock + */ + protected traderOutOfStock(offer: IRagfairOffer): boolean; /** * Check if trader offers' BuyRestrictionMax value has been reached * @param offer offer to check restriction properties of @@ -64,5 +85,5 @@ export declare class RagfairOfferHelper { 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..bf7aeb6 100644 --- a/types/helpers/RagfairSellHelper.d.ts +++ b/types/helpers/RagfairSellHelper.d.ts @@ -11,12 +11,26 @@ 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 * @param itemSellCount count of items to sell - * @returns Array of purchases of item(s) lsited + * @returns Array of purchases of item(s) listed */ rollForSale(sellChancePercent: number, itemSellCount: number): SellResult[]; } diff --git a/types/helpers/RagfairServerHelper.d.ts b/types/helpers/RagfairServerHelper.d.ts index ec388d8..bfe6cc3 100644 --- a/types/helpers/RagfairServerHelper.d.ts +++ b/types/helpers/RagfairServerHelper.d.ts @@ -42,7 +42,7 @@ 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 diff --git a/types/helpers/RagfairSortHelper.d.ts b/types/helpers/RagfairSortHelper.d.ts index 4669ce6..6a06528 100644 --- a/types/helpers/RagfairSortHelper.d.ts +++ b/types/helpers/RagfairSortHelper.d.ts @@ -7,7 +7,7 @@ export declare class RagfairSortHelper { protected localeService: LocaleService; constructor(databaseServer: DatabaseServer, localeService: LocaleService); /** - * Sort a list of ragfair offers by something (id/rating/offer name/price/expirty time) + * Sort a list of ragfair offers by something (id/rating/offer name/price/expiry time) * @param offers Offers to sort * @param type How to sort it * @param direction Ascending/descending diff --git a/types/helpers/RepairHelper.d.ts b/types/helpers/RepairHelper.d.ts index 5b09320..0d0257a 100644 --- a/types/helpers/RepairHelper.d.ts +++ b/types/helpers/RepairHelper.d.ts @@ -15,7 +15,7 @@ export declare class RepairHelper { protected repairConfig: IRepairConfig; constructor(logger: ILogger, jsonUtil: JsonUtil, randomUtil: RandomUtil, databaseServer: DatabaseServer, configServer: ConfigServer); /** - * + * 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 @@ -24,7 +24,12 @@ export declare class RepairHelper { * @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; + protected getRandomisedArmorRepairDegradationValue(armorMaterial: string, isRepairKit: boolean, armorMax: number, traderQualityMultipler: number): number; + protected getRandomisedWeaponRepairDegradationValue(itemProps: Props, isRepairKit: boolean, weaponMax: number, traderQualityMultipler: number): number; + /** + * Is the supplied tpl a weapon + * @param tpl tplId to check is a weapon + * @returns true if tpl is a weapon + */ isWeaponTemplate(tpl: string): boolean; } diff --git a/types/helpers/TradeHelper.d.ts b/types/helpers/TradeHelper.d.ts index 2a8f0b7..6811dd1 100644 --- a/types/helpers/TradeHelper.d.ts +++ b/types/helpers/TradeHelper.d.ts @@ -6,8 +6,10 @@ 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 { EventOutputHolder } from "../routers/EventOutputHolder"; +import { ConfigServer } from "../servers/ConfigServer"; import { RagfairServer } from "../servers/RagfairServer"; import { FenceService } from "../services/FenceService"; import { PaymentService } from "../services/PaymentService"; @@ -20,28 +22,30 @@ export declare class TradeHelper { protected fenceService: FenceService; protected inventoryHelper: InventoryHelper; protected ragfairServer: RagfairServer; - constructor(logger: ILogger, eventOutputHolder: EventOutputHolder, 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 + * @param pmcData Player profile * @param buyRequestData data from client - * @param sessionID - * @param foundInRaid + * @param sessionID Session id + * @param foundInRaid Should item be found in raid * @param upd optional item details used when buying from flea * @returns */ buyItem(pmcData: IPmcData, buyRequestData: IProcessBuyTradeRequestData, sessionID: string, foundInRaid: boolean, upd: Upd): IItemEventRouterResponse; /** * Sell item to trader - * @param pmcData - * @param body - * @param sessionID - * @returns + * @param pmcData Profile to update + * @param sellRequest request data + * @param sessionID Session id + * @returns IItemEventRouterResponse */ - sellItem(pmcData: IPmcData, body: IProcessSellTradeRequestData, sessionID: string): IItemEventRouterResponse; + sellItem(pmcData: IPmcData, sellRequest: IProcessSellTradeRequestData, sessionID: string): IItemEventRouterResponse; /** * Increment the assorts buy count by number of items purchased - * Show error on screen if player attepts to buy more than what the buy max allows + * Show error on screen if player attempts to buy more than what the buy max allows * @param assortBeingPurchased assort being bought * @param itemsPurchasedCount number of items being bought */ diff --git a/types/helpers/TraderAssortHelper.d.ts b/types/helpers/TraderAssortHelper.d.ts index 025efd6..a0294a1 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,15 @@ 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); + protected mergedQuestAssorts: Record>; + protected createdMergedQuestAssorts: boolean; + 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 @@ -41,6 +47,10 @@ export declare class TraderAssortHelper { * @returns a traders' assorts */ getAssort(sessionId: string, traderId: string, flea?: boolean): ITraderAssort; + /** + * Create a dict of all assort id = quest id mappings used to work out what items should be shown to player based on the quests they've started/completed/failed + */ + protected hydrateMergedQuestAssorts(): void; /** * Reset a traders assorts and move nextResupply value to future * Flag trader as needing a flea offer reset to be picked up by flea update() function @@ -57,7 +67,7 @@ export declare class TraderAssortHelper { * Iterate over all assorts barter_scheme values, find barters selling for money and multiply by multipler in config * @param traderAssort Assorts to multiple price of */ - protected multiplyItemPricesByConfigMultipler(traderAssort: ITraderAssort): void; + protected multiplyItemPricesByConfigMultiplier(traderAssort: ITraderAssort): void; /** * Get an array of pristine trader items prior to any alteration by player (as they were on server start) * @param traderId trader id diff --git a/types/helpers/TraderHelper.d.ts b/types/helpers/TraderHelper.d.ts index 0dc93e8..bef1511 100644 --- a/types/helpers/TraderHelper.d.ts +++ b/types/helpers/TraderHelper.d.ts @@ -1,33 +1,37 @@ -import { FenceLevel } from "../models/eft/common/IGlobals"; import { IPmcData } from "../models/eft/common/IPmcData"; -import { Item } from "../models/eft/common/tables/IItem"; -import { IBarterScheme, ITraderAssort, ITraderBase, LoyaltyLevel } from "../models/eft/common/tables/ITrader"; +import { ITraderAssort, ITraderBase, LoyaltyLevel } from "../models/eft/common/tables/ITrader"; 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 { SaveServer } from "../servers/SaveServer"; import { FenceService } from "../services/FenceService"; +import { LocalisationService } from "../services/LocalisationService"; import { PlayerService } from "../services/PlayerService"; +import { RandomUtil } from "../utils/RandomUtil"; import { TimeUtil } from "../utils/TimeUtil"; import { HandbookHelper } from "./HandbookHelper"; import { ItemHelper } from "./ItemHelper"; -import { PaymentHelper } from "./PaymentHelper"; import { ProfileHelper } from "./ProfileHelper"; export declare class TraderHelper { protected logger: ILogger; protected databaseServer: DatabaseServer; protected saveServer: SaveServer; protected profileHelper: ProfileHelper; - protected paymentHelper: PaymentHelper; - protected itemHelper: ItemHelper; protected handbookHelper: HandbookHelper; + protected itemHelper: ItemHelper; protected playerService: PlayerService; + protected localisationService: LocalisationService; protected fenceService: FenceService; protected timeUtil: TimeUtil; + protected randomUtil: RandomUtil; 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); + /** Dictionary of item tpl and the highest trader sell rouble price */ + protected highestTraderPriceItems: Record; + /** Dictionary of item tpl and the highest trader buy back rouble price */ + protected highestTraderBuyPriceItems: Record; + constructor(logger: ILogger, databaseServer: DatabaseServer, saveServer: SaveServer, profileHelper: ProfileHelper, handbookHelper: HandbookHelper, itemHelper: ItemHelper, playerService: PlayerService, localisationService: LocalisationService, fenceService: FenceService, timeUtil: TimeUtil, randomUtil: RandomUtil, configServer: ConfigServer); getTrader(traderID: string, sessionID: string): ITraderBase; getTraderAssortsById(traderId: string): ITraderAssort; /** @@ -39,60 +43,25 @@ export declare class TraderHelper { resetTrader(sessionID: string, traderID: string): void; /** * Alter a traders unlocked status - * @param traderID Trader to alter + * @param traderId Trader to alter * @param status New status to use - * @param sessionID Session id + * @param sessionId Session id */ - setTraderUnlockedState(traderID: string, status: boolean, sessionID: string): void; - /** - * Get a list of items and their prices from player inventory that can be sold to a trader - * @param traderID trader id being traded with - * @param sessionID session id - * @returns IBarterScheme[][] - */ - 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 - * @returns true if should NOT be sold to trader - */ - protected isItemUnSellableToTrader(pmcData: IPmcData, item: Item, sellCategory: string[]): boolean; - /** - * Can this weapon be sold to a trader with its current durabiltiy level - * @param traderID - * @param item - * @returns boolean - */ - protected isWeaponBelowTraderBuyDurability(traderID: string, item: Item): boolean; - /** - * Get the price of an item and all of its attached children - * Take into account bonuses/adjsutments e.g. discounts - * @param pmcData profile data - * @param item item to calculate price of - * @param buyPriceCoefficient - * @param fenceInfo fence data - * @param traderBase trader details - * @param currencyTpl Currency to get price as - * @returns price of item + children - */ - protected getAdjustedItemPrice(pmcData: IPmcData, item: Item, buyPriceCoefficient: number, fenceInfo: FenceLevel, traderBase: ITraderBase, currencyTpl: string): number; - /** - * Get the raw price of item+child items from handbook without any modification - * @param pmcData profile data - * @param item item to calculate price of - * @returns price as number - */ - protected getRawItemPrice(pmcData: IPmcData, item: Item): number; - protected getTraderDiscount(trader: ITraderBase, buyPriceCoefficient: number, fenceInfo: FenceLevel, traderID: string): number; + setTraderUnlockedState(traderId: string, status: boolean, sessionId: string): void; /** * Add standing to a trader and level them up if exp goes over level threshold - * @param sessionID Session id - * @param traderId traders id + * @param sessionId Session id + * @param traderId Traders id * @param standingToAdd Standing value to add to trader */ - addStandingToTrader(sessionID: string, traderId: string, standingToAdd: number): void; + addStandingToTrader(sessionId: string, traderId: string, standingToAdd: number): void; + /** + * Add standing to current standing and clamp value if it goes too low + * @param currentStanding current trader standing + * @param standingToAdd stansding to add to trader standing + * @returns current standing + added standing (clamped if needed) + */ + protected addStandingValuesTogether(currentStanding: number, standingToAdd: number): number; /** * Calculate traders level based on exp amount and increments level if over threshold * @param traderID trader to process @@ -111,12 +80,30 @@ export declare class TraderHelper { * @returns Time in seconds */ getTraderUpdateSeconds(traderId: string): number; - /** - * check if an item is allowed to be sold to a trader - * @param traderFilters array of allowed categories - * @param tplToCheck itemTpl of inventory - * @returns boolean - */ - traderFilter(traderFilters: 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; + /** + * Get the highest rouble price for an item from traders + * UNUSED + * @param tpl Item to look up highest pride for + * @returns highest rouble cost for item + */ + getHighestTraderPriceRouble(tpl: string): number; + /** + * Get the highest price item can be sold to trader for (roubles) + * @param tpl Item to look up best trader sell-to price + * @returns Rouble price + */ + getHighestSellToTraderPrice(tpl: string): number; } diff --git a/types/helpers/WeightedRandomHelper.d.ts b/types/helpers/WeightedRandomHelper.d.ts index 9aa0d29..a978f96 100644 --- a/types/helpers/WeightedRandomHelper.d.ts +++ b/types/helpers/WeightedRandomHelper.d.ts @@ -1,5 +1,6 @@ export declare class WeightedRandomHelper { /** + * USE getWeightedValue() WHERE POSSIBLE * Gets a tplId from a weighted dictionary * @param {tplId: weighting[]} itemArray * @returns tplId @@ -7,6 +8,9 @@ export declare class WeightedRandomHelper { getWeightedInventoryItem(itemArray: { [tplId: string]: unknown; } | ArrayLike): string; + getWeightedValue(itemArray: { + [key: string]: unknown; + } | ArrayLike): T; /** * Picks the random item based on its weight. * The items with higher weight will be picked more often (with a higher probability). diff --git a/types/loaders/BundleLoader.d.ts b/types/loaders/BundleLoader.d.ts index 06ad698..4c7e9d6 100644 --- a/types/loaders/BundleLoader.d.ts +++ b/types/loaders/BundleLoader.d.ts @@ -18,5 +18,13 @@ export declare class BundleLoader { getBundles(local: boolean): BundleInfo[]; getBundle(key: string, local: boolean): BundleInfo; addBundles(modpath: string): void; + addBundle(key: string, b: BundleInfo): void; +} +export interface BundleManifest { + manifest: Array; +} +export interface BundleManifestEntry { + key: string; + path: string; } export {}; diff --git a/types/loaders/ModTypeCheck.d.ts b/types/loaders/ModTypeCheck.d.ts new file mode 100644 index 0000000..e907341 --- /dev/null +++ b/types/loaders/ModTypeCheck.d.ts @@ -0,0 +1,43 @@ +import { IPostAkiLoadMod } from "../models/external/IPostAkiLoadMod"; +import { IPostAkiLoadModAsync } from "../models/external/IPostAkiLoadModAsync"; +import { IPostDBLoadMod } from "../models/external/IPostDBLoadMod"; +import { IPostDBLoadModAsync } from "../models/external/IPostDBLoadModAsync"; +import { IPreAkiLoadMod } from "../models/external/IPreAkiLoadMod"; +import { IPreAkiLoadModAsync } from "../models/external/IPreAkiLoadModAsync"; +export declare class ModTypeCheck { + /** + * Use defined safe guard to check if the mod is a IPreAkiLoadMod + * @returns boolean + */ + isPreAkiLoad(mod: any): mod is IPreAkiLoadMod; + /** + * Use defined safe guard to check if the mod is a IPostAkiLoadMod + * @returns boolean + */ + isPostAkiLoad(mod: any): mod is IPostAkiLoadMod; + /** + * Use defined safe guard to check if the mod is a IPostDBLoadMod + * @returns boolean + */ + isPostDBAkiLoad(mod: any): mod is IPostDBLoadMod; + /** + * Use defined safe guard to check if the mod is a IPreAkiLoadModAsync + * @returns boolean + */ + isPreAkiLoadAsync(mod: any): mod is IPreAkiLoadModAsync; + /** + * Use defined safe guard to check if the mod is a IPostAkiLoadModAsync + * @returns boolean + */ + isPostAkiLoadAsync(mod: any): mod is IPostAkiLoadModAsync; + /** + * Use defined safe guard to check if the mod is a IPostDBLoadModAsync + * @returns boolean + */ + isPostDBAkiLoadAsync(mod: any): mod is IPostDBLoadModAsync; + /** + * Checks for mod to be compatible with 3.X+ + * @returns boolean + */ + isPostV3Compatible(mod: any): boolean; +} diff --git a/types/loaders/PostAkiModLoader.d.ts b/types/loaders/PostAkiModLoader.d.ts index edc6e5d..848e9f3 100644 --- a/types/loaders/PostAkiModLoader.d.ts +++ b/types/loaders/PostAkiModLoader.d.ts @@ -1,21 +1,21 @@ import { DependencyContainer } from "tsyringe"; -import { HandbookController } from "../controllers/HandbookController"; import { IModLoader } from "../models/spt/mod/IModLoader"; -import { ModCompilerService } from "../services/ModCompilerService"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; import { VFS } from "../utils/VFS"; import { BundleLoader } from "./BundleLoader"; +import { ModTypeCheck } from "./ModTypeCheck"; import { PreAkiModLoader } from "./PreAkiModLoader"; export declare class PostAkiModLoader implements IModLoader { + protected logger: ILogger; protected bundleLoader: BundleLoader; - protected handbookController: HandbookController; protected vfs: VFS; - protected modCompilerService: ModCompilerService; protected preAkiModLoader: PreAkiModLoader; - constructor(bundleLoader: BundleLoader, handbookController: HandbookController, vfs: VFS, modCompilerService: ModCompilerService, preAkiModLoader: PreAkiModLoader); - getBundles(local: boolean): string; - getBundle(key: string, local: boolean): void; + protected localisationService: LocalisationService; + protected modTypeCheck: ModTypeCheck; + constructor(logger: ILogger, bundleLoader: BundleLoader, vfs: VFS, preAkiModLoader: PreAkiModLoader, localisationService: LocalisationService, modTypeCheck: ModTypeCheck); getModPath(mod: string): string; - load(): void; - protected executeMods(container: DependencyContainer): void; + load(): Promise; + protected executeMods(container: DependencyContainer): Promise; protected addBundles(): void; } diff --git a/types/loaders/PostDBModLoader.d.ts b/types/loaders/PostDBModLoader.d.ts index 5101b7b..eef160b 100644 --- a/types/loaders/PostDBModLoader.d.ts +++ b/types/loaders/PostDBModLoader.d.ts @@ -1,11 +1,17 @@ import { DependencyContainer } from "tsyringe"; import { OnLoad } from "../di/OnLoad"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { LocalisationService } from "../services/LocalisationService"; +import { ModTypeCheck } from "./ModTypeCheck"; import { PreAkiModLoader } from "./PreAkiModLoader"; export declare class PostDBModLoader implements OnLoad { + protected logger: ILogger; protected preAkiModLoader: PreAkiModLoader; - constructor(preAkiModLoader: PreAkiModLoader); - onLoad(): void; + protected localisationService: LocalisationService; + protected modTypeCheck: ModTypeCheck; + constructor(logger: ILogger, preAkiModLoader: PreAkiModLoader, localisationService: LocalisationService, modTypeCheck: ModTypeCheck); + onLoad(): Promise; getRoute(): string; getModPath(mod: string): string; - protected executeMods(container: DependencyContainer): void; + protected executeMods(container: DependencyContainer): Promise; } diff --git a/types/loaders/PreAkiModLoader.d.ts b/types/loaders/PreAkiModLoader.d.ts index f486a28..1949696 100644 --- a/types/loaders/PreAkiModLoader.d.ts +++ b/types/loaders/PreAkiModLoader.d.ts @@ -1,9 +1,5 @@ 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"; @@ -13,6 +9,7 @@ import { ModCompilerService } from "../services/ModCompilerService"; import { JsonUtil } from "../utils/JsonUtil"; import { VFS } from "../utils/VFS"; import { BundleLoader } from "./BundleLoader"; +import { ModTypeCheck } from "./ModTypeCheck"; export declare class PreAkiModLoader implements IModLoader { protected logger: ILogger; protected vfs: VFS; @@ -21,21 +18,22 @@ export declare class PreAkiModLoader implements IModLoader { protected bundleLoader: BundleLoader; protected localisationService: LocalisationService; protected configServer: ConfigServer; + protected modTypeCheck: ModTypeCheck; protected static container: DependencyContainer; protected readonly basepath = "user/mods/"; - protected imported: Record; + protected readonly modOrderPath = "user/mods/order.json"; + protected order: Record; + protected imported: Record; protected akiConfig: ICoreConfig; - constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, modCompilerService: ModCompilerService, bundleLoader: BundleLoader, localisationService: LocalisationService, configServer: ConfigServer); + constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, modCompilerService: ModCompilerService, bundleLoader: BundleLoader, localisationService: LocalisationService, configServer: ConfigServer, modTypeCheck: ModTypeCheck); load(container: DependencyContainer): Promise; - getBundles(local: boolean): string; - getBundle(key: string, local: boolean): void; /** * Returns a list of mods with preserved load order * @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; /** * Check for duplciate mods loaded, show error if duplicate mod found @@ -60,29 +58,8 @@ export declare class PreAkiModLoader implements IModLoader { * @returns dictionary */ protected getModsPackageData(mods: string[]): Record; - /** - * Use defined safe guard to check if the mod is a IPreAkiLoadMod - * @returns 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; + protected executeMods(container: DependencyContainer): Promise; sortModsLoadOrder(): string[]; protected addMod(mod: string): Promise; protected areModDependenciesFulfilled(pkg: IPackageJsonData, loadedMods: Record): boolean; @@ -94,6 +71,6 @@ export declare class PreAkiModLoader implements IModLoader { */ protected validMod(modName: string): boolean; protected getLoadOrderRecursive(mod: string, result: Record, visited: Record): void; - protected getLoadOrder(mods: Record): Record; + protected getLoadOrder(mods: Record): Record; getContainer(): DependencyContainer; } 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 b53f106..5790cde 100644 --- a/types/models/eft/common/IGlobals.d.ts +++ b/types/models/eft/common/IGlobals.d.ts @@ -29,6 +29,9 @@ export interface Config { GlobalLootChanceModifier: number; TimeBeforeDeploy: number; TimeBeforeDeployLocal: number; + TradingSetting: number; + TradingSettings: ITradingSettings; + ItemsCommonSettings: IItemsCommonSettings; LoadTimeSpeedProgress: number; BaseLoadTime: number; BaseUnloadTime: number; @@ -36,6 +39,7 @@ export interface Config { Customization: Customization; UncheckOnShot: boolean; BotsEnabled: boolean; + BufferZone: IBufferZone; ArmorMaterials: ArmorMaterials; LegsOverdamage: number; HandsOverdamage: number; @@ -55,7 +59,6 @@ export interface Config { StaminaRestoration: StaminaRestoration; StaminaDrain: StaminaDrain; RequirementReferences: RequirementReferences; - RepairKitSettings: RepairKitSettings; RestrictionsInRaid: RestrictionsInRaid[]; SkillMinEffectiveness: number; SkillFatiguePerPoint: number; @@ -67,6 +70,7 @@ export interface Config { EventType: string[]; WalkSpeed: xyz; SprintSpeed: xyz; + SquadSettings: ISquadSettings; SkillEnduranceWeightThreshold: number; TeamSearchingTimeout: number; Insurance: Insurance; @@ -82,6 +86,23 @@ export interface Config { TestValue: number; Inertia: Inertia; Ballistic: Ballistic; + RepairSettings: RepairSettings; +} +export interface IBufferZone { + CustomerAccessTime: number; + CustomerCriticalTimeStart: number; + CustomerKickNotifTime: number; +} +export interface IItemsCommonSettings { + ItemRemoveAfterInterruptionTime: number; +} +export interface ITradingSettings { + BuyoutRestrictions: IBuyoutRestrictions; +} +export interface IBuyoutRestrictions { + MinDurability: number; + MinFoodDrinkResource: number; + MinMedsResource: number; } export interface Content { ip: string; @@ -321,6 +342,8 @@ export interface Effects { Pain: Pain; PainKiller: PainKiller; SandingScreen: SandingScreen; + MildMusclePain: IMusclePainEffect; + SevereMusclePain: IMusclePainEffect; Stimulator: Stimulator; Tremor: Tremor; ChronicStaminaFatigue: ChronicStaminaFatigue; @@ -457,6 +480,12 @@ export interface PainKiller { export interface SandingScreen { Dummy: number; } +export interface IMusclePainEffect { + GymEffectivity: number; + OfflineDurationMax: number; + OfflineDurationMin: number; + TraumaChance: number; +} export interface Stimulator { BuffLoopTime: number; Buffs: Buffs; @@ -775,6 +804,11 @@ export interface RestrictionsInRaid { TemplateId: string; Value: number; } +export interface ISquadSettings { + CountOfRequestsToOnePlayer: number; + SecondsForExpiredRequest: number; + SendRequestDelaySeconds: number; +} export interface Insurance { MaxStorageTimeInHour: number; } @@ -803,7 +837,7 @@ export interface SkillsSettings { HMG: any[]; Launcher: any[]; AttachedLauncher: any[]; - Melee: any[]; + Melee: IMeleeSkill; DMR: WeaponSkills; BearAssaultoperations: any[]; BearAuthority: any[]; @@ -847,10 +881,25 @@ export interface SkillsSettings { BotSound: any[]; TroubleShooting: TroubleShooting; } +export interface IMeleeSkill { + BuffSettings: IBuffSettings; +} export interface ArmorSkills { + BuffMaxCount: number; + BuffSettings: IBuffSettings; + Counters: IArmorCounters; + MoveSpeedPenaltyReductionHVestsReducePerLevel: number; + RicochetChanceHVestsCurrentDurabilityThreshold: number; + RicochetChanceHVestsEliteLevel: number; + RicochetChanceHVestsMaxDurabilityThreshold: number; + MeleeDamageLVestsReducePerLevel: number; + MoveSpeedPenaltyReductionLVestsReducePerLevel: number; WearAmountRepairLVestsReducePerLevel: number; WearChanceRepairLVestsReduceEliteLevel: number; } +export interface IArmorCounters { + armorDurability: ISkillCounter; +} export interface HideoutManagement { SkillPointsPerAreaUpgrade: number; SkillPointsPerCraft: number; @@ -907,6 +956,7 @@ export interface Endurance { MovementAction: number; SprintAction: number; GainPerFatigueStack: number; + QTELevelMultipliers: Record>; } export interface Strength { SprintActionMin: number; @@ -915,9 +965,14 @@ export interface Strength { MovementActionMax: number; PushUpMin: number; PushUpMax: number; + QTELevelMultipliers: IQTELevelMultiplier[]; FistfightAction: number; ThrowAction: number; } +export interface IQTELevelMultiplier { + Level: number; + Multiplier: number; +} export interface Vitality { DamageTakenAction: number; HealthNegativeEffect: number; @@ -950,22 +1005,42 @@ export interface Search { FindAction: number; } export interface WeaponTreatment { + BuffMaxCount: number; + BuffSettings: IBuffSettings; + Counters: IWeaponTreatmentCounters; DurLossReducePerLevel: number; SkillPointsPerRepair: number; Filter: any[]; WearAmountRepairGunsReducePerLevel: number; WearChanceRepairGunsReduceEliteLevel: number; } +export interface IWeaponTreatmentCounters { + firearmsDurability: ISkillCounter; +} +export interface IBuffSettings { + CommonBuffChanceLevelBonus: number; + CommonBuffMinChanceValue: number; + CurrentDurabilityLossToRemoveBuff?: number; + MaxDurabilityLossToRemoveBuff?: number; + RareBuffChanceCoff: number; + ReceivedDurabilityMaxPercent: number; +} export interface MagDrills { RaidLoadedAmmoAction: number; RaidUnloadedAmmoAction: number; MagazineCheckAction: number; } export interface Perception { + DependentSkillRatios: ISkillRatio[]; OnlineAction: number; UniqueLoot: number; } +export interface ISkillRatio { + Ratio: number; + SkillId: string; +} export interface Intellect { + Counters: IIntellectCounters; ExamineAction: number; SkillProgress: number; RepairAction: number; @@ -973,16 +1048,52 @@ export interface Intellect { WearChanceReduceEliteLevel: number; RepairPointsCostReduction: number; } +export interface IIntellectCounters { + armorDurability: ISkillCounter; + firearmsDurability: ISkillCounter; + meleeWeaponDurability: ISkillCounter; +} +export interface ISkillCounter { + divisor: number; + points: number; +} export interface Attention { + DependentSkillRatios: ISkillRatio[]; ExamineWithInstruction: number; FindActionFalse: number; FindActionTrue: number; } export interface Charisma { + BonusSettings: IBonusSettings; + Counters: ICharismaSkillCounters; SkillProgressInt: number; SkillProgressAtn: number; SkillProgressPer: number; } +export interface ICharismaSkillCounters { + insuranceCost: ISkillCounter; + repairCost: ISkillCounter; + repeatableQuestCompleteCount: ISkillCounter; + restoredHealthCost: ISkillCounter; + scavCaseCost: ISkillCounter; +} +export interface IBonusSettings { + EliteBonusSettings: IEliteBonusSettings; + LevelBonusSettings: ILevelBonusSettings; +} +export interface IEliteBonusSettings { + FenceStandingLossDiscount: number; + RepeatableQuestExtraCount: number; + ScavCaseDiscount: number; +} +export interface ILevelBonusSettings { + HealthRestoreDiscount: number; + HealthRestoreTraderDiscount: number; + InsuranceDiscount: number; + InsuranceTraderDiscount: number; + PaidExitDiscount: number; + RepeatableQuestChangeDiscount: number; +} export interface Memory { AnySkillUp: number; SkillProgress: number; @@ -1145,11 +1256,30 @@ export interface xyz { export interface Ballistic { GlobalDamageDegradationCoefficient: number; } -export interface RepairKitSettings { +export interface RepairSettings { + ItemEnhancementSettings: IItemEnhancementSettings; + MinimumLevelToApplyBuff: number; + RepairStrategies: IRepairStrategies; armorClassDivisor: number; durabilityPointCostArmor: number; durabilityPointCostGuns: number; } +export interface IItemEnhancementSettings { + DamageReduction: IPriceModifier; + MalfunctionProtections: IPriceModifier; + WeaponSpread: IPriceModifier; +} +export interface IPriceModifier { + PriceModifier: number; +} +export interface IRepairStrategies { + Armor: IRepairStrategy; + Firearms: IRepairStrategy; +} +export interface IRepairStrategy { + BuffTypes: string[]; + Filter: string[]; +} export interface BotPreset { UseThis: boolean; Role: string; diff --git a/types/models/eft/common/ILocationBase.d.ts b/types/models/eft/common/ILocationBase.d.ts index 78ade9a..1c3a2fa 100644 --- a/types/models/eft/common/ILocationBase.d.ts +++ b/types/models/eft/common/ILocationBase.d.ts @@ -118,6 +118,7 @@ export interface BossLocationSpawn { TriggerName: string; Delay?: number; Supports?: BossSupport[]; + sptId?: string; } export interface BossSupport { BossEscortAmount: string; @@ -179,6 +180,7 @@ export interface Exit { EntryPoints: string; ExfiltrationTime: number; ExfiltrationType: string; + RequiredSlot?: string; Id: string; MaxTime: number; MinTime: number; @@ -202,6 +204,7 @@ export interface Wave { slots_min: number; time_max: number; time_min: number; + sptId?: string; } export declare enum WildSpawnType { ASSAULT = "assault", diff --git a/types/models/eft/common/ILooseLoot.d.ts b/types/models/eft/common/ILooseLoot.d.ts index 14b795e..572ec69 100644 --- a/types/models/eft/common/ILooseLoot.d.ts +++ b/types/models/eft/common/ILooseLoot.d.ts @@ -1,3 +1,4 @@ +import { Item } from "./tables/IItem"; export interface ILooseLoot { spawnpointCount: SpawnpointCount; spawnpointsForced: SpawnpointsForced[]; @@ -24,10 +25,6 @@ export interface SpawnpointTemplate { Root: any; Items: Item[]; } -export interface Item { - _id: string; - _tpl?: string; -} export interface Spawnpoint { locationId: string; probability: number; @@ -40,6 +37,9 @@ export interface Xyz { z: number; } export interface ItemDistribution { - tpl: string; + composedKey: ComposedKey; relativeProbability: number; } +export interface ComposedKey { + key: string; +} diff --git a/types/models/eft/common/tables/IBotBase.d.ts b/types/models/eft/common/tables/IBotBase.d.ts index 2b418c1..1e01efc 100644 --- a/types/models/eft/common/tables/IBotBase.d.ts +++ b/types/models/eft/common/tables/IBotBase.d.ts @@ -21,6 +21,7 @@ export interface IBotBase { Hideout: Hideout; Quests: Quest[]; TradersInfo: Record; + UnlockedInfo: IUnlockedInfo; RagfairInfo: RagfairInfo; RepeatableQuests: IPmcDataRepeatableQuest[]; Bonuses: Bonus[]; @@ -31,6 +32,9 @@ export interface IBotBase { /** SPT specific property used during bot generation in raid */ sptIsPmc?: boolean; } +export interface IUnlockedInfo { + unlockedProductionRecipe: string[]; +} export interface Info { EntryPoint: string; Nickname: string; @@ -100,43 +104,45 @@ export interface BodyPartsHealth { } export interface BodyPartHealth { Health: CurrentMax; - Effects?: Record; + Effects?: Record; +} +export interface BodyPartEffectProperties { + Time: number; } export interface CurrentMax { Current: number; Maximum: number; } export interface Inventory { - discardLimits: Record; items: Item[]; equipment: string; stash: string; sortingTable: string; questRaidItems: string; questStashItems: string; - fastPanel: FastPanel; + fastPanel: Record; } -export interface FastPanel { +export interface IBaseJsonSkills { + Common: Record; + Mastering: Record; + Points: number; } export interface Skills { Common: Common[]; Mastering: Mastering[]; - Bonuses?: any[]; Points: number; } -export interface Common { +export interface IBaseSkill { Id: string; Progress: number; - PointsEarnedDuringSession?: number; - LastAccess?: number; max?: number; min?: number; } -export interface Mastering { - Id: string; - Progress: number; - max?: number; - min?: number; +export interface Common extends IBaseSkill { + PointsEarnedDuringSession?: number; + LastAccess?: number; +} +export interface Mastering extends IBaseSkill { } export interface Stats { CarriedQuestItems: string[]; @@ -266,12 +272,24 @@ export interface InsuredItem { export interface Hideout { Production: Record; Areas: HideoutArea[]; + Improvements: Record; + sptUpdateLastRunTimestamp: number; +} +export interface IHideoutImprovement { + completed: boolean; + improveCompleteTimestamp: number; } export interface Productive { Products: Product[]; + /** Seconds passed of production */ Progress?: number; + /** Is craft in some state of being worked on by client (crafting/ready to pick up) */ inProgress?: boolean; StartTimestamp?: number; + SkipTime?: number; + /** Seconds needed to fully craft */ + ProductionTime?: number; + sptIsScavCase?: boolean; } export interface Production extends Productive { RecipeId: string; @@ -328,10 +346,12 @@ export interface Quest { statusTimers?: Record; /** SPT specific property */ completedConditions?: string[]; + availableAfter?: number; } export interface TraderInfo { loyaltyLevel: number; salesSum: number; + disabled: boolean; standing: number; nextResupply: number; unlocked: boolean; diff --git a/types/models/eft/common/tables/IBotType.d.ts b/types/models/eft/common/tables/IBotType.d.ts index 55b4bd9..24b36a4 100644 --- a/types/models/eft/common/tables/IBotType.d.ts +++ b/types/models/eft/common/tables/IBotType.d.ts @@ -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; @@ -100,13 +104,17 @@ export interface Generation { items: ItemMinMax; } export interface ItemMinMax { - grenades: MinMax; - healing: MinMax; - drugs: MinMax; - stims: MinMax; - looseLoot: MinMax; - magazines: MinMax; - specialItems: MinMax; + grenades: MinMaxWithWhitelist; + healing: MinMaxWithWhitelist; + drugs: MinMaxWithWhitelist; + stims: MinMaxWithWhitelist; + looseLoot: MinMaxWithWhitelist; + magazines: MinMaxWithWhitelist; + specialItems: MinMaxWithWhitelist; +} +export interface MinMaxWithWhitelist extends MinMax { + /** Array of item tpls */ + whitelist: string[]; } export interface Health { BodyParts: BodyPart[]; @@ -152,4 +160,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/IItem.d.ts b/types/models/eft/common/tables/IItem.d.ts index 2dd2c03..ce00ae9 100644 --- a/types/models/eft/common/tables/IItem.d.ts +++ b/types/models/eft/common/tables/IItem.d.ts @@ -7,6 +7,7 @@ export interface Item { upd?: Upd; } export interface Upd { + Buff?: Buff; OriginalStackObjectsCount?: number; Togglable?: Togglable; Map?: Map; @@ -16,6 +17,7 @@ export interface Upd { StackObjectsCount?: number; UnlimitedCount?: boolean; Repairable?: Repairable; + RecodableComponent?: RecodableComponent; FireMode?: FireMode; SpawnedInSession?: boolean; Light?: Light; @@ -31,6 +33,12 @@ export interface Upd { SideEffect?: SideEffect; RepairKit?: RepairKit; } +export interface Buff { + rarity: string; + buffType: string; + value: number; + thresholdDurability?: number; +} export interface Togglable { On: boolean; } @@ -52,6 +60,9 @@ export interface Repairable { Durability: number; MaxDurability: number; } +export interface RecodableComponent { + IsEncoded: boolean; +} export interface MedKit { HpResource: number; } @@ -98,7 +109,8 @@ export interface Location { y: number; r: string | number; isSearched?: boolean; - rotation?: string; + /** SPT property? */ + rotation?: string | boolean; } export interface SideEffect { Value: number; diff --git a/types/models/eft/common/tables/IProfileTemplate.d.ts b/types/models/eft/common/tables/IProfileTemplate.d.ts index fbcd81a..66ebbe8 100644 --- a/types/models/eft/common/tables/IProfileTemplate.d.ts +++ b/types/models/eft/common/tables/IProfileTemplate.d.ts @@ -19,6 +19,8 @@ export interface TemplateSide { } export interface ProfileTraderTemplate { initialLoyaltyLevel: number; + setQuestsAvailableForStart?: boolean; + setQuestsAvailableForFinish?: boolean; initialStanding: number; initialSalesSum: number; jaegerUnlocked: boolean; diff --git a/types/models/eft/common/tables/IQuest.d.ts b/types/models/eft/common/tables/IQuest.d.ts index c5b1cb2..52968b1 100644 --- a/types/models/eft/common/tables/IQuest.d.ts +++ b/types/models/eft/common/tables/IQuest.d.ts @@ -2,7 +2,7 @@ import { QuestRewardType } from "../../../enums/QuestRewardType"; import { QuestStatus } from "../../../enums/QuestStatus"; import { Item } from "./IItem"; export interface IQuest { - QuestName: string; + QuestName?: string; _id: string; canShowNotificationsInGame: boolean; conditions: Conditions; @@ -15,6 +15,7 @@ export interface IQuest { image: string; type: string; isKey: boolean; + questStatus: any; restartable: boolean; instantComplete: boolean; secretQuest: boolean; @@ -22,7 +23,7 @@ export interface IQuest { successMessageText: string; templateId: string; rewards: Rewards; - status: string; + status: string | number; KeyQuest: boolean; changeQuestMessageText: string; side: string; @@ -37,18 +38,21 @@ export interface Conditions { export interface AvailableForConditions { _parent: string; _props: AvailableForProps; - dynamicLocale: boolean; + dynamicLocale?: boolean; } export interface AvailableForProps { id: string; index: number; parentId: string; + isEncoded: boolean; dynamicLocale: boolean; - value?: number; + value?: string | number; compareMethod?: string; visibilityConditions?: VisibilityCondition[]; target?: string | string[]; status?: QuestStatus[]; + availableAfter?: number; + dispersion?: number; onlyFoundInRaid?: boolean; oneSessionOnly?: boolean; doNotResetIfCounterCompleted?: boolean; diff --git a/types/models/eft/common/tables/IRepeatableQuests.d.ts b/types/models/eft/common/tables/IRepeatableQuests.d.ts index e23ec73..3a33f2e 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; @@ -47,6 +47,7 @@ export interface IRepeatableQuest { canShowNotificationsInGame: boolean; rewards: IRewards; conditions: IConditions; + side: string; name: string; note: string; description: string; diff --git a/types/models/eft/common/tables/ITemplateItem.d.ts b/types/models/eft/common/tables/ITemplateItem.d.ts index 0fa7e18..0010ee2 100644 --- a/types/models/eft/common/tables/ITemplateItem.d.ts +++ b/types/models/eft/common/tables/ITemplateItem.d.ts @@ -7,6 +7,10 @@ export interface ITemplateItem { _proto: string; } export interface Props { + AllowSpawnOnLocations?: any[]; + ChangePriceCoef?: number; + FixedPrice?: boolean; + SendToClient?: boolean; Name?: string; ShortName?: string; Description?: string; @@ -29,8 +33,11 @@ export interface Props { IsUnsaleable?: boolean; IsUnbuyable?: boolean; IsUngivable?: boolean; + IsUnremovable?: boolean; IsLockedafterEquip?: boolean; + IsSpecialSlotOnly?: boolean; QuestItem?: boolean; + QuestStashMaxCount?: number; LootExperience?: number; ExamineExperience?: number; HideEntrails?: boolean; @@ -99,7 +106,7 @@ export interface Props { MaskSize?: number; NoiseIntensity?: number; NoiseScale?: number; - Color?: Color; + Color?: IColor; DiffuseIntensity?: number; HasHinge?: boolean; RampPalette?: string; @@ -156,11 +163,12 @@ export interface Props { RigLayoutName?: string; MaxDurability?: number; armorZone?: string[]; - armorClass?: any; + armorClass?: string | number; mousePenalty?: number; weaponErgonomicPenalty?: number; BluntThroughput?: number; ArmorMaterial?: string; + ArmorType?: string; weapClass?: string; weapUseType?: string; ammoCaliber?: string; @@ -255,7 +263,7 @@ export interface Props { foodEffectType?: string; StimulatorBuffs?: string; effects_health?: IHealthEffect[] | Record>; - effects_damage?: any; + effects_damage?: Record; MaximumNumberOfUsage?: number; knifeHitDelay?: number; knifeHitSlashRate?: number; @@ -365,6 +373,8 @@ export interface Props { CanBeHiddenDuringThrow?: boolean; MinTimeToContactExplode?: number; ExplosionEffectType?: string; + LinkedWeapon?: string; + UseAmmoWithoutShell?: boolean; } export interface IHealthEffect { type: string; @@ -437,15 +447,15 @@ export interface EffectsHealthProps { value: number; } export interface EffectsDamage { - Pain: EffectDamageProps; - LightBleeding: EffectDamageProps; - HeavyBleeding: EffectDamageProps; - Contusion: EffectDamageProps; - RadExposure: EffectDamageProps; - Fracture: EffectDamageProps; - DestroyedPart: EffectDamageProps; + Pain: IEffectDamageProps; + LightBleeding: IEffectDamageProps; + HeavyBleeding: IEffectDamageProps; + Contusion: IEffectDamageProps; + RadExposure: IEffectDamageProps; + Fracture: IEffectDamageProps; + DestroyedPart: IEffectDamageProps; } -export interface EffectDamageProps { +export interface IEffectDamageProps { delay: number; duration: number; fadeOut: number; @@ -453,7 +463,7 @@ export interface EffectDamageProps { healthPenaltyMin?: number; healthPenaltyMax?: number; } -export interface Color { +export interface IColor { r: number; g: number; b: number; diff --git a/types/models/eft/common/tables/ITrader.d.ts b/types/models/eft/common/tables/ITrader.d.ts index 37b2d61..10c32f1 100644 --- a/types/models/eft/common/tables/ITrader.d.ts +++ b/types/models/eft/common/tables/ITrader.d.ts @@ -9,6 +9,7 @@ export interface ITrader { export interface ITraderBase { refreshTraderRagfairOffers: boolean; _id: string; + availableInRaid: boolean; avatar: string; balance_dol: number; balance_eur: number; @@ -20,6 +21,8 @@ export interface ITraderBase { discount_end: number; gridHeight: number; insurance: Insurance; + items_buy: IItemBuyData; + items_buy_prohibited: IItemBuyData; location: string; loyaltyLevels: LoyaltyLevel[]; medic: boolean; @@ -31,6 +34,10 @@ export interface ITraderBase { surname: string; unlockedByDefault: boolean; } +export interface IItemBuyData { + category: string[]; + id_list: string[]; +} export interface Insurance { availability: boolean; excluded_category: string[]; @@ -54,8 +61,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; @@ -74,9 +82,9 @@ export interface ISuit { tid: string; suiteId: string; isActive: boolean; - requirements: Requirements; + requirements: ISuitRequirements; } -export interface Requirements { +export interface ISuitRequirements { loyaltyLevel: number; profileLevel: number; standing: number; diff --git a/types/models/eft/customization/IGetSuitsResponse.d.ts b/types/models/eft/customization/IGetSuitsResponse.d.ts index fe6888c..cbb909d 100644 --- a/types/models/eft/customization/IGetSuitsResponse.d.ts +++ b/types/models/eft/customization/IGetSuitsResponse.d.ts @@ -1,4 +1,4 @@ export interface IGetSuitsResponse { _id: string; - suits: 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/IClearMailMessageRequest.d.ts b/types/models/eft/dialog/IClearMailMessageRequest.d.ts new file mode 100644 index 0000000..ca4de5a --- /dev/null +++ b/types/models/eft/dialog/IClearMailMessageRequest.d.ts @@ -0,0 +1,3 @@ +export interface IClearMailMessageRequest { + dialogId: string; +} diff --git a/types/models/eft/dialog/IDeleteFriendRequest.d.ts b/types/models/eft/dialog/IDeleteFriendRequest.d.ts new file mode 100644 index 0000000..2923e02 --- /dev/null +++ b/types/models/eft/dialog/IDeleteFriendRequest.d.ts @@ -0,0 +1,3 @@ +export interface IDeleteFriendRequest { + friend_id: string; +} diff --git a/types/models/eft/dialog/IFriendRequestSendResponse.d.ts b/types/models/eft/dialog/IFriendRequestSendResponse.d.ts new file mode 100644 index 0000000..06c40f3 --- /dev/null +++ b/types/models/eft/dialog/IFriendRequestSendResponse.d.ts @@ -0,0 +1,5 @@ +export interface IFriendRequestSendResponse { + status: number; + requestid: string; + retryAfter: number; +} diff --git a/types/models/eft/dialog/IGetFriendListDataResponse.d.ts b/types/models/eft/dialog/IGetFriendListDataResponse.d.ts index 8a29319..f8d700c 100644 --- a/types/models/eft/dialog/IGetFriendListDataResponse.d.ts +++ b/types/models/eft/dialog/IGetFriendListDataResponse.d.ts @@ -1,7 +1,7 @@ import { MemberCategory } from "../../enums/MemberCategory"; export interface IGetFriendListDataResponse { Friends: Friend[]; - Ignore: any[]; + Ignore: string[]; InIgnoreList: string[]; } export interface Friend { diff --git a/types/models/eft/dialog/IGetMailDialogViewResponseData.d.ts b/types/models/eft/dialog/IGetMailDialogViewResponseData.d.ts index 4f8b946..97f18b1 100644 --- a/types/models/eft/dialog/IGetMailDialogViewResponseData.d.ts +++ b/types/models/eft/dialog/IGetMailDialogViewResponseData.d.ts @@ -1,7 +1,6 @@ -import { IPmcData } from "../common/IPmcData"; import { Message } from "../profile/IAkiProfile"; export interface IGetMailDialogViewResponseData { messages: Message[]; - profiles: IPmcData[]; + profiles: any[]; hasMessagesWithRewards: boolean; } diff --git a/types/models/eft/dialog/IRemoveMailMessageRequest.d.ts b/types/models/eft/dialog/IRemoveMailMessageRequest.d.ts new file mode 100644 index 0000000..e2aa8c6 --- /dev/null +++ b/types/models/eft/dialog/IRemoveMailMessageRequest.d.ts @@ -0,0 +1,3 @@ +export interface IRemoveMailMessageRequest { + dialogId: 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/IGetItemPricesResponse.d.ts b/types/models/eft/game/IGetItemPricesResponse.d.ts new file mode 100644 index 0000000..ab6e818 --- /dev/null +++ b/types/models/eft/game/IGetItemPricesResponse.d.ts @@ -0,0 +1,5 @@ +export interface IGetItemPricesResponse { + supplyNextTime: number; + prices: Record; + currencyCourses: Record; +} diff --git a/types/models/eft/health/Effect.d.ts b/types/models/eft/health/Effect.d.ts index 7eb3ffc..62d95a8 100644 --- a/types/models/eft/health/Effect.d.ts +++ b/types/models/eft/health/Effect.d.ts @@ -1,5 +1,7 @@ export declare enum Effect { FRACTURE = "Fracture", LIGHT_BLEEDING = "LightBleeding", - HEAVY_BLEEDING = "HeavyBleeding" + HEAVY_BLEEDING = "HeavyBleeding", + MILD_MUSCLE_PAIN = "MildMusclePain", + SEVERE_MUSCLE_PAIN = "SevereMusclePain" } diff --git a/types/models/eft/health/IWorkoutData.d.ts b/types/models/eft/health/IWorkoutData.d.ts new file mode 100644 index 0000000..ba629d2 --- /dev/null +++ b/types/models/eft/health/IWorkoutData.d.ts @@ -0,0 +1,4 @@ +export interface IWorkoutData extends Record { + skills: any; + effects: any; +} diff --git a/types/models/eft/hideout/IHandleQTEEventRequestData.d.ts b/types/models/eft/hideout/IHandleQTEEventRequestData.d.ts new file mode 100644 index 0000000..5dda485 --- /dev/null +++ b/types/models/eft/hideout/IHandleQTEEventRequestData.d.ts @@ -0,0 +1,8 @@ +export interface IHandleQTEEventRequestData { + Action: string; + /** true if QTE was successful, otherwise false */ + results: boolean[]; + /** Id of the QTE object used from db/hideout/qte.json */ + id: string; + timestamp: number; +} diff --git a/types/models/eft/hideout/IHideoutArea.d.ts b/types/models/eft/hideout/IHideoutArea.d.ts index d9fd2bf..fa5ca20 100644 --- a/types/models/eft/hideout/IHideoutArea.d.ts +++ b/types/models/eft/hideout/IHideoutArea.d.ts @@ -3,23 +3,55 @@ export interface IHideoutArea { type: number; enabled: boolean; needsFuel: boolean; + requirements: IAreaRequirement[]; takeFromSlotLocked: boolean; craftGivesExp: boolean; + displayLevel: boolean; + enableAreaRequirements: boolean; stages: Record; } +export interface IAreaRequirement { + areaType: number; + requiredlevel: number; + type: string; +} export interface Stage { - requirements: Requirement[]; + autoUpgrade: boolean; bonuses: StageBonus[]; - slots: number; constructionTime: number; description: string; + displayInterface: boolean; + improvements: IStageImprovement[]; + requirements: IStageRequirement[]; + slots: number; } -export interface Requirement { +export interface IStageImprovement { + id: string; + bonuses: IStageImprovementBonus[]; + improvementTime: number; + requirements: IStageImprovementRequirement[]; +} +export interface IStageImprovementBonus { + passive: boolean; + production: boolean; + type: string; + value: number; + visible: boolean; +} +export interface IStageImprovementRequirement { + count: number; + isEncoded: boolean; + isFunctional: boolean; + templateId: string; + type: string; +} +export interface IStageRequirement { areaType?: number; requiredLevel?: number; type: string; templateId?: string; count?: number; + isEncoded: false; isFunctional?: boolean; traderId?: string; loyaltyLevel?: number; diff --git a/types/models/eft/hideout/IHideoutContinousProductionStartRequestData.d.ts b/types/models/eft/hideout/IHideoutContinuousProductionStartRequestData.d.ts similarity index 59% rename from types/models/eft/hideout/IHideoutContinousProductionStartRequestData.d.ts rename to types/models/eft/hideout/IHideoutContinuousProductionStartRequestData.d.ts index dba83eb..3ef00c6 100644 --- a/types/models/eft/hideout/IHideoutContinousProductionStartRequestData.d.ts +++ b/types/models/eft/hideout/IHideoutContinuousProductionStartRequestData.d.ts @@ -1,4 +1,4 @@ -export interface IHideoutContinousProductionStartRequestData { +export interface IHideoutContinuousProductionStartRequestData { Action: "HideoutContinuousProductionStart"; recipeId: string; timestamp: number; diff --git a/types/models/eft/hideout/IHideoutImproveAreaRequestData.d.ts b/types/models/eft/hideout/IHideoutImproveAreaRequestData.d.ts new file mode 100644 index 0000000..7e927bf --- /dev/null +++ b/types/models/eft/hideout/IHideoutImproveAreaRequestData.d.ts @@ -0,0 +1,13 @@ +export interface IHideoutImproveAreaRequestData { + Action: "HideoutImproveArea"; + /** Hideout area id from areas.json */ + id: string; + areaType: number; + items: HideoutItem[]; + timestamp: number; +} +export interface HideoutItem { + /** Hideout inventory id that was used by improvement action */ + id: string; + count: number; +} diff --git a/types/models/eft/hideout/IHideoutProduction.d.ts b/types/models/eft/hideout/IHideoutProduction.d.ts index ce878be..8bed3cc 100644 --- a/types/models/eft/hideout/IHideoutProduction.d.ts +++ b/types/models/eft/hideout/IHideoutProduction.d.ts @@ -3,8 +3,10 @@ export interface IHideoutProduction { areaType: number; requirements: Requirement[]; productionTime: number; - boosters: any; endProduct: string; + isEncoded: boolean; + locked: boolean; + needFuelForAllProductionTime: boolean; continuous: boolean; count: number; productionLimitCount: number; @@ -12,9 +14,11 @@ export interface IHideoutProduction { export interface Requirement { templateId?: string; count?: number; + isEncoded?: boolean; isFunctional?: boolean; type: string; areaType?: number; requiredLevel?: number; resource?: number; + questId?: string; } diff --git a/types/models/eft/hideout/IQteData.d.ts b/types/models/eft/hideout/IQteData.d.ts new file mode 100644 index 0000000..f842b84 --- /dev/null +++ b/types/models/eft/hideout/IQteData.d.ts @@ -0,0 +1,38 @@ +export interface IQteData { + Id: string; + Type: string; + Area: string; + AreaLevel: number; + QuickTimeEvents: IQuickTimeEvent[]; + Requirements: IQteRequirement[]; + Results: Record; +} +export interface IQuickTimeEvent { + Type: string; + Position: number; + StartDelay: number; + EndDelay: number; + Speed: number; + SuccessRange: string; + Key: string; +} +export interface IQteRequirement { + type: string; +} +export interface IQteResult { + Energy: number; + Hydration: number; + RewardsRange: IQteEffect[]; +} +export interface IQteEffect { + Type: string; + SkillId: string; + levelMultipliers: ISkillLevelMultiplier[]; + Time: number; + Weight: number; + Result: string; +} +export interface ISkillLevelMultiplier { + level: number; + multiplier: number; +} diff --git a/types/models/eft/hideout/IRecordShootingRangePoints.d.ts b/types/models/eft/hideout/IRecordShootingRangePoints.d.ts new file mode 100644 index 0000000..5bfd2fd --- /dev/null +++ b/types/models/eft/hideout/IRecordShootingRangePoints.d.ts @@ -0,0 +1,4 @@ +export interface IRecordShootingRangePoints { + Action: "RecordShootingRangePoints"; + points: 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/IAddItemTempObject.d.ts b/types/models/eft/inventory/IAddItemTempObject.d.ts new file mode 100644 index 0000000..62d4b64 --- /dev/null +++ b/types/models/eft/inventory/IAddItemTempObject.d.ts @@ -0,0 +1,7 @@ +import { Item, Location } from "../common/tables/IItem"; +export interface IAddItemTempObject { + itemRef: Item; + count: number; + isPreset: boolean; + location?: Location; +} 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/itemEvent/IItemEventRouterBase.d.ts b/types/models/eft/itemEvent/IItemEventRouterBase.d.ts index 60ab284..dbf6330 100644 --- a/types/models/eft/itemEvent/IItemEventRouterBase.d.ts +++ b/types/models/eft/itemEvent/IItemEventRouterBase.d.ts @@ -1,4 +1,5 @@ -import { Skills } from "../common/tables/IBotBase"; +import { QuestStatus } from "../../../models/enums/QuestStatus"; +import { Health, Productive, Skills, TraderInfo } from "../common/tables/IBotBase"; import { Item, Upd } from "../common/tables/IItem"; import { IQuest } from "../common/tables/IQuest"; import { IPmcDataRepeatableQuest } from "../common/tables/IRepeatableQuests"; @@ -7,7 +8,7 @@ export interface IItemEventRouterBase { warnings: Warning[]; profileChanges: TProfileChanges | ""; } -export declare type TProfileChanges = Record; +export type TProfileChanges = Record; export interface Warning { index: number; errmsg: string; @@ -21,10 +22,23 @@ export interface ProfileChange { ragFairOffers: IRagfairOffer[]; builds: BuildChange[]; items: ItemChanges; - production: Record; + production: Record; + /** Hideout area improvement id */ + improvements: Record; skills: Skills; - traderRelations: Record; + health: Health; + traderRelations: Record; repeatableQuests?: IPmcDataRepeatableQuest[]; + recipeUnlocked: Record; + questsStatus: QuestStatusChange[]; +} +export interface QuestStatusChange { + qid: string; + startTime: number; + status: QuestStatus; + statusTimers: Record; + completedConditions: string[]; + availableAfter: number; } export interface BuildChange { id: string; @@ -37,13 +51,9 @@ export interface ItemChanges { change: Product[]; del: Product[]; } -export interface Production { - Progress: number; - StartTimestamp: number; - ProductionTime: number; - inProgress: boolean; - RecipeId: string; - Products: Product[]; +export interface Improvement { + completed: boolean; + improveCompleteTimestamp: number; } export interface Product { _id: string; @@ -59,10 +69,3 @@ export interface ItemChangeLocation { r: number; isSearched?: boolean; } -export interface TraderRelations { - salesSum?: number; - standing?: number; - loyalty?: number; - unlocked?: boolean; - disabled?: boolean; -} 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/IAcceptGroupInviteRequest.d.ts b/types/models/eft/match/IAcceptGroupInviteRequest.d.ts new file mode 100644 index 0000000..1a4b8f7 --- /dev/null +++ b/types/models/eft/match/IAcceptGroupInviteRequest.d.ts @@ -0,0 +1,3 @@ +export interface IAcceptGroupInviteRequest { + requestId: string; +} diff --git a/types/models/eft/match/IAcceptGroupInviteResponse.d.ts b/types/models/eft/match/IAcceptGroupInviteResponse.d.ts new file mode 100644 index 0000000..eea1ce6 --- /dev/null +++ b/types/models/eft/match/IAcceptGroupInviteResponse.d.ts @@ -0,0 +1,16 @@ +export interface IAcceptGroupInviteResponse { + _id: string; + aid: number; + Info: PlayerInviteInfo; + isLeader: boolean; + isReady: boolean; +} +export interface PlayerInviteInfo { + Nickname: string; + Side: string; + Level: number; + MemberCategory: number; + GameVersion: string; + SavageLockTime: number; + SavageNickname: string; +} diff --git a/types/models/eft/match/ICancelGroupInviteRequest.d.ts b/types/models/eft/match/ICancelGroupInviteRequest.d.ts new file mode 100644 index 0000000..71d79c7 --- /dev/null +++ b/types/models/eft/match/ICancelGroupInviteRequest.d.ts @@ -0,0 +1,3 @@ +export interface ICancelGroupInviteRequest { + requestId: string; +} diff --git a/types/models/eft/match/IEndOfflineRaidRequestData.d.ts b/types/models/eft/match/IEndOfflineRaidRequestData.d.ts index 811e9a2..9368c32 100644 --- a/types/models/eft/match/IEndOfflineRaidRequestData.d.ts +++ b/types/models/eft/match/IEndOfflineRaidRequestData.d.ts @@ -1,6 +1,6 @@ export interface IEndOfflineRaidRequestData { crc: number; exitStatus: string; - exitName: any; + exitName: string; raidSeconds: number; } diff --git a/types/models/eft/match/IGetRaidConfigurationRequestData.d.ts b/types/models/eft/match/IGetRaidConfigurationRequestData.d.ts new file mode 100644 index 0000000..ed3dfab --- /dev/null +++ b/types/models/eft/match/IGetRaidConfigurationRequestData.d.ts @@ -0,0 +1,32 @@ +export interface IGetRaidConfigurationRequestData { + keyId: string; + side: string; + location: string; + timeVariant: string; + raidMode: string; + metabolismDisabled: boolean; + playersSpawnPlace: string; + timeAndWeatherSettings: TimeAndWeatherSettings; + botSettings: BotSettings; + wavesSettings: WavesSettings; +} +export interface TimeAndWeatherSettings { + isRandomTime: boolean; + isRandomWeather: boolean; + cloudinessType: string; + rainType: string; + windType: string; + fogType: string; + timeFlowType: string; + hourOfDay: number; +} +export interface BotSettings { + isScavWars: boolean; + botAmount: string; +} +export interface WavesSettings { + botAmount: string; + botDifficulty: string; + isBosses: boolean; + isTaggedAndCursed: boolean; +} diff --git a/types/models/eft/match/IJoinMatchResult.d.ts b/types/models/eft/match/IJoinMatchResult.d.ts index df695f4..81c9055 100644 --- a/types/models/eft/match/IJoinMatchResult.d.ts +++ b/types/models/eft/match/IJoinMatchResult.d.ts @@ -6,6 +6,8 @@ export interface IJoinMatchResult { port: number; version: string; location: string; - gamemode: string; + raidMode: string; + mode: string; shortid: string; + additional_info: any[]; } diff --git a/types/models/eft/match/IRemovePlayerFromGroupRequest.d.ts b/types/models/eft/match/IRemovePlayerFromGroupRequest.d.ts new file mode 100644 index 0000000..4877c54 --- /dev/null +++ b/types/models/eft/match/IRemovePlayerFromGroupRequest.d.ts @@ -0,0 +1,3 @@ +export interface IRemovePlayerFromGroupRequest { + aidToKick: string; +} diff --git a/types/models/eft/match/ISendGroupInviteRequest.d.ts b/types/models/eft/match/ISendGroupInviteRequest.d.ts new file mode 100644 index 0000000..66d3d0e --- /dev/null +++ b/types/models/eft/match/ISendGroupInviteRequest.d.ts @@ -0,0 +1,4 @@ +export interface ISendGroupInviteRequest { + to: string; + inLobby: boolean; +} diff --git a/types/models/eft/match/IStartOffineRaidRequestData.d.ts b/types/models/eft/match/IStartOffineRaidRequestData.d.ts deleted file mode 100644 index 1983728..0000000 --- a/types/models/eft/match/IStartOffineRaidRequestData.d.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { BotAmount } from "../../enums/BotAmount"; -import { BotDifficulty } from "../../enums/BotDifficulty"; -export interface IStartOfflineRaidRequestData { - locationName: string; - /** Current time, not in-game time */ - startTime: number; - /** CURR = am, past = pm */ - dateTime: "CURR" | "PAST"; - gameSettings: GameSettings; -} -export interface GameSettings { - timeAndWeatherSettings: TimeAndWeatherSettings; - botsSettings: BotsSettings; - wavesSettings: WavesSettings; -} -export interface TimeAndWeatherSettings { - isRandomTime: boolean; - isRandomWeather: boolean; -} -export interface BotsSettings { - isEnabled: boolean; - isScavWars: boolean; - botAmount: BotAmount; -} -export interface WavesSettings { - botDifficulty: BotDifficulty; - isBosses: boolean; - isTaggedAndCursed: boolean; - wavesBotAmount: BotAmount; -} diff --git a/types/models/eft/notifier/INotifier.d.ts b/types/models/eft/notifier/INotifier.d.ts index b248636..bdb021a 100644 --- a/types/models/eft/notifier/INotifier.d.ts +++ b/types/models/eft/notifier/INotifier.d.ts @@ -1,3 +1,4 @@ +import { Message } from "../profile/IAkiProfile"; export interface INotifierChannel { server: string; channel_id: string; @@ -5,7 +6,6 @@ export interface INotifierChannel { notifierServer: string; ws: string; } -import { Message } from "../profile/IAkiProfile"; export interface INotification { type: "RagfairOfferSold" | "new_message" | "ping"; eventId: string; diff --git a/types/models/eft/presetBuild/IPresetBuildActionRequestData.d.ts b/types/models/eft/presetBuild/IPresetBuildActionRequestData.d.ts index 99c61f1..42549e6 100644 --- a/types/models/eft/presetBuild/IPresetBuildActionRequestData.d.ts +++ b/types/models/eft/presetBuild/IPresetBuildActionRequestData.d.ts @@ -1,3 +1,4 @@ +import { Upd } from "../common/tables/IItem"; export interface IPresetBuildActionRequestData { Action: string; id: string; @@ -12,14 +13,3 @@ export interface Item { parentId?: string; slotId?: string; } -export interface Upd { - Repairable: Repairable; - FireMode: FireMode; -} -export interface Repairable { - MaxDurability: number; - Durability: number; -} -export interface FireMode { - FireMode: string; -} diff --git a/types/models/eft/profile/GetProfileStatusResponseData.d.ts b/types/models/eft/profile/GetProfileStatusResponseData.d.ts index cb7368c..1228c2e 100644 --- a/types/models/eft/profile/GetProfileStatusResponseData.d.ts +++ b/types/models/eft/profile/GetProfileStatusResponseData.d.ts @@ -6,7 +6,13 @@ export interface ProfileData { profileid: string; profileToken: string; status: string; - sid: string; ip: string; port: number; + sid: string; + version?: string; + location?: string; + raidMode?: string; + mode?: string; + shortId?: string; + additional_info?: any[]; } diff --git a/types/models/eft/profile/IAkiProfile.d.ts b/types/models/eft/profile/IAkiProfile.d.ts index cf28c12..3840e83 100644 --- a/types/models/eft/profile/IAkiProfile.d.ts +++ b/types/models/eft/profile/IAkiProfile.d.ts @@ -1,3 +1,4 @@ +import { MemberCategory } from "../../../models/enums/MemberCategory"; import { MessageType } from "../../enums/MessageType"; import { IPmcData } from "../common/IPmcData"; import { Item } from "../common/tables/IItem"; @@ -11,6 +12,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; @@ -30,19 +37,32 @@ export interface WeaponBuild { items: Item[]; } export interface Dialogue { - _id: string; - messages: Message[]; - pinned: boolean; - new: number; attachmentsNew: number; + type: MessageType; + new: number; + _id: string; + Users?: IUserDialogInfo[]; + pinned: boolean; + messages: Message[]; +} +export interface IUserDialogInfo { + _id: string; + info: IUserDialogDetails; +} +export interface IUserDialogDetails { + Nickname: string; + Side: string; + Level: number; + MemberCategory: MemberCategory; } export interface DialogueInfo { attachmentsNew: number; new: number; + _id: string; type: MessageType; pinned: boolean; + Users?: any[]; message: MessagePreview; - _id: string; } export interface Message { _id: string; @@ -51,7 +71,7 @@ export interface Message { dt: number; UtcDateTime?: number; Member?: IUpdatableChatMember; - templateId: string; + templateId?: string; text?: string; hasRewards: boolean; rewardCollected: boolean; @@ -66,6 +86,7 @@ export interface MessagePreview { dt: number; templateId: string; text?: string; + systemData?: ISystemData; } export interface MessageItems { stash?: string; @@ -93,6 +114,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/profile/IConnectResponse.d.ts b/types/models/eft/profile/IConnectResponse.d.ts new file mode 100644 index 0000000..8e809ef --- /dev/null +++ b/types/models/eft/profile/IConnectResponse.d.ts @@ -0,0 +1,6 @@ +export interface IConnectResponse { + backendUrl: string; + name: string; + editions: string[]; + profileDescriptions: Record; +} diff --git a/types/models/eft/profile/IGetProfileSettingsRequest.d.ts b/types/models/eft/profile/IGetProfileSettingsRequest.d.ts new file mode 100644 index 0000000..8168615 --- /dev/null +++ b/types/models/eft/profile/IGetProfileSettingsRequest.d.ts @@ -0,0 +1,3 @@ +export interface IGetProfileSettingsRequest { + squadInviteRestriction: boolean; +} diff --git a/types/models/eft/quests/IFailQuestRequestData.d.ts b/types/models/eft/quests/IFailQuestRequestData.d.ts new file mode 100644 index 0000000..5881d91 --- /dev/null +++ b/types/models/eft/quests/IFailQuestRequestData.d.ts @@ -0,0 +1,5 @@ +export interface IFailQuestRequestData { + Action: "QuestComplete"; + qid: string; + removeExcessItems: boolean; +} diff --git a/types/models/eft/ragfair/IRagfairOffer.d.ts b/types/models/eft/ragfair/IRagfairOffer.d.ts index 792ec7d..6b28718 100644 --- a/types/models/eft/ragfair/IRagfairOffer.d.ts +++ b/types/models/eft/ragfair/IRagfairOffer.d.ts @@ -23,6 +23,7 @@ export interface IRagfairOffer { summaryCost: number; user: IRagfairOfferUser; notAvailable: boolean; + /** TODO - implement this value - not currently used */ CurrentItemCount: number; priority: boolean; } diff --git a/types/models/eft/trade/IProcessSellTradeRequestData.d.ts b/types/models/eft/trade/IProcessSellTradeRequestData.d.ts index f1d555f..dee0cd5 100644 --- a/types/models/eft/trade/IProcessSellTradeRequestData.d.ts +++ b/types/models/eft/trade/IProcessSellTradeRequestData.d.ts @@ -3,6 +3,7 @@ export interface IProcessSellTradeRequestData extends IProcessBaseTradeRequestDa Action: "sell_to_trader"; type: string; tid: string; + price: number; items: Item[]; } export interface Item { diff --git a/types/models/enums/AirdropType.d.ts b/types/models/enums/AirdropType.d.ts new file mode 100644 index 0000000..a6f6e3a --- /dev/null +++ b/types/models/enums/AirdropType.d.ts @@ -0,0 +1,6 @@ +export declare enum AirdropTypeEnum { + MIXED = "mixed", + WEAPONARMOR = "weaponarmor", + FOODMEDICAL = "foodmedical", + BARTER = "barter" +} diff --git a/types/models/enums/BaseClasses.d.ts b/types/models/enums/BaseClasses.d.ts index 4eb6f7e..0551c56 100644 --- a/types/models/enums/BaseClasses.d.ts +++ b/types/models/enums/BaseClasses.d.ts @@ -1,13 +1,17 @@ export declare enum BaseClasses { WEAPON = "5422acb9af1c889c16000029", + UBGL = "55818b014bdc2ddc698b456b", ARMOR = "5448e54d4bdc2dcc718b4568", ARMOREDEQUIPMENT = "57bef4c42459772e8d35a53b", HEADWEAR = "5a341c4086f77401f2541505", FACECOVER = "5a341c4686f77469e155819e", VEST = "5448e5284bdc2dcb718b4567", BACKPACK = "5448e53e4bdc2d60728b4567", + COMPOUND = "566162e44bdc2d3f298b4573", VISORS = "5448e5724bdc2ddf718b4568", FOOD = "5448e8d04bdc2ddf718b4569", + GAS_BLOCK = "56ea9461d2720b67698b456f", + RAIL_COVER = "55818b1d4bdc2d5b648b4572", DRINK = "5448e8d64bdc2dce718b4568", BARTER_ITEM = "5448eb774bdc2d0a728b4567", INFO = "5448ecbe4bdc2d60728b4568", @@ -27,6 +31,7 @@ export declare enum BaseClasses { MUZZLE = "5448fe394bdc2d0d028b456c", SIGHTS = "5448fe7a4bdc2d6f028b456b", MEDS = "543be5664bdc2dd4348b4569", + MAP = "567849dd4bdc2d150f8b456e", MONEY = "543be5dd4bdc2deb348b4569", NIGHTVISION = "5a2c3a9486f774688b05e574", KEY = "543be5e94bdc2df1348b4568", @@ -36,6 +41,7 @@ export declare enum BaseClasses { THROW_WEAPON = "543be6564bdc2df4348b4568", FOOD_DRINK = "543be6674bdc2df1348b4569", PISTOL = "5447b5cf4bdc2d65278b4567", + REVOLVER = "617f1ef5e8b54b0998387733", SMG = "5447b5e04bdc2d62278b4567", ASSAULT_RIFLE = "5447b5f14bdc2d61278b4567", ASSAULT_CARBINE = "5447b5fc4bdc2d87278b4567", @@ -50,7 +56,7 @@ export declare enum BaseClasses { AMMO = "5485a8684bdc2da71d8b4567", AMMO_BOX = "543be5cb4bdc2deb348b4568", LOOT_CONTAINER = "566965d44bdc2d814c8b4571", - MOD_CONTAINER = "5448bf274bdc2dfc2f8b456a", + MOB_CONTAINER = "5448bf274bdc2dfc2f8b456a", SEARCHABLE_ITEM = "566168634bdc2d144c8b456c", STASH = "566abbb64bdc2d144c8b457d", SORTING_TABLE = "6050cac987d3f925bf016837", @@ -73,9 +79,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 9c48b68..2fe01c6 100644 --- a/types/models/enums/ConfigTypes.d.ts +++ b/types/models/enums/ConfigTypes.d.ts @@ -13,11 +13,13 @@ export declare enum ConfigTypes { LOCATION = "aki-location", MATCH = "aki-match", PLAYERSCAV = "aki-playerscav", + PMC_CHAT_RESPONSE = "aki-pmcchatresponse", QUEST = "aki-quest", RAGFAIR = "aki-ragfair", REPAIR = "aki-repair", SCAVCASE = "aki-scavcase", TRADER = "aki-trader", WEATHER = "aki-weather", - SEASONAL_EVENT = "aki-seasonalevents" + SEASONAL_EVENT = "aki-seasonalevents", + LOST_ON_DEATH = "aki-lostondeath" } diff --git a/types/models/enums/ELocationName.d.ts b/types/models/enums/ELocationName.d.ts index 7ae7caa..c52ae87 100644 --- a/types/models/enums/ELocationName.d.ts +++ b/types/models/enums/ELocationName.d.ts @@ -8,5 +8,6 @@ export declare enum ELocationName { LIGHTHOUSE = "Lighthouse", LABORATORY = "laboratory", RESERVE = "RezervBase", + STREETS = "TarkovStreets", ANY = "any" } 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/HideoutAreas.d.ts b/types/models/enums/HideoutAreas.d.ts index b44a20a..c8313d9 100644 --- a/types/models/enums/HideoutAreas.d.ts +++ b/types/models/enums/HideoutAreas.d.ts @@ -21,5 +21,7 @@ export declare enum HideoutAreas { SOLAR_POWER = 18, BOOZE_GENERATOR = 19, BITCOIN_FARM = 20, - CHRISTMAS_TREE = 21 + CHRISTMAS_TREE = 21, + EMERGENCY_WALL = 22, + GYM = 23 } diff --git a/types/models/enums/HideoutEventActions.d.ts b/types/models/enums/HideoutEventActions.d.ts index e441477..aa04131 100644 --- a/types/models/enums/HideoutEventActions.d.ts +++ b/types/models/enums/HideoutEventActions.d.ts @@ -7,5 +7,7 @@ export declare enum HideoutEventActions { HIDEOUT_SINGLE_PRODUCTION_START = "HideoutSingleProductionStart", HIDEOUT_SCAV_CASE_PRODUCTION_START = "HideoutScavCaseProductionStart", HIDEOUT_CONTINUOUS_PRODUCTION_START = "HideoutContinuousProductionStart", - HIDEOUT_TAKE_PRODUCTION = "HideoutTakeProduction" + HIDEOUT_TAKE_PRODUCTION = "HideoutTakeProduction", + HIDEOUT_RECORD_SHOOTING_RANGE_POINTS = "RecordShootingRangePoints", + HIDEOUT_IMPROVE_AREA = "HideoutImproveArea" } diff --git a/types/models/enums/ItemEventActions.d.ts b/types/models/enums/ItemEventActions.d.ts index 0e65453..94061f8 100644 --- a/types/models/enums/ItemEventActions.d.ts +++ b/types/models/enums/ItemEventActions.d.ts @@ -15,5 +15,6 @@ export declare enum ItemEventActions { CREATE_MAP_MARKER = "CreateMapMarker", DELETE_MAP_MARKER = "DeleteMapMarker", EDIT_MAP_MARKER = "EditMapMarker", - OPEN_RANDOM_LOOT_CONTAINER = "OpenRandomLootContainer" + OPEN_RANDOM_LOOT_CONTAINER = "OpenRandomLootContainer", + HIDEOUT_QTE_EVENT = "HideoutQuickTimeEvent" } diff --git a/types/models/enums/QuestRewardType.d.ts b/types/models/enums/QuestRewardType.d.ts index 16f7e39..ff8c5f4 100644 --- a/types/models/enums/QuestRewardType.d.ts +++ b/types/models/enums/QuestRewardType.d.ts @@ -4,5 +4,6 @@ export declare enum QuestRewardType { TRADER_STANDING = "TraderStanding", TRADER_UNLOCK = "TraderUnlock", ITEM = "Item", - ASSORTMENT_UNLOCK = "AssortmentUnlock" + ASSORTMENT_UNLOCK = "AssortmentUnlock", + PRODUCTIONS_SCHEME = "ProductionScheme" } diff --git a/types/models/enums/QuestStatus.d.ts b/types/models/enums/QuestStatus.d.ts index ba65933..e706c05 100644 --- a/types/models/enums/QuestStatus.d.ts +++ b/types/models/enums/QuestStatus.d.ts @@ -7,5 +7,6 @@ export declare enum QuestStatus { Fail = 5, FailRestartable = 6, MarkedAsFailed = 7, - Expired = 8 + Expired = 8, + AvailableAfter = 9 } diff --git a/types/models/enums/Traders.d.ts b/types/models/enums/Traders.d.ts index 163cd71..ffea725 100644 --- a/types/models/enums/Traders.d.ts +++ b/types/models/enums/Traders.d.ts @@ -6,5 +6,6 @@ export declare enum Traders { PEACEKEEPER = "5935c25fb3acc3127c3d8cd9", MECHANIC = "5a7c2eca46aef81a7ca2145d", RAGMAN = "5ac3b934156ae10c4430e83c", - JAEGER = "5c0647fdd443bc2504c2d371" + JAEGER = "5c0647fdd443bc2504c2d371", + LIGHTHOUSEKEEPER = "638f541a29ffd1183d187f57" } diff --git a/types/models/enums/WildSpawnTypeNumber.d.ts b/types/models/enums/WildSpawnTypeNumber.d.ts index ff806fe..03c6a0e 100644 --- a/types/models/enums/WildSpawnTypeNumber.d.ts +++ b/types/models/enums/WildSpawnTypeNumber.d.ts @@ -1,33 +1,34 @@ export declare enum WildSpawnTypeNumber { + MARKSMAN = 0, 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 + BOSSTEST = 2, + BOSSBULLY = 3, + FOLLOWERTEST = 4, + FOLLOWERBULLY = 5, + BOSSKILLA = 6, + BOSSKOJANIY = 7, + FOLLOWERKOJANIY = 8, + PMCBOT = 9, + CURSEDASSAULT = 10, + BOSSGLUHAR = 11, + FOLLOWERGLUHARASSAULT = 12, + FOLLOWERGLUHARSECURITY = 13, + FOLLOWERGLUHARSCOUT = 14, + FOLLOWERGLUHARSNIPE = 15, + FOLLOWERSANITAR = 16, + BOSSSANITAR = 17, + TEST = 18, + ASSAULTGROUP = 19, + SECTANTWARRIOR = 20, + SECTANTPRIEST = 21, + BOSSTAGILLA = 22, + FOLLOWERTAGILLA = 23, + EXUSEC = 24, + GIFTER = 25, + BOSSKNIGHT = 26, + FOLLOWERBIGPIPE = 27, + FOLLOWERBIRDEYE = 28, + BOSSZRYACHIY = 29, + FOLLOWERZRYACHIY = 30, + ARENAFIGHTEREVENT = 31 } diff --git a/types/models/external/HttpFramework.d.ts b/types/models/external/HttpFramework.d.ts index 3b4a56a..64a37d6 100644 --- a/types/models/external/HttpFramework.d.ts +++ b/types/models/external/HttpFramework.d.ts @@ -1,6 +1,6 @@ /// import { IncomingMessage, ServerResponse } from "http"; -export declare type HandleFn = (_: string, req: IncomingMessage, resp: ServerResponse) => void; +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 diff --git a/types/models/external/IPostAkiLoadModAsync.d.ts b/types/models/external/IPostAkiLoadModAsync.d.ts new file mode 100644 index 0000000..073ce6e --- /dev/null +++ b/types/models/external/IPostAkiLoadModAsync.d.ts @@ -0,0 +1,4 @@ +import { DependencyContainer } from "./tsyringe"; +export interface IPostAkiLoadModAsync { + postAkiLoadAsync(container: DependencyContainer): Promise; +} diff --git a/types/models/external/IPostDBLoadModAsync.d.ts b/types/models/external/IPostDBLoadModAsync.d.ts new file mode 100644 index 0000000..b23825a --- /dev/null +++ b/types/models/external/IPostDBLoadModAsync.d.ts @@ -0,0 +1,4 @@ +import { DependencyContainer } from "./tsyringe"; +export interface IPostDBLoadModAsync { + postDBLoadAsync(container: DependencyContainer): Promise; +} diff --git a/types/models/external/IPreAkiLoadModAsync.d.ts b/types/models/external/IPreAkiLoadModAsync.d.ts new file mode 100644 index 0000000..1249ff1 --- /dev/null +++ b/types/models/external/IPreAkiLoadModAsync.d.ts @@ -0,0 +1,4 @@ +import { DependencyContainer } from "./tsyringe"; +export interface IPreAkiLoadModAsync { + preAkiLoadAsync(container: DependencyContainer): Promise; +} 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/bots/GenerateWeaponResult.d.ts b/types/models/spt/bots/GenerateWeaponResult.d.ts index f099752..56fa481 100644 --- a/types/models/spt/bots/GenerateWeaponResult.d.ts +++ b/types/models/spt/bots/GenerateWeaponResult.d.ts @@ -3,7 +3,8 @@ import { Item } from "../../eft/common/tables/IItem"; import { ITemplateItem } from "../../eft/common/tables/ITemplateItem"; export declare class GenerateWeaponResult { weapon: Item[]; - chosenAmmo: string; + chosenAmmoTpl: string; + chosenUbglAmmoTpl: string; weaponMods: Mods; weaponTemplate: ITemplateItem; } diff --git a/types/models/spt/bots/BotLootCache.d.ts b/types/models/spt/bots/IBotLootCache.d.ts similarity index 94% rename from types/models/spt/bots/BotLootCache.d.ts rename to types/models/spt/bots/IBotLootCache.d.ts index aedf7b0..bf0ef61 100644 --- a/types/models/spt/bots/BotLootCache.d.ts +++ b/types/models/spt/bots/IBotLootCache.d.ts @@ -1,5 +1,5 @@ import { ITemplateItem } from "../../eft/common/tables/ITemplateItem"; -export declare class BotLootCache { +export interface IBotLootCache { backpackLoot: ITemplateItem[]; pocketLoot: ITemplateItem[]; vestLoot: ITemplateItem[]; 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/callbacks/IDialogueCallbacks.d.ts b/types/models/spt/callbacks/IDialogueCallbacks.d.ts index fe2115a..445178e 100644 --- a/types/models/spt/callbacks/IDialogueCallbacks.d.ts +++ b/types/models/spt/callbacks/IDialogueCallbacks.d.ts @@ -1,19 +1,19 @@ -import { IGetBodyResponseData } from "../../eft/httpResponse/IGetBodyResponseData"; -import { INullResponseData } from "../../eft/httpResponse/INullResponseData"; -import { IGetMailDialogViewRequestData } from "../../eft/dialog/IGetMailDialogViewRequestData"; -import { IGetMailDialogInfoRequestData } from "../../eft/dialog/IGetMailDialogInfoRequestData"; -import { IRemoveDialogRequestData } from "../../eft/dialog/IRemoveDialogRequestData"; -import { IGetMailDialogListRequestData } from "../../eft/dialog/IGetMailDialogListRequestData"; import { IEmptyRequestData } from "../../eft/common/IEmptyRequestData"; import { IFriendRequestData } from "../../eft/dialog/IFriendRequestData"; -import { IPinDialogRequestData } from "../../eft/dialog/IPinDialogRequestData"; -import { ISetDialogReadRequestData } from "../../eft/dialog/ISetDialogReadRequestData"; import { IGetAllAttachmentsRequestData } from "../../eft/dialog/IGetAllAttachmentsRequestData"; +import { IGetAllAttachmentsResponse } from "../../eft/dialog/IGetAllAttachmentsResponse"; import { IGetChatServerListRequestData } from "../../eft/dialog/IGetChatServerListRequestData"; import { IGetFriendListDataResponse } from "../../eft/dialog/IGetFriendListDataResponse"; -import { ISendMessageRequest } from "../../eft/dialog/ISendMessageRequest"; +import { IGetMailDialogInfoRequestData } from "../../eft/dialog/IGetMailDialogInfoRequestData"; +import { IGetMailDialogListRequestData } from "../../eft/dialog/IGetMailDialogListRequestData"; +import { IGetMailDialogViewRequestData } from "../../eft/dialog/IGetMailDialogViewRequestData"; import { IGetMailDialogViewResponseData } from "../../eft/dialog/IGetMailDialogViewResponseData"; -import { IGetAllAttachmentsResponse } from "../../eft/dialog/IGetAllAttachmentsResponse"; +import { IPinDialogRequestData } from "../../eft/dialog/IPinDialogRequestData"; +import { IRemoveDialogRequestData } from "../../eft/dialog/IRemoveDialogRequestData"; +import { ISendMessageRequest } from "../../eft/dialog/ISendMessageRequest"; +import { ISetDialogReadRequestData } from "../../eft/dialog/ISetDialogReadRequestData"; +import { IGetBodyResponseData } from "../../eft/httpResponse/IGetBodyResponseData"; +import { INullResponseData } from "../../eft/httpResponse/INullResponseData"; import { DialogueInfo } from "../../eft/profile/IAkiProfile"; export interface IDialogueCallbacks { getFriendList(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; @@ -28,7 +28,7 @@ export interface IDialogueCallbacks { 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; + sendFriendRequest(url: string, request: IFriendRequestData, sessionID: string): INullResponseData; sendMessage(url: string, request: ISendMessageRequest, sessionID: string): IGetBodyResponseData; update(): boolean; } diff --git a/types/models/spt/callbacks/IHideoutCallbacks.d.ts b/types/models/spt/callbacks/IHideoutCallbacks.d.ts index e9badb6..ad2af48 100644 --- a/types/models/spt/callbacks/IHideoutCallbacks.d.ts +++ b/types/models/spt/callbacks/IHideoutCallbacks.d.ts @@ -6,7 +6,7 @@ import { IHideoutPutItemInRequestData } from "../../eft/hideout/IHideoutPutItemI import { IHideoutTakeItemOutRequestData } from "../../eft/hideout/IHideoutTakeItemOutRequestData"; import { IHideoutToggleAreaRequestData } from "../../eft/hideout/IHideoutToggleAreaRequestData"; import { IHideoutSingleProductionStartRequestData } from "../../eft/hideout/IHideoutSingleProductionStartRequestData"; -import { IHideoutContinousProductionStartRequestData } from "../../eft/hideout/IHideoutContinousProductionStartRequestData"; +import { IHideoutContinuousProductionStartRequestData } from "../../eft/hideout/IHideoutContinuousProductionStartRequestData"; import { IHideoutTakeProductionRequestData } from "../../eft/hideout/IHideoutTakeProductionRequestData"; import { IItemEventRouterResponse } from "../../eft/itemEvent/IItemEventRouterResponse"; export interface IHideoutCallbacks { @@ -17,7 +17,7 @@ export interface IHideoutCallbacks { toggleArea(pmcData: IPmcData, body: IHideoutToggleAreaRequestData, sessionID: string): IItemEventRouterResponse; singleProductionStart(pmcData: IPmcData, body: IHideoutSingleProductionStartRequestData, sessionID: string): IItemEventRouterResponse; scavCaseProductionStart(pmcData: IPmcData, body: IHideoutScavCaseStartRequestData, sessionID: string): IItemEventRouterResponse; - continuousProductionStart(pmcData: IPmcData, body: IHideoutContinousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; + continuousProductionStart(pmcData: IPmcData, body: IHideoutContinuousProductionStartRequestData, sessionID: string): IItemEventRouterResponse; takeProduction(pmcData: IPmcData, body: IHideoutTakeProductionRequestData, sessionID: string): IItemEventRouterResponse; update(timeSinceLastRun: number): boolean; } diff --git a/types/models/spt/callbacks/IMatchCallbacks.d.ts b/types/models/spt/callbacks/IMatchCallbacks.d.ts deleted file mode 100644 index fcbf173..0000000 --- a/types/models/spt/callbacks/IMatchCallbacks.d.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { IStartOfflineRaidRequestData } from "../../eft/match/IStartOffineRaidRequestData"; -import { IEndOfflineRaidRequestData } from "../../eft/match/IEndOfflineRaidRequestData"; -import { INullResponseData } from "../../eft/httpResponse/INullResponseData"; -import { IGetBodyResponseData } from "../../eft/httpResponse/IGetBodyResponseData"; -import { IPmcData } from "../../eft/common/IPmcData"; -export interface IMatchCallbacks { - updatePing(url: string, info: any, sessionID: string): INullResponseData; - exitMatch(url: string, info: any, sessionID: string): INullResponseData; - exitToMenu(url: string, info: any, sessionID: string): INullResponseData; - startGroupSearch(url: string, info: any, sessionID: string): INullResponseData; - stopGroupSearch(url: string, info: any, sessionID: string): INullResponseData; - sendGroupInvite(url: string, info: any, sessionID: string): INullResponseData; - acceptGroupInvite(url: string, info: any, sessionID: string): INullResponseData; - cancelGroupInvite(url: string, info: any, sessionID: string): INullResponseData; - putMetrics(url: string, info: any, sessionID: string): INullResponseData; - getProfile(url: string, info: any, sessionID: string): IGetBodyResponseData; - serverAvailable(url: string, info: any, sessionID: string): IGetBodyResponseData | IGetBodyResponseData; - joinMatch(url: string, info: any, sessionID: string): IGetBodyResponseData; - getMetrics(url: string, info: any, sessionID: string): IGetBodyResponseData; - getGroupStatus(url: string, info: any, sessionID: string): IGetBodyResponseData; - createGroup(url: string, info: any, sessionID: string): IGetBodyResponseData; - deleteGroup(url: string, info: any, sessionID: string): INullResponseData; - startOfflineRaid(url: string, info: IStartOfflineRaidRequestData, sessionID: string): INullResponseData; - endOfflineRaid(url: string, info: IEndOfflineRaidRequestData, sessionID: string): INullResponseData; -} diff --git a/types/models/spt/callbacks/ITraderCallbacks.d.ts b/types/models/spt/callbacks/ITraderCallbacks.d.ts index e0d7d06..b784408 100644 --- a/types/models/spt/callbacks/ITraderCallbacks.d.ts +++ b/types/models/spt/callbacks/ITraderCallbacks.d.ts @@ -1,10 +1,9 @@ import { IEmptyRequestData } from "../../eft/common/IEmptyRequestData"; -import { IBarterScheme, ITraderAssort, ITraderBase } from "../../eft/common/tables/ITrader"; +import { ITraderAssort, ITraderBase } from "../../eft/common/tables/ITrader"; import { IGetBodyResponseData } from "../../eft/httpResponse/IGetBodyResponseData"; export interface ITraderCallbacks { load(): void; getTraderSettings(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; - getProfilePurchases(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData>; getTrader(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; getAssort(url: string, info: IEmptyRequestData, sessionID: string): IGetBodyResponseData; update(): boolean; diff --git a/types/models/spt/config/IAirdropConfig.d.ts b/types/models/spt/config/IAirdropConfig.d.ts index 53df991..cc3dd4e 100644 --- a/types/models/spt/config/IAirdropConfig.d.ts +++ b/types/models/spt/config/IAirdropConfig.d.ts @@ -1,14 +1,18 @@ +import { AirdropTypeEnum } from "../../../models/enums/AirdropType"; import { MinMax } from "../../common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface IAirdropConfig extends IBaseConfig { kind: "aki-airdrop"; airdropChancePercent: AirdropChancePercent; + airdropTypeWeightings: Record; planeMinFlyHeight: number; planeMaxFlyHeight: number; planeVolume: number; + planeSpeed: number; + crateFallSpeed: number; airdropMinStartTimeSeconds: number; airdropMaxStartTimeSeconds: number; - loot: AirdropLoot; + loot: Record; } export interface AirdropChancePercent { bigmap: number; @@ -17,14 +21,15 @@ export interface AirdropChancePercent { shoreline: number; interchange: number; reserve: number; + tarkovStreets: number; } export interface AirdropLoot { - presetCount: MinMax; + presetCount?: MinMax; itemCount: MinMax; itemBlacklist: string[]; itemTypeWhitelist: string[]; /** key: item base type: value: max count */ itemLimits: Record; itemStackLimits: Record; - armorLevelWhitelist: number[]; + armorLevelWhitelist?: number[]; } diff --git a/types/models/spt/config/IBotConfig.d.ts b/types/models/spt/config/IBotConfig.d.ts index d6fa5e0..2e8716e 100644 --- a/types/models/spt/config/IBotConfig.d.ts +++ b/types/models/spt/config/IBotConfig.d.ts @@ -1,3 +1,4 @@ +import { MinMaxWithWhitelist } from "../../../models/eft/common/tables/IBotType"; import { MinMax } from "../../common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; import { IBotDurability } from "./IBotDurability"; @@ -25,6 +26,7 @@ export interface IBotConfig extends IBaseConfig { showTypeInNickname: boolean; /** Max number of bots that can be spawned in a raid at any one time */ maxBotCap: Record; + chanceAssaultScavHasPlayerScavName: number; /** 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 */ @@ -66,10 +68,14 @@ export interface LootNvalue { } export interface EquipmentFilters { weaponModLimits: ModLimits; - randomisedWeaponModSlots?: string[]; - randomisedArmorSlots?: string[]; + weaponSightWhitelist: Record; faceShieldIsActiveChancePercent?: number; - lightLaserIsActiveChancePercent?: number; + lightIsActiveDayChancePercent?: number; + lightIsActiveNightChancePercent?: number; + laserIsActiveChancePercent?: number; + nvgIsActiveChanceDayPercent?: number; + nvgIsActiveChanceNightPercent?: number; + randomisation: RandomisationDetails[]; blacklist: EquipmentFilterDetails[]; whitelist: EquipmentFilterDetails[]; clothing: WeightingAdjustmentDetails[]; @@ -81,6 +87,16 @@ 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; + generation?: Record; + randomisedWeaponModSlots?: string[]; + randomisedArmorSlots?: string[]; + /** Equipment chances */ + equipment?: Record; + /** Modc chances */ + mods?: Record; +} export interface EquipmentFilterDetails { levelRange: MinMax; equipment: Record; @@ -88,6 +104,11 @@ export interface EquipmentFilterDetails { } 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/IBotDurability.d.ts b/types/models/spt/config/IBotDurability.d.ts index 38a47cc..a4ff53c 100644 --- a/types/models/spt/config/IBotDurability.d.ts +++ b/types/models/spt/config/IBotDurability.d.ts @@ -14,19 +14,9 @@ export interface IBotDurability { } /** Durability values to be used when a more specific bot type cant be found */ export interface DefaultDurability { - armor: DefaultArmor; + armor: ArmorDurability; weapon: WeaponDurability; } -export interface DefaultArmor { - maxDelta: number; - minDelta: number; -} -export interface WeaponDurability { - lowestMax: number; - highestMax: number; - maxDelta: number; - minDelta: number; -} export interface PmcDurability { armor: PmcDurabilityArmor; weapon: WeaponDurability; @@ -44,4 +34,12 @@ export interface BotDurability { export interface ArmorDurability { maxDelta: number; minDelta: number; + minLimitPercent: number; +} +export interface WeaponDurability { + lowestMax: number; + highestMax: number; + maxDelta: number; + minDelta: number; + minLimitPercent: number; } diff --git a/types/models/spt/config/ICoreConfig.d.ts b/types/models/spt/config/ICoreConfig.d.ts index cfcaf61..c37f81f 100644 --- a/types/models/spt/config/ICoreConfig.d.ts +++ b/types/models/spt/config/ICoreConfig.d.ts @@ -4,4 +4,7 @@ export interface ICoreConfig extends IBaseConfig { akiVersion: string; projectName: string; compatibleTarkovVersion: string; + serverName: string; + profileSaveIntervalSeconds: number; + commit: string; } diff --git a/types/models/spt/config/IHideoutConfig.d.ts b/types/models/spt/config/IHideoutConfig.d.ts index f232052..0785f1e 100644 --- a/types/models/spt/config/IHideoutConfig.d.ts +++ b/types/models/spt/config/IHideoutConfig.d.ts @@ -3,9 +3,5 @@ export interface IHideoutConfig extends IBaseConfig { kind: "aki-hideout"; runIntervalSeconds: number; hoursForSkillCrafting: number; - generatorSpeedWithoutFuel: number; - generatorFuelFlowRate: number; - airFilterUnitFlowRate: number; - /** SEE HIDEOUTHELPER BEFORE CHANGING CONFIG */ - gpuBoostRate: number; + hideoutWallAppearTimeSeconds: number; } diff --git a/types/models/spt/config/IHttpConfig.d.ts b/types/models/spt/config/IHttpConfig.d.ts index 3fe4787..aff7aec 100644 --- a/types/models/spt/config/IHttpConfig.d.ts +++ b/types/models/spt/config/IHttpConfig.d.ts @@ -4,4 +4,7 @@ export interface IHttpConfig extends IBaseConfig { kind: "aki-http"; ip: string; port: number; + logRequests: boolean; + /** e.g. "Aki_Data/Server/images/traders/579dc571d53a0658a154fbec.png": "Aki_Data/Server/images/traders/NewTraderImage.png" */ + serverImagePathOverride: Record; } diff --git a/types/models/spt/config/IInsuranceConfig.d.ts b/types/models/spt/config/IInsuranceConfig.d.ts index b27e753..fd498bc 100644 --- a/types/models/spt/config/IInsuranceConfig.d.ts +++ b/types/models/spt/config/IInsuranceConfig.d.ts @@ -5,5 +5,6 @@ export interface IInsuranceConfig extends IBaseConfig { returnChancePercent: Record; blacklistedEquipment: string[]; slotIdsWithChanceOfNotReturning: string[]; + returnTimeOverrideSeconds: number; runIntervalSeconds: number; } diff --git a/types/models/spt/config/IInventoryConfig.d.ts b/types/models/spt/config/IInventoryConfig.d.ts index 4642b9b..3ad0cce 100644 --- a/types/models/spt/config/IInventoryConfig.d.ts +++ b/types/models/spt/config/IInventoryConfig.d.ts @@ -3,6 +3,8 @@ export interface IInventoryConfig extends IBaseConfig { kind: "aki-inventory"; newItemsMarkedFound: boolean; randomLootContainers: Record; + /** Contains item tpls that the server should consider money and treat the same as roubles/euros/dollars */ + customMoneyTpls: string[]; } export interface RewardDetails { rewardCount: number; diff --git a/types/models/spt/config/ILocationConfig.d.ts b/types/models/spt/config/ILocationConfig.d.ts index 0551d57..bcd91cc 100644 --- a/types/models/spt/config/ILocationConfig.d.ts +++ b/types/models/spt/config/ILocationConfig.d.ts @@ -1,8 +1,36 @@ +import { BossLocationSpawn, Wave } from "../../../models/eft/common/ILocationBase"; import { IBaseConfig } from "./IBaseConfig"; export interface ILocationConfig extends IBaseConfig { kind: "aki-location"; + fixEmptyBotWavesSettings: IFixEmptyBotWavesSettings; + rogueLighthouseSpawnTimeSettings: IRogueLighthouseSpawnTimeSettings; + splitWaveIntoSingleSpawnsSettings: ISplitWaveSettings; looseLootMultiplier: LootMultiplier; staticLootMultiplier: LootMultiplier; + customWaves: CustomWaves; + /** Open zones to add to map */ + openZones: Record; + /** Key = map id, value = item tpls that should only have one forced loot spawn position */ + forcedLootSingleSpawnById: Record; + /** How many attempts should be taken to fit an item into a container before giving up */ + fitLootIntoContainerAttempts: number; +} +export interface IFixEmptyBotWavesSettings { + enabled: boolean; + ignoreMaps: string[]; +} +export interface IRogueLighthouseSpawnTimeSettings { + enabled: boolean; + waitTimeSeconds: number; +} +export interface ISplitWaveSettings { + enabled: boolean; + ignoreMaps: string[]; + waveSizeThreshold: number; +} +export interface CustomWaves { + boss: Record; + normal: Record; } export interface LootMultiplier { bigmap: number; diff --git a/types/models/spt/config/ILostOnDeathConfig.d.ts b/types/models/spt/config/ILostOnDeathConfig.d.ts new file mode 100644 index 0000000..b557afe --- /dev/null +++ b/types/models/spt/config/ILostOnDeathConfig.d.ts @@ -0,0 +1,21 @@ +import { IBaseConfig } from "./IBaseConfig"; +export interface ILostOnDeathConfig extends IBaseConfig { + kind: "aki-lostondeath"; + equipment: Equipment; + specialSlotItems: boolean; + questItems: boolean; +} +export interface Equipment { + ArmBand: boolean; + Headwear: boolean; + Earpiece: boolean; + FaceCover: boolean; + ArmorVest: boolean; + Eyewear: boolean; + TacticalVest: boolean; + Backpack: boolean; + Holster: boolean; + FirstPrimaryWeapon: boolean; + SecondPrimaryWeapon: boolean; + Scabbard: boolean; +} diff --git a/types/models/spt/config/IPlayerScavConfig.d.ts b/types/models/spt/config/IPlayerScavConfig.d.ts index 5ac3966..3a65e83 100644 --- a/types/models/spt/config/IPlayerScavConfig.d.ts +++ b/types/models/spt/config/IPlayerScavConfig.d.ts @@ -9,6 +9,7 @@ export interface KarmaLevel { modifiers: Modifiers; itemLimits: ItemLimits; equipmentBlacklist: Record; + labsAccessCardChancePercent: number; } export interface Modifiers { equipment: Record; diff --git a/types/models/spt/config/IPmChatResponse.d.ts b/types/models/spt/config/IPmChatResponse.d.ts new file mode 100644 index 0000000..c48b274 --- /dev/null +++ b/types/models/spt/config/IPmChatResponse.d.ts @@ -0,0 +1,13 @@ +import { IBaseConfig } from "./IBaseConfig"; +export interface IPmcChatResponse extends IBaseConfig { + kind: "aki-pmcchatresponse"; + victim: IResponseSettings; + killer: IResponseSettings; +} +export interface IResponseSettings { + responseChancePercent: number; + responseTypeWeights: Record; + stripCapitalisationChancePercent: number; + allCapsChancePercent: number; + appendBroToMessageEndChancePercent: number; +} diff --git a/types/models/spt/config/IPmcConfig.d.ts b/types/models/spt/config/IPmcConfig.d.ts index 48601b2..87098da 100644 --- a/types/models/spt/config/IPmcConfig.d.ts +++ b/types/models/spt/config/IPmcConfig.d.ts @@ -1,5 +1,8 @@ import { MinMax } from "../../common/MinMax"; export interface IPmcConfig { + vestLoot: SlotLootSettings; + pocketLoot: SlotLootSettings; + backpackLoot: SlotLootSettings; dynamicLoot: DynamicLoot; useDifficultyOverride: boolean; difficulty: string; @@ -16,13 +19,17 @@ export interface IPmcConfig { maxVestLootTotalRub: number; convertIntoPmcChance: Record; enemyTypes: string[]; + botRelativeLevelDeltaMax: number; } export interface PmcTypes { usec: string; bear: string; } -export interface DynamicLoot { +export interface SlotLootSettings { whitelist: string[]; blacklist: string[]; moneyStackLimits: Record; } +export interface DynamicLoot { + moneyStackLimits: Record; +} diff --git a/types/models/spt/config/IQuestConfig.d.ts b/types/models/spt/config/IQuestConfig.d.ts index 45c9aae..94c00fd 100644 --- a/types/models/spt/config/IQuestConfig.d.ts +++ b/types/models/spt/config/IQuestConfig.d.ts @@ -1,14 +1,27 @@ +import { MinMax } from "../../../models/common/MinMax"; import { ELocationName } from "../../enums/ELocationName"; import { IBaseConfig } from "./IBaseConfig"; export interface IQuestConfig extends IBaseConfig { kind: "aki-quest"; redeemTime: number; + questTemplateIds: IPlayerTypeQuestIds; repeatableQuests: IRepeatableQuestConfig[]; + locationIdMap: Record; bearOnlyQuests: string[]; usecOnlyQuests: string[]; } +export interface IPlayerTypeQuestIds { + pmc: IQuestTypeIds; + scav: IQuestTypeIds; +} +export interface IQuestTypeIds { + Elimination: string; + Completion: string; + Exploration: string; +} export interface IRepeatableQuestConfig { name: string; + side: string; types: string[]; resetTime: number; numQuests: number; @@ -16,11 +29,12 @@ export interface IRepeatableQuestConfig { rewardScaling: IRewardScaling; locations: Record; traderWhitelist: ITraderWhitelist[]; - questConfig: IQuestConfig; + questConfig: IRepeatableQuestTypesConfig; /** Item base types to block when generating rewards */ rewardBaseTypeBlacklist: string[]; /** Item tplIds to ignore when generating rewards */ rewardBlacklist: string[]; + rewardAmmoStackMinSize: number; } export interface IRewardScaling { levels: number[]; @@ -34,10 +48,10 @@ export interface ITraderWhitelist { traderId: string; questTypes: string[]; } -export interface IQuestConfig { +export interface IRepeatableQuestTypesConfig { Exploration: IExploration; Completion: ICompletion; - Elimination: IElimination; + Elimination: IEliminationConfig[]; } export interface IExploration { maxExtracts: number; @@ -55,7 +69,8 @@ export interface ICompletion { useWhitelist: boolean; useBlacklist: boolean; } -export interface IElimination { +export interface IEliminationConfig { + levelRange: MinMax; targets: ITarget[]; bodyPartProb: number; bodyParts: IBodyPart[]; @@ -67,11 +82,6 @@ export interface IElimination { maxKills: number; minKills: number; } -export interface IProbabilityObject { - key: string; - relativeProbability: number; - data?: any; -} export interface ITarget extends IProbabilityObject { data: IBossInfo; } @@ -81,3 +91,8 @@ export interface IBossInfo { export interface IBodyPart extends IProbabilityObject { data: string[]; } +export interface IProbabilityObject { + key: string; + relativeProbability: number; + data?: any; +} diff --git a/types/models/spt/config/IRagfairConfig.d.ts b/types/models/spt/config/IRagfairConfig.d.ts index 6786417..1eb640b 100644 --- a/types/models/spt/config/IRagfairConfig.d.ts +++ b/types/models/spt/config/IRagfairConfig.d.ts @@ -2,21 +2,31 @@ import { MinMax } from "../../common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface IRagfairConfig extends IBaseConfig { kind: "aki-ragfair"; + /** How many seconds should pass before expired offers and procesed + player offers checked if sold */ runIntervalSeconds: number; + /** Player listing settings */ sell: Sell; + /** Trader ids + should their assorts be listed on flea*/ traders: Record; dynamic: Dynamic; } export interface Sell { + /** Should a fee be deducted from player when liting an item for sale */ fees: boolean; + /** Settings to control chances of offer being sold */ chance: Chance; + /** Settings to control how long it takes for a player offer to sell */ time: Time; + /** Player offer reputation gain/loss settings */ reputation: Reputation; + /** How many hours are simulated to figure out if player offer was sold */ simulatedSellHours: number; + /**Seconds from clicking remove to remove offer from market */ + expireSeconds: number; } export interface Chance { base: number; - overprices: number; + overpriced: number; underpriced: number; } export interface Time { @@ -29,47 +39,80 @@ export interface Reputation { loss: number; } export interface Dynamic { + purchasesAreFoundInRaid: boolean; + /** Use the highest trader price for an offer if its greater than the price in templates/prices.json */ + useTraderPriceForOffersIfHigher: boolean; + /** Barter offer specific settings */ barter: Barter; + /** Dynamic offer price below handbook adjustment values */ offerAdjustment: OfferAdjustment; + /** How many offers should expire before an offer regeneration occurs */ expiredOfferThreshold: number; + /** How many offers should be listed */ offerItemCount: MinMax; + /** How much should the price of an offer vary by (percent 0.8 = 80%, 1.2 = 120%) */ price: MinMax; + /** How much should the price of an offer vary by (percent 0.8 = 80%, 1.2 = 120%) */ presetPrice: MinMax; + /** Should default presets to listed only or should non-standard presets found in globals.json be listed too */ showDefaultPresetsOnly: boolean; endTimeSeconds: MinMax; + /** Settings to control the durability range of item items listed on flea */ condition: Condition; + /** Size stackable items should be listed for in percent of max stack size */ stackablePercent: MinMax; + /** Items that cannot be stacked can have multiples sold in one offer, what range of values can be listed */ nonStackableCount: MinMax; + /** Range of rating offers for items being listed */ rating: MinMax; + /** Percentages to sell offers in each currency */ currencies: Record; + /** Item tpls that should be forced to sell as a single item */ showAsSingleStack: string[]; + /** Should christmas/halloween items be removed from flea when not within the seasonal bounds */ + removeSeasonalItemsWhenNotInEvent: boolean; + /** Flea blacklist settings */ blacklist: Blacklist; } -export declare class Barter { +export interface Barter { + /** Should barter offers be generated */ enable: boolean; + /** Percentage change an offer is listed as a barter */ chancePercent: number; + /** Min number of required items for a barter requirement */ itemCountMin: number; + /** Max number of required items for a barter requirement */ itemCountMax: number; + /** How much can the total price of requested items vary from the item offered */ priceRangeVariancePercent: number; + /** Min rouble price for an offer to be considered for turning into a barter */ minRoubleCostToBecomeBarter: number; + /** Item Tpls to never be turned into a barter */ itemTypeBlacklist: string[]; } -export declare class OfferAdjustment { +export interface OfferAdjustment { + /** Shuld offer price be adjusted when below handbook price */ + adjustPriceWhenBelowHandbookPrice: boolean; + /** How big a percentage difference does price need to vary from handbook to be considered for adjustment */ maxPriceDifferenceBelowHandbookPercent: number; + /** How much to multiply the handbook price to get the new price */ handbookPriceMultipier: number; + /** What is the minimum rouble price to consider adjusting price of item */ priceThreshholdRub: number; } export interface Condition { + /** Percentage change durability is altered */ conditionChance: number; min: number; max: number; } export interface Blacklist { - /** - * show/hide trader items that are blacklisted by bsg - */ - traderItems: boolean; + /** Custom blacklist for item Tpls */ custom: string[]; + /** BSG blacklist a large number of items from flea, true = use blacklist */ enableBsgList: boolean; + /** Should quest items be blacklisted from flea */ enableQuestList: boolean; + /** Should trader items that are blacklisted by bsg */ + traderItems: boolean; } diff --git a/types/models/spt/config/IRepairConfig.d.ts b/types/models/spt/config/IRepairConfig.d.ts index 23e6838..b6db332 100644 --- a/types/models/spt/config/IRepairConfig.d.ts +++ b/types/models/spt/config/IRepairConfig.d.ts @@ -1,7 +1,25 @@ +import { MinMax } from "../../../models/common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface IRepairConfig extends IBaseConfig { kind: "aki-repair"; priceMultiplier: number; applyRandomizeDurabilityLoss: boolean; weaponSkillRepairGain: number; + armorKitSkillPointGainPerRepairPointMultiplier: number; + repairKit: RepairKit; +} +export interface RepairKit { + armor: BonusSettings; + weapon: BonusSettings; +} +export interface BonusSettings { + rarityWeight: Record; + bonusTypeWeight: Record; + common: Record; + rare: Record; +} +export interface BonusValues { + valuesMinMax: MinMax; + /** What dura is buff active between (min max of current max) */ + activeDurabilityPercentMinMax: MinMax; } diff --git a/types/models/spt/config/ISeasonalEventConfig.d.ts b/types/models/spt/config/ISeasonalEventConfig.d.ts index e410925..cedf9a9 100644 --- a/types/models/spt/config/ISeasonalEventConfig.d.ts +++ b/types/models/spt/config/ISeasonalEventConfig.d.ts @@ -5,6 +5,7 @@ export interface ISeasonalEventConfig extends IBaseConfig { /** event / botType / equipSlot / itemid */ eventGear: Record>>>; events: ISeasonalEvent[]; + gifterSettings: GifterSetting[]; } export interface ISeasonalEvent { name: string; @@ -13,3 +14,8 @@ export interface ISeasonalEvent { endDay: number; endMonth: number; } +export interface GifterSetting { + map: string; + zones: string; + spawnChance: number; +} diff --git a/types/models/spt/config/ITraderConfig.d.ts b/types/models/spt/config/ITraderConfig.d.ts index 8342c99..832f22a 100644 --- a/types/models/spt/config/ITraderConfig.d.ts +++ b/types/models/spt/config/ITraderConfig.d.ts @@ -1,10 +1,12 @@ +import { MinMax } from "../../../models/common/MinMax"; import { IBaseConfig } from "./IBaseConfig"; export interface ITraderConfig extends IBaseConfig { kind: "aki-trader"; updateTime: UpdateTime[]; + purchasesAreFoundInRaid: boolean; updateTimeDefault: number; traderPriceMultipler: number; - minDurabilityForSale: number; + persistPurchaseDataInProfile: boolean; fence: FenceConfig; } export interface UpdateTime { @@ -12,13 +14,21 @@ export interface UpdateTime { seconds: number; } export interface FenceConfig { + discountOptions: DiscountOptions; partialRefreshTimeSeconds: number; partialRefreshChangePercent: number; assortSize: number; maxPresetsPercent: number; - presetPriceMult: number; itemPriceMult: number; - regenerateAssortsOnRefresh: boolean; + presetPriceMult: number; + armorMaxDurabilityPercentMinMax: MinMax; + presetMaxDurabilityPercentMinMax: MinMax; itemTypeLimits: Record; + regenerateAssortsOnRefresh: boolean; blacklist: string[]; } +export interface DiscountOptions { + assortSize: number; + itemPriceMult: number; + presetPriceMult: number; +} diff --git a/types/models/spt/mod/IMod.d.ts b/types/models/spt/mod/IMod.d.ts deleted file mode 100644 index e6eec79..0000000 --- a/types/models/spt/mod/IMod.d.ts +++ /dev/null @@ -1,10 +0,0 @@ -export declare namespace ModLoader { - interface IMod { - name: string; - version: string; - main?: string; - author?: string; - license: string; - dependencies?: Record; - } -} diff --git a/types/models/spt/mod/IModLoader.d.ts b/types/models/spt/mod/IModLoader.d.ts index 40a5e19..9a71f61 100644 --- a/types/models/spt/mod/IModLoader.d.ts +++ b/types/models/spt/mod/IModLoader.d.ts @@ -1,7 +1,5 @@ import { DependencyContainer } from "tsyringe"; export interface IModLoader { load(container: DependencyContainer): void; - getBundles(local: boolean): string; - getBundle(key: string, local: boolean): void; getModPath(mod: string): string; } diff --git a/types/models/spt/mod/IPackageJsonData.d.ts b/types/models/spt/mod/IPackageJsonData.d.ts index 99e4ef9..06f7454 100644 --- a/types/models/spt/mod/IPackageJsonData.d.ts +++ b/types/models/spt/mod/IPackageJsonData.d.ts @@ -1,6 +1,6 @@ export interface IPackageJsonData { incompatibilities?: string[]; - dependencies?: string[]; + dependencies?: Record; modDependencies?: Record; name: string; author: string; @@ -8,5 +8,6 @@ export interface IPackageJsonData { akiVersion: string; licence: string; main: string; + isBundleMod: boolean; contributors: string[]; } diff --git a/types/models/spt/mod/NewItemDetails.d.ts b/types/models/spt/mod/NewItemDetails.d.ts index fc69a06..9e37cc9 100644 --- a/types/models/spt/mod/NewItemDetails.d.ts +++ b/types/models/spt/mod/NewItemDetails.d.ts @@ -4,6 +4,8 @@ export declare abstract class NewItemDetailsBase { fleaPriceRoubles: number; /** Price of the item in the handbook */ handbookPriceRoubles: number; + /** Handbook ParentId for the new item */ + handbookParentId: string; /** * A dictionary for locale settings, key = langauge (e.g. en,cn,es-mx,jp,fr) * If a language is not included, the first item in the array will be used in its place diff --git a/types/models/spt/server/IDatabaseTables.d.ts b/types/models/spt/server/IDatabaseTables.d.ts index 9978459..582d9e2 100644 --- a/types/models/spt/server/IDatabaseTables.d.ts +++ b/types/models/spt/server/IDatabaseTables.d.ts @@ -1,3 +1,4 @@ +import { IQteData } from "../../../models/eft/hideout/IQteData"; import { IGlobals } from "../../eft/common/IGlobals"; import { IBotBase } from "../../eft/common/tables/IBotBase"; import { IBotCore } from "../../eft/common/tables/IBotCore"; @@ -30,6 +31,7 @@ export interface IDatabaseTables { production: IHideoutProduction[]; scavcase: IHideoutScavCase[]; settings: IHideoutSettingsBase; + qte: IQteData[]; }; locales?: ILocaleBase; locations?: ILocations; @@ -38,10 +40,8 @@ export interface IDatabaseTables { templates?: { character: string[]; items: Record; - quests: IQuest[]; + quests: Record; repeatableQuests: IRepeatableQuestDatabase; - /** DEPRECATED - Items file found in the client, massivly out of date compared to templates.items, try not to use this, remove ASAP*/ - clientItems: Record; handbook: IHandbookBase; customization: Record; /** The profile templates listed in the launcher on profile creation, split by account type (e.g. Standard) then side (e.g. bear/usec) */ diff --git a/types/models/spt/server/ILocaleBase.d.ts b/types/models/spt/server/ILocaleBase.d.ts index 6e20b89..3004cb8 100644 --- a/types/models/spt/server/ILocaleBase.d.ts +++ b/types/models/spt/server/ILocaleBase.d.ts @@ -1,49 +1,6 @@ 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; + server: Record>; } diff --git a/types/models/spt/server/ISettingsBase.d.ts b/types/models/spt/server/ISettingsBase.d.ts index c067cda..2870cfb 100644 --- a/types/models/spt/server/ISettingsBase.d.ts +++ b/types/models/spt/server/ISettingsBase.d.ts @@ -10,7 +10,9 @@ export interface Config { FirstCycleDelaySeconds: number; FramerateLimit: FramerateLimit; GroupStatusInterval: number; + GroupStatusButtonInterval: number; KeepAliveInterval: number; + LobbyKeepAliveInterval: number; Mark502and504AsNonImportant: boolean; MemoryManagementSettings: MemoryManagementSettings; NVidiaHighlights: boolean; @@ -18,7 +20,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 8c197ee..996a4de 100644 --- a/types/models/spt/services/LootRequest.d.ts +++ b/types/models/spt/services/LootRequest.d.ts @@ -1,5 +1,5 @@ import { MinMax } from "../../common/MinMax"; -export declare class LootRequest { +export interface LootRequest { presetCount: MinMax; itemCount: MinMax; itemBlacklist: string[]; diff --git a/types/routers/EventOutputHolder.d.ts b/types/routers/EventOutputHolder.d.ts index 7a2387b..9a34219 100644 --- a/types/routers/EventOutputHolder.d.ts +++ b/types/routers/EventOutputHolder.d.ts @@ -1,11 +1,41 @@ -import { JsonUtil } from "../utils/JsonUtil"; import { ProfileHelper } from "../helpers/ProfileHelper"; +import { IPmcData } from "../models/eft/common/IPmcData"; +import { IHideoutImprovement, Productive } from "../models/eft/common/tables/IBotBase"; import { IItemEventRouterResponse } from "../models/eft/itemEvent/IItemEventRouterResponse"; +import { JsonUtil } from "../utils/JsonUtil"; +import { TimeUtil } from "../utils/TimeUtil"; export declare class EventOutputHolder { protected jsonUtil: JsonUtil; protected profileHelper: ProfileHelper; - constructor(jsonUtil: JsonUtil, profileHelper: ProfileHelper); + protected timeUtil: TimeUtil; + /** What has client been informed of this game session */ + protected clientActiveSessionStorage: Record; + constructor(jsonUtil: JsonUtil, profileHelper: ProfileHelper, timeUtil: TimeUtil); protected output: IItemEventRouterResponse; getOutput(sessionID: string): IItemEventRouterResponse; + /** + * Reset the response object to a default state + * Occurs prior to event being handled by server + * @param sessionID Players id + */ resetOutput(sessionID: string): void; + /** + * Update output object with most recent values from player profile + * @param sessionId Session id + */ + updateOutputProperties(sessionId: string): void; + /** + * Return all hideout Improvements from player profile, adjust completed Improvements' completed property to be true + * @param pmcData Player profile + * @returns dictionary of hideout improvements + */ + protected getImprovementsFromProfileAndFlagComplete(pmcData: IPmcData): Record; + /** + * Return productions from player profile except those completed crafts the client has already seen + * @param pmcData Player profile + * @returns dictionary of hideout productions + */ + protected getProductionsFromProfileAndFlagComplete(productions: Record): Record; } diff --git a/types/routers/ItemEventRouter.d.ts b/types/routers/ItemEventRouter.d.ts index e80d16c..9c7f70e 100644 --- a/types/routers/ItemEventRouter.d.ts +++ b/types/routers/ItemEventRouter.d.ts @@ -1,14 +1,22 @@ -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 profileHelper: ProfileHelper; protected itemEventRouters: ItemEventRouterDefinition[]; + protected localisationService: LocalisationService; protected eventOutputHolder: EventOutputHolder; - constructor(logger: ILogger, profileHelper: ProfileHelper, itemEventRouters: ItemEventRouterDefinition[], eventOutputHolder: EventOutputHolder); + constructor(logger: ILogger, profileHelper: ProfileHelper, itemEventRouters: ItemEventRouterDefinition[], localisationService: LocalisationService, eventOutputHolder: EventOutputHolder); + /** + * + * @param info Event request + * @param sessionID Session id + * @returns Item response + */ handleEvents(info: IItemEventRouterRequest, sessionID: string): IItemEventRouterResponse; } diff --git a/types/routers/item_events/CustomizationItemEventRouter.d.ts b/types/routers/item_events/CustomizationItemEventRouter.d.ts index e78445e..32519b1 100644 --- a/types/routers/item_events/CustomizationItemEventRouter.d.ts +++ b/types/routers/item_events/CustomizationItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { CustomizationCallbacks } from "../../callbacks/CustomizationCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class CustomizationItemEventRouter extends ItemEventRouterDefinition { protected customizationCallbacks: CustomizationCallbacks; constructor(customizationCallbacks: CustomizationCallbacks); diff --git a/types/routers/item_events/HealthItemEventRouter.d.ts b/types/routers/item_events/HealthItemEventRouter.d.ts index 99847c6..2b2b91d 100644 --- a/types/routers/item_events/HealthItemEventRouter.d.ts +++ b/types/routers/item_events/HealthItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { HealthCallbacks } from "../../callbacks/HealthCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class HealthItemEventRouter extends ItemEventRouterDefinition { protected healthCallbacks: HealthCallbacks; constructor(healthCallbacks: HealthCallbacks); diff --git a/types/routers/item_events/InsuranceItemEventRouter.d.ts b/types/routers/item_events/InsuranceItemEventRouter.d.ts index a922cc0..3b6ae8c 100644 --- a/types/routers/item_events/InsuranceItemEventRouter.d.ts +++ b/types/routers/item_events/InsuranceItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { InsuranceCallbacks } from "../../callbacks/InsuranceCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class InsuranceItemEventRouter extends ItemEventRouterDefinition { protected insuranceCallbacks: InsuranceCallbacks; constructor(insuranceCallbacks: InsuranceCallbacks); diff --git a/types/routers/item_events/InventoryItemEventRouter.d.ts b/types/routers/item_events/InventoryItemEventRouter.d.ts index 953d322..d6a6ae5 100644 --- a/types/routers/item_events/InventoryItemEventRouter.d.ts +++ b/types/routers/item_events/InventoryItemEventRouter.d.ts @@ -1,10 +1,12 @@ +import { HideoutCallbacks } from "../../callbacks/HideoutCallbacks"; 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); + protected hideoutCallbacks: HideoutCallbacks; + constructor(inventoryCallbacks: InventoryCallbacks, hideoutCallbacks: HideoutCallbacks); getHandledRoutes(): HandledRoute[]; handleItemEvent(url: string, pmcData: IPmcData, body: any, sessionID: string): IItemEventRouterResponse; } diff --git a/types/routers/item_events/NoteItemEventRouter.d.ts b/types/routers/item_events/NoteItemEventRouter.d.ts index 59bf598..71ed5d4 100644 --- a/types/routers/item_events/NoteItemEventRouter.d.ts +++ b/types/routers/item_events/NoteItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { NoteCallbacks } from "../../callbacks/NoteCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class NoteItemEventRouter extends ItemEventRouterDefinition { protected noteCallbacks: NoteCallbacks; constructor(noteCallbacks: NoteCallbacks); diff --git a/types/routers/item_events/PresetBuildItemEventRouter.d.ts b/types/routers/item_events/PresetBuildItemEventRouter.d.ts index 277db44..f2a7bf3 100644 --- a/types/routers/item_events/PresetBuildItemEventRouter.d.ts +++ b/types/routers/item_events/PresetBuildItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { PresetBuildCallbacks } from "../../callbacks/PresetBuildCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class PresetBuildItemEventRouter extends ItemEventRouterDefinition { protected presetBuildCallbacks: PresetBuildCallbacks; constructor(presetBuildCallbacks: PresetBuildCallbacks); diff --git a/types/routers/item_events/RagfairItemEventRouter.d.ts b/types/routers/item_events/RagfairItemEventRouter.d.ts index 9216cc5..986d9e7 100644 --- a/types/routers/item_events/RagfairItemEventRouter.d.ts +++ b/types/routers/item_events/RagfairItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { RagfairCallbacks } from "../../callbacks/RagfairCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class RagfairItemEventRouter extends ItemEventRouterDefinition { protected ragfairCallbacks: RagfairCallbacks; constructor(ragfairCallbacks: RagfairCallbacks); diff --git a/types/routers/item_events/RepairItemEventRouter.d.ts b/types/routers/item_events/RepairItemEventRouter.d.ts index 5196ba9..1c2768c 100644 --- a/types/routers/item_events/RepairItemEventRouter.d.ts +++ b/types/routers/item_events/RepairItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { RepairCallbacks } from "../../callbacks/RepairCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class RepairItemEventRouter extends ItemEventRouterDefinition { protected repairCallbacks: RepairCallbacks; constructor(repairCallbacks: RepairCallbacks); diff --git a/types/routers/item_events/TradeItemEventRouter.d.ts b/types/routers/item_events/TradeItemEventRouter.d.ts index a43bb0a..5d84559 100644 --- a/types/routers/item_events/TradeItemEventRouter.d.ts +++ b/types/routers/item_events/TradeItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { TradeCallbacks } from "../../callbacks/TradeCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class TradeItemEventRouter extends ItemEventRouterDefinition { protected tradeCallbacks: TradeCallbacks; constructor(tradeCallbacks: TradeCallbacks); diff --git a/types/routers/item_events/WishlistItemEventRouter.d.ts b/types/routers/item_events/WishlistItemEventRouter.d.ts index 38497fb..9e3c2a0 100644 --- a/types/routers/item_events/WishlistItemEventRouter.d.ts +++ b/types/routers/item_events/WishlistItemEventRouter.d.ts @@ -1,7 +1,7 @@ -import { IPmcData } from "../../models/eft/common/IPmcData"; -import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; import { WishlistCallbacks } from "../../callbacks/WishlistCallbacks"; import { HandledRoute, ItemEventRouterDefinition } from "../../di/Router"; +import { IPmcData } from "../../models/eft/common/IPmcData"; +import { IItemEventRouterResponse } from "../../models/eft/itemEvent/IItemEventRouterResponse"; export declare class WishlistItemEventRouter extends ItemEventRouterDefinition { protected wishlistCallbacks: WishlistCallbacks; constructor(wishlistCallbacks: WishlistCallbacks); diff --git a/types/routers/save_load/HealthSaveLoadRouter.d.ts b/types/routers/save_load/HealthSaveLoadRouter.d.ts index 114f5b2..26cb07a 100644 --- a/types/routers/save_load/HealthSaveLoadRouter.d.ts +++ b/types/routers/save_load/HealthSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class HealthSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/save_load/InraidSaveLoadRouter.d.ts b/types/routers/save_load/InraidSaveLoadRouter.d.ts index 4c00b40..40f388e 100644 --- a/types/routers/save_load/InraidSaveLoadRouter.d.ts +++ b/types/routers/save_load/InraidSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class InraidSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/save_load/InsuranceSaveLoadRouter.d.ts b/types/routers/save_load/InsuranceSaveLoadRouter.d.ts index 30ce98e..22d645e 100644 --- a/types/routers/save_load/InsuranceSaveLoadRouter.d.ts +++ b/types/routers/save_load/InsuranceSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class InsuranceSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/save_load/ProfileSaveLoadRouter.d.ts b/types/routers/save_load/ProfileSaveLoadRouter.d.ts index 16c7619..f60af15 100644 --- a/types/routers/save_load/ProfileSaveLoadRouter.d.ts +++ b/types/routers/save_load/ProfileSaveLoadRouter.d.ts @@ -1,5 +1,5 @@ -import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; import { HandledRoute, SaveLoadRouter } from "../../di/Router"; +import { IAkiProfile } from "../../models/eft/profile/IAkiProfile"; export declare class ProfileSaveLoadRouter extends SaveLoadRouter { constructor(); getHandledRoutes(): HandledRoute[]; diff --git a/types/routers/serializers/ImageSerializer.d.ts b/types/routers/serializers/ImageSerializer.d.ts index 7f15bcf..5de48ff 100644 --- a/types/routers/serializers/ImageSerializer.d.ts +++ b/types/routers/serializers/ImageSerializer.d.ts @@ -1,7 +1,7 @@ /// +import { IncomingMessage, ServerResponse } from "http"; 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); diff --git a/types/servers/HttpServer.d.ts b/types/servers/HttpServer.d.ts index 80c1d48..97e0705 100644 --- a/types/servers/HttpServer.d.ts +++ b/types/servers/HttpServer.d.ts @@ -18,9 +18,12 @@ export declare class HttpServer { protected configServer: ConfigServer; protected applicationContext: ApplicationContext; protected webSocketServer: WebSocketServer; - constructor(logger: ILogger, databaseServer: DatabaseServer, httpServerHelper: HttpServerHelper, localisationService: LocalisationService, httpListeners: IHttpListener[], configServer: ConfigServer, applicationContext: ApplicationContext, webSocketServer: WebSocketServer); protected httpConfig: IHttpConfig; - getCookies(req: http.IncomingMessage): any; - handleRequest(req: IncomingMessage, resp: ServerResponse): void; + constructor(logger: ILogger, databaseServer: DatabaseServer, httpServerHelper: HttpServerHelper, localisationService: LocalisationService, httpListeners: IHttpListener[], configServer: ConfigServer, applicationContext: ApplicationContext, webSocketServer: WebSocketServer); + /** + * Handle server loading event + */ load(): void; + protected handleRequest(req: IncomingMessage, resp: ServerResponse): void; + protected getCookies(req: http.IncomingMessage): Record; } 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 4dca514..402befc 100644 --- a/types/servers/SaveServer.d.ts +++ b/types/servers/SaveServer.d.ts @@ -14,17 +14,71 @@ export declare class SaveServer { protected logger: ILogger; protected profileFilepath: string; protected profiles: {}; - protected onSave: {}; + protected onBeforeSaveCallbacks: {}; protected saveMd5: {}; constructor(vfs: VFS, saveLoadRouters: SaveLoadRouter[], jsonUtil: JsonUtil, hashUtil: HashUtil, localisationService: LocalisationService, logger: ILogger); + /** + * Add callback to occur prior to saving profile changes + * @param id Id for save callback + * @param callback Callback to execute prior to running SaveServer.saveProfile() + */ + addBeforeSaveCallback(id: string, callback: (profile: Partial) => Partial): void; + /** + * Remove a callback from being executed prior to saving profile in SaveServer.saveProfile() + * @param id Id of callback to remove + */ + removeBeforeSaveCallback(id: string): void; + /** + * Load all profiles in /user/profiles folder into memory (this.profiles) + */ load(): void; + /** + * Save changes for each profile from memory into user/profiles json + */ save(): void; + /** + * Get a player profile from memory + * @param sessionId Session id + * @returns IAkiProfile + */ getProfile(sessionId: string): IAkiProfile; + /** + * Get all profiles from memory + * @returns Dictionary of IAkiProfile + */ getProfiles(): Record; + /** + * Delete a profile by id + * @param sessionID Id of profile to remove + * @returns true when deleted, false when profile not found + */ deleteProfileById(sessionID: string): boolean; + /** + * Create a new profile in memory with empty pmc/scav objects + * @param profileInfo Basic profile data + */ createProfile(profileInfo: Info): void; + /** + * Add full profile in memory by key (info.id) + * @param profileDetails Profile to save + */ addProfile(profileDetails: IAkiProfile): void; + /** + * Look up profile json in user/profiles by id and store in memory + * Execute saveLoadRouters callbacks after being loaded into memory + * @param sessionID Id of profile to store in memory + */ loadProfile(sessionID: string): void; + /** + * Save changes from in-memory profile to user/profiles json + * Execute onBeforeSaveCallbacks callbacks prior to being saved to json + * @param sessionID profile id (user/profiles/id.json) + */ saveProfile(sessionID: string): void; + /** + * Remove a physical profile json from user/profiles + * @param sessionID Profile id to remove + * @returns true if file no longer exists + */ removeProfile(sessionID: string): boolean; } diff --git a/types/servers/http/AkiHttpListener.d.ts b/types/servers/http/AkiHttpListener.d.ts index acf92aa..d02861e 100644 --- a/types/servers/http/AkiHttpListener.d.ts +++ b/types/servers/http/AkiHttpListener.d.ts @@ -13,16 +13,18 @@ export declare class AkiHttpListener implements IHttpListener { protected httpRouter: HttpRouter; protected serializers: Serializer[]; protected logger: ILogger; + protected requestsLogger: 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); + serializers: Serializer[], logger: ILogger, requestsLogger: 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; + protected getBodyInfo(body: Buffer): any; + sendJson(resp: ServerResponse, output: string, sessionID: string): void; + sendZlibJson(resp: ServerResponse, output: string, sessionID: string): void; } diff --git a/types/services/BotEquipmentFilterService.d.ts b/types/services/BotEquipmentFilterService.d.ts index ae72cc3..eb21fd8 100644 --- a/types/services/BotEquipmentFilterService.d.ts +++ b/types/services/BotEquipmentFilterService.d.ts @@ -1,21 +1,47 @@ -import { IBotType } from "../models/eft/common/tables/IBotType"; -import { EquipmentFilters, EquipmentFilterDetails, IBotConfig, WeightingAdjustmentDetails } from "../models/spt/config/IBotConfig"; +import { BotHelper } from "../helpers/BotHelper"; +import { EquipmentChances, Generation, IBotType, MinMaxWithWhitelist, 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 botEquipmentConfig: Record; - constructor(logger: ILogger, configServer: ConfigServer); + 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; + /** + * Iterate over the Generation changes and alter data in baseValues.Generation + * @param generationChanges Changes to apply + * @param baseBotGeneration dictionary to update + */ + protected adjustGenerationChances(generationChanges: Record, baseBotGeneration: Generation): 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 @@ -31,14 +57,14 @@ export declare class BotEquipmentFilterService { */ protected getBotEquipmentWhitelist(botRole: string, playerLevel: number): EquipmentFilterDetails; /** - * Retreive clothing weighting adjustments from bot.json config + * Retrieve 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 + * Retrieve 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 @@ -46,7 +72,7 @@ export declare class BotEquipmentFilterService { 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 + * Prioritizes whitelist first, if one is found blacklist is ignored * @param baseBotNode bot .json file to update * @param blacklist equipment blacklist * @returns Filtered bot file @@ -54,10 +80,10 @@ export declare class BotEquipmentFilterService { protected filterEquipment(baseBotNode: IBotType, blacklist: EquipmentFilterDetails, whitelist: EquipmentFilterDetails): void; /** * Filter bot cartridges based on blacklist and whitelist from config/bot.json - * Prioritises whitelist first, if one is found blacklist is ignored + * Prioritizes whitelist first, if one is found blacklist is ignored * @param baseBotNode bot .json file to update * @param blacklist equipment on this list should be excluded from the bot - * @param whitelist equipment on this list should be used exclusivly + * @param whitelist equipment on this list should be used exclusively * @returns Filtered bot file */ protected filterCartridges(baseBotNode: IBotType, blacklist: EquipmentFilterDetails, whitelist: EquipmentFilterDetails): void; @@ -66,5 +92,5 @@ export declare class BotEquipmentFilterService { * @param weightingAdjustments Weighting change to apply to bot * @param botItemPool Bot item dictionary to adjust */ - protected adjustWeighting(weightingAdjustments: WeightingAdjustmentDetails, botItemPool: Record): void; + 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 0be0576..65b3ae0 100644 --- a/types/services/BotGenerationCacheService.d.ts +++ b/types/services/BotGenerationCacheService.d.ts @@ -3,32 +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: Map; - constructor(logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, botHelper: BotHelper); + constructor(logger: ILogger, randomUtil: RandomUtil, jsonUtil: JsonUtil, localisationService: LocalisationService, botHelper: BotHelper); /** * Store array of bots in cache, shuffle results before storage * @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; + getBot(key: string): IBotBase; /** - * Remove all cached bot profiles + * Remove all cached bot profiles from memory */ clearStoredBots(): void; /** - * Does cache have bots - * @returns true if empty + * Does cache have a bot with requested key + * @returns false if empty */ - cacheHasBotOfRole(role: string): boolean; + cacheHasBotOfRole(key: string): boolean; } diff --git a/types/services/BotLootCacheService.d.ts b/types/services/BotLootCacheService.d.ts index 00ffb9c..5c1560c 100644 --- a/types/services/BotLootCacheService.d.ts +++ b/types/services/BotLootCacheService.d.ts @@ -1,21 +1,25 @@ import { PMCLootGenerator } from "../generators/PMCLootGenerator"; -import { Items } from "../models/eft/common/tables/IBotType"; +import { ItemHelper } from "../helpers/ItemHelper"; +import { IBotType } from "../models/eft/common/tables/IBotType"; import { ITemplateItem, Props } from "../models/eft/common/tables/ITemplateItem"; -import { BotLootCache, LootCacheType } from "../models/spt/bots/BotLootCache"; +import { IBotLootCache, LootCacheType } from "../models/spt/bots/IBotLootCache"; 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 itemHelper: ItemHelper; 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); + protected lootCache: Record; + constructor(logger: ILogger, jsonUtil: JsonUtil, itemHelper: ItemHelper, databaseServer: DatabaseServer, pmcLootGenerator: PMCLootGenerator, localisationService: LocalisationService, ragfairPriceService: RagfairPriceService); /** - * Remove all cached bot loot data + * Remove cached bot loot data */ clearCache(): void; /** @@ -23,17 +27,17 @@ export declare class BotLootCacheService { * @param botRole bot to get loot for * @param isPmc is the bot a pmc * @param lootType what type of loot is needed (backpack/pocket/stim/vest etc) - * @param lootPool the full pool of loot (needed when cache is empty) + * @param botJsonTemplate Base json db file for the bot having its loot generated * @returns ITemplateItem array */ - getLootFromCache(botRole: string, isPmc: boolean, lootType: LootCacheType, lootPool: Items): ITemplateItem[]; + getLootFromCache(botRole: string, isPmc: boolean, lootType: LootCacheType, botJsonTemplate: IBotType): ITemplateItem[]; /** * Generate loot for a bot and store inside a private class property * @param botRole bots role (assault / pmcBot etc) - * @param lootPool the full pool of loot we use to create the various sub-categories with * @param isPmc Is the bot a PMC (alteres what loot is cached) + * @param botJsonTemplate db template for bot having its loot generated */ - protected addLootToCache(botRole: string, isPmc: boolean, lootPool: Items): void; + protected addLootToCache(botRole: string, isPmc: boolean, botJsonTemplate: IBotType): void; /** * Sort a pool of item objects by its flea price * @param poolToSort pool of items to sort 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 bdcdeb2..841a8ee 100644 --- a/types/services/FenceService.d.ts +++ b/types/services/FenceService.d.ts @@ -1,7 +1,7 @@ import { HandbookHelper } from "../helpers/HandbookHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; -import { FenceLevel } from "../models/eft/common/IGlobals"; +import { FenceLevel, Preset } 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"; @@ -15,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 @@ -30,12 +31,25 @@ export declare class FenceService { protected itemHelper: ItemHelper; protected presetHelper: PresetHelper; protected itemFilterService: ItemFilterService; + protected localisationService: LocalisationService; protected configServer: ConfigServer; + /** Main assorts you see at all rep levels */ protected fenceAssort: ITraderAssort; + /** Assorts shown on a separte tab when you max out fence rep */ + protected fenceDiscountAssort: 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); - protected setFenceAssort(fenceAssort: ITraderAssort): void; + 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); + /** + * Replace main fence assort with new assort + * @param assort New assorts to replace old with + */ + protected setFenceAssort(assort: ITraderAssort): void; + /** + * Replace high rep level fence assort with new assort + * @param assort New assorts to replace old with + */ + protected setFenceDiscountAssort(assort: ITraderAssort): void; /** * Get assorts player can purchase * Adjust prices based on fence level of player @@ -44,12 +58,27 @@ export declare class FenceService { */ getFenceAssorts(pmcProfile: IPmcData): ITraderAssort; /** - * Adjust assorts price by a modifier - * @param item - * @param assort - * @param modifier + * Adjust all items contained inside an assort by a multiplier + * @param assort Assort that contains items with prices to adjust + * @param itemMultipler multipler to use on items + * @param presetMultiplier preset multipler to use on presets */ - protected adjustItemPriceByModifier(item: Item, assort: ITraderAssort, modifier: number): void; + protected adjustAssortItemPrices(assort: ITraderAssort, itemMultipler: number, presetMultiplier: number): void; + /** + * Merge two trader assort files together + * @param firstAssort assort 1# + * @param secondAssort assort #2 + * @returns merged assort + */ + protected mergeAssorts(firstAssort: ITraderAssort, secondAssort: ITraderAssort): ITraderAssort; + /** + * Adjust assorts price by a modifier + * @param item assort item details + * @param assort assort to be modified + * @param modifier value to multiply item price by + * @param presetModifier value to multiply preset price by + */ + protected adjustItemPriceByModifier(item: Item, assort: ITraderAssort, modifier: number, presetModifier: number): void; /** * Get fence assorts with no price adjustments based on fence rep * @returns ITraderAssort @@ -77,8 +106,9 @@ export declare class FenceService { protected getCountOfItemsToGenerate(existingItemCountToReplace: number): number; /** * Choose an item (not mod) at random and remove from assorts + * @param assort Items to remove from */ - protected removeRandomItemFromAssorts(): void; + protected removeRandomItemFromAssorts(assort: ITraderAssort): void; /** * Get an integer rounded count of items to replace based on percentrage from traderConfig value * @param totalItemCount total item count @@ -91,20 +121,32 @@ 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 */ protected createBaseTraderAssortItem(): ITraderAssort; /** - * Hydrate result parameter object with generated assorts + * Hydrate assorts parameter object with generated assorts * @param assortCount Number of assorts to generate - * @param assorts object to add assorts to + * @param assorts object to add created assorts to */ - protected createAssorts(assortCount: number, assorts: ITraderAssort): void; + protected createAssorts(assortCount: number, assorts: ITraderAssort, loyaltyLevel: number): void; + protected addItemAssorts(assortCount: number, fenceAssortIds: string[], assorts: ITraderAssort, fenceAssort: ITraderAssort, itemTypeCounts: Record, loyaltyLevel: number): void; + /** + * Add preset weapons to fence presets + * @param assortCount how many assorts to add to assorts + * @param defaultWeaponPresets a dictionary of default weapon presets + * @param assorts object to add presets to + * @param loyaltyLevel loyalty level to requre item at + */ + protected addPresets(desiredPresetCount: number, defaultWeaponPresets: Record, assorts: ITraderAssort, loyaltyLevel: number): void; /** * Randomise items' upd properties e.g. med packs/weapons/armor * @param itemDetails Item being randomised diff --git a/types/services/InsuranceService.d.ts b/types/services/InsuranceService.d.ts index 6be8a2f..1605bc9 100644 --- a/types/services/InsuranceService.d.ts +++ b/types/services/InsuranceService.d.ts @@ -1,4 +1,6 @@ +import { ITraderBase } from "../models/eft/common/tables/ITrader"; 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 +14,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 +24,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; @@ -45,14 +50,36 @@ export declare class InsuranceService { * @param mapId Id of the map player died/exited that caused the insurance to be issued on */ sendInsuredItems(pmcData: IPmcData, sessionID: string, mapId: string): void; + protected removeLocationProperty(sessionId: string, traderId: string): void; + /** + * Get a timestamp of what insurance items should be sent to player based on the type of trader used to insure + * @param pmcData Player profile + * @param trader Trader used to insure items + * @returns Timestamp to return items to player in seconds + */ + protected getInsuranceReturnTimestamp(pmcData: IPmcData, trader: ITraderBase): number; /** * Store lost gear post-raid inside profile * @param pmcData player profile to store gear in * @param offraidData post-raid request object * @param preRaidGear gear player wore prior to raid * @param sessionID Session id + * @param playerDied did the player die in raid + */ + storeLostGear(pmcData: IPmcData, offraidData: ISaveProgressRequestData, preRaidGear: Item[], sessionID: string, playerDied: boolean): void; + /** + * Create a hash table for an array of items, keyed by items _id + * @param items Items to hash + * @returns Hashtable + */ + protected createItemHashTable(items: Item[]): Record; + /** + * Store insured items on pmc death inside insurance array in player profile + * @param pmcData Player profile + * @param offraidData Player gear post-raid + * @param preRaidGear Player gear before raid + * @param sessionID Session id */ - storeLostGear(pmcData: IPmcData, offraidData: ISaveProgressRequestData, preRaidGear: Item[], sessionID: string): void; storeInsuredItemsForReturn(pmcData: IPmcData, offraidData: ISaveProgressRequestData, preRaidGear: Item[], sessionID: string): void; /** * Add gear item to InsuredItems array in player profile 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/LocaleService.d.ts b/types/services/LocaleService.d.ts index 8275b75..09c658b 100644 --- a/types/services/LocaleService.d.ts +++ b/types/services/LocaleService.d.ts @@ -1,5 +1,4 @@ import { ILocaleConfig } from "../models/spt/config/ILocaleConfig"; -import { ILocaleGlobalBase } from "../models/spt/server/ILocaleBase"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; @@ -14,9 +13,9 @@ export declare class LocaleService { constructor(logger: ILogger, databaseServer: DatabaseServer, configServer: ConfigServer); /** * Get the eft globals db file based on the configured locale in config/locale.json, if not found, fall back to 'en' - * @returns ILocaleGlobalBase + * @returns dictionary */ - getLocaleDb(): ILocaleGlobalBase; + getLocaleDb(): Record; /** * Gets the game locale key from the locale.json file, * if value is 'system' get system locale diff --git a/types/services/LocalisationService.d.ts b/types/services/LocalisationService.d.ts index 519325d..44a4941 100644 --- a/types/services/LocalisationService.d.ts +++ b/types/services/LocalisationService.d.ts @@ -1,16 +1,18 @@ import { I18n } from "i18n"; import { ILocaleConfig } from "../models/spt/config/ILocaleConfig"; import { ILogger } from "../models/spt/utils/ILogger"; +import { DatabaseServer } from "../servers/DatabaseServer"; import { LocaleService } from "./LocaleService"; /** * Handles translating server text into different langauges */ export declare class LocalisationService { protected logger: ILogger; + protected databaseServer: DatabaseServer; protected localeService: LocaleService; protected localeConfig: ILocaleConfig; protected i18n: I18n; - constructor(logger: ILogger, localeService: LocaleService); + constructor(logger: ILogger, databaseServer: DatabaseServer, localeService: LocaleService); /** * Get a localised value using the passed in key * @param key Key to loop up locale for @@ -18,4 +20,9 @@ export declare class LocalisationService { * @returns Localised string */ getText(key: string, args?: any): string; + /** + * Get all locale keys + * @returns string array of keys + */ + getKeys(): string[]; } diff --git a/types/services/MatchBotDetailsCacheService.d.ts b/types/services/MatchBotDetailsCacheService.d.ts new file mode 100644 index 0000000..757f61f --- /dev/null +++ b/types/services/MatchBotDetailsCacheService.d.ts @@ -0,0 +1,23 @@ +import { IBotBase } from "../models/eft/common/tables/IBotBase"; +import { ILogger } from "../models/spt/utils/ILogger"; +/** Cache bots in a dictionary, keyed by the bots name, keying by name isnt idea as its not unique but this is used by the post-raid system which doesnt have any bot ids, only name */ +export declare class MatchBotDetailsCacheService { + protected logger: ILogger; + protected botDetailsCache: Record; + constructor(logger: ILogger); + /** + * Store a bot in the cache, keyed by its name + * @param botToCache Bot details to cache + */ + cacheBot(botToCache: IBotBase): void; + /** + * Clean the cache of all bot details + */ + clearCache(): void; + /** + * Find a bot in the cache by its name + * @param botName Name of bot to find + * @returns Bot details + */ + getBotByName(botName: string): IBotBase; +} 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 c9ce95a..1c9c32b 100644 --- a/types/services/PaymentService.d.ts +++ b/types/services/PaymentService.d.ts @@ -25,12 +25,12 @@ export declare class PaymentService { 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 - * @param {Object} body + * @param {IPmcData} pmcData Player profile + * @param {IProcessBuyTradeRequestData} request * @param {string} sessionID * @returns Object */ - payMoney(pmcData: IPmcData, body: IProcessBuyTradeRequestData, sessionID: string, output: IItemEventRouterResponse): IItemEventRouterResponse; + payMoney(pmcData: IPmcData, request: IProcessBuyTradeRequestData, sessionID: string, output: IItemEventRouterResponse): IItemEventRouterResponse; /** * Receive money back after selling * @param {IPmcData} pmcData @@ -57,12 +57,27 @@ export declare class PaymentService { * @returns IItemEventRouterResponse */ addPaymentToOutput(pmcData: IPmcData, currencyTpl: string, amountToPay: number, sessionID: string, output: IItemEventRouterResponse): IItemEventRouterResponse; + /** + * Get all money stacks in inventory and prioritse items in stash + * @param pmcData + * @param currencyTpl + * @returns Sorting money items + */ + protected getSortedMoneyItemsInInventory(pmcData: IPmcData, currencyTpl: string): Item[]; /** * 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 + * @param inventoryItems players inventory items + * @returns sort order */ - protected moneySort(a: Item, b: Item): number; + protected prioritiseStashSort(a: Item, b: Item, inventoryItems: Item[]): number; + /** + * Recursivly check items parents to see if it is inside the players inventory, not stash + * @param itemId item id to check + * @param inventoryItems player inventory + * @returns true if its in inventory + */ + protected isInInventory(itemId: string, inventoryItems: Item[]): boolean; } diff --git a/types/services/PlayerService.d.ts b/types/services/PlayerService.d.ts index 2f364d5..1195b93 100644 --- a/types/services/PlayerService.d.ts +++ b/types/services/PlayerService.d.ts @@ -1,5 +1,4 @@ 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"; @@ -11,11 +10,10 @@ export declare class PlayerService { /** * increases the profile skill and updates any output * @param {Object} pmcData - * @param {Object} output * @param {String} skillName * @param {Number} amount */ - incrementSkillLevel(pmcData: IPmcData, output: IPlayerIncrementSkillLevelRequestData, skillName: string, amount: number): void; + incrementSkillLevel(pmcData: IPmcData, skillName: string, amount: number): void; /** * @param {Object} pmcData * @returns number diff --git a/types/services/PmcChatResponseService.d.ts b/types/services/PmcChatResponseService.d.ts new file mode 100644 index 0000000..7d946e6 --- /dev/null +++ b/types/services/PmcChatResponseService.d.ts @@ -0,0 +1,91 @@ +import { NotificationSendHelper } from "../helpers/NotificationSendHelper"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; +import { IPmcData } from "../models/eft/common/IPmcData"; +import { Aggressor, Victim } from "../models/eft/common/tables/IBotBase"; +import { IUserDialogInfo } from "../models/eft/profile/IAkiProfile"; +import { IPmcChatResponse } from "../models/spt/config/IPmChatResponse"; +import { ILogger } from "../models/spt/utils/ILogger"; +import { ConfigServer } from "../servers/ConfigServer"; +import { RandomUtil } from "../utils/RandomUtil"; +import { LocalisationService } from "./LocalisationService"; +import { MatchBotDetailsCacheService } from "./MatchBotDetailsCacheService"; +export declare class PmcChatResponseService { + protected logger: ILogger; + protected randomUtil: RandomUtil; + protected notificationSendHelper: NotificationSendHelper; + protected matchBotDetailsCacheService: MatchBotDetailsCacheService; + protected localisationService: LocalisationService; + protected weightedRandomHelper: WeightedRandomHelper; + protected configServer: ConfigServer; + protected pmcResponsesConfig: IPmcChatResponse; + constructor(logger: ILogger, randomUtil: RandomUtil, notificationSendHelper: NotificationSendHelper, matchBotDetailsCacheService: MatchBotDetailsCacheService, localisationService: LocalisationService, weightedRandomHelper: WeightedRandomHelper, configServer: ConfigServer); + /** + * For each PMC victim of the player, have a chance to send a message to the player, can be positive or negative + * @param sessionId Session id + * @param pmcVictims Array of bots killed by player + * @param pmcData Player profile + */ + sendVictimResponse(sessionId: string, pmcVictims: Victim[], pmcData: IPmcData): void; + /** + * Not fully implemented yet, needs method of acquiring killers details after raid + * @param sessionId Session id + * @param pmcData Players profile + * @param killer The bot who killed the player + */ + sendKillerResponse(sessionId: string, pmcData: IPmcData, killer: Aggressor): void; + /** + * Choose a localised message to send the player (different if sender was killed or killed player) + * @param isVictim Is the message coming from a bot killed by the player + * @param pmcData Player profile + * @returns Message from PMC to player + */ + protected chooseMessage(isVictim: boolean, pmcData: IPmcData): string; + /** + * Should capitalisation be stripped from the message response before sending + * @param isVictim Was responder a victim of player + * @returns true = should be stripped + */ + protected stripCapitalistion(isVictim: boolean): boolean; + /** + * Should capitalisation be stripped from the message response before sending + * @param isVictim Was responder a victim of player + * @returns true = should be stripped + */ + protected allCaps(isVictim: boolean): boolean; + /** + * Should a suffix be appended to the end of the message being sent to player + * @param isVictim Was responder a victim of player + * @returns true = should be stripped + */ + appendSuffixToMessageEnd(isVictim: boolean): boolean; + /** + * Choose a type of response based on the weightings in pmc response config + * @param isVictim Was responder killed by player + * @returns Response type (positive/negative) + */ + protected chooseResponseType(isVictim?: boolean): string; + /** + * Get locale keys related to the type of response to send (victim/killer) + * @param keyType Positive/negative + * @param isVictim Was responder killed by player + * @returns + */ + protected getResponseLocaleKeys(keyType: string, isVictim?: boolean): string[]; + /** + * Get all locale keys that start with `pmcresponse-suffix` + * @returns array of keys + */ + protected getResponseSuffixLocaleKeys(): string[]; + /** + * Randomly draw a victim of the the array and return thier details + * @param pmcVictims Possible victims to choose from + * @returns IUserDialogInfo + */ + protected chooseRandomVictim(pmcVictims: Victim[]): IUserDialogInfo; + /** + * Convert a victim object into a IUserDialogInfo object + * @param pmcVictim victim to convert + * @returns IUserDialogInfo + */ + protected getVictimDetails(pmcVictim: Victim): IUserDialogInfo; +} diff --git a/types/services/ProfileFixerService.d.ts b/types/services/ProfileFixerService.d.ts index 86a6af8..8d23ebc 100644 --- a/types/services/ProfileFixerService.d.ts +++ b/types/services/ProfileFixerService.d.ts @@ -7,6 +7,7 @@ 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 { TimeUtil } from "../utils/TimeUtil"; import { Watermark } from "../utils/Watermark"; import { LocalisationService } from "./LocalisationService"; export declare class ProfileFixerService { @@ -14,8 +15,9 @@ export declare class ProfileFixerService { protected watermark: Watermark; protected hideoutHelper: HideoutHelper; protected localisationService: LocalisationService; + protected timeUtil: TimeUtil; protected databaseServer: DatabaseServer; - constructor(logger: ILogger, watermark: Watermark, hideoutHelper: HideoutHelper, localisationService: LocalisationService, databaseServer: DatabaseServer); + constructor(logger: ILogger, watermark: Watermark, hideoutHelper: HideoutHelper, localisationService: LocalisationService, timeUtil: TimeUtil, databaseServer: DatabaseServer); /** * Find issues in the pmc profile data that may cause issues and fix them * @param pmcProfile profile to check and fix @@ -32,6 +34,8 @@ export declare class ProfileFixerService { * @param pmcProfile profile to remove old counters from */ removeDanglingConditionCounters(pmcProfile: IPmcData): void; + addLighthouseKeeperIfMissing(pmcProfile: IPmcData): void; + protected addUnlockedInfoObjectIfMissing(pmcProfile: IPmcData): void; protected removeDanglingBackendCounters(pmcProfile: IPmcData): void; protected getActiveRepeatableQuests(repeatableQuests: IPmcDataRepeatableQuest[]): IRepeatableQuest[]; protected fixNullTraderSalesSums(pmcProfile: IPmcData): void; @@ -45,6 +49,11 @@ export declare class ProfileFixerService { protected updateProfileQuestDataValues(pmcProfile: IPmcData): void; protected addMissingRepeatableQuestsProperty(pmcProfile: IPmcData): void; protected addMissingWorkbenchWeaponSkills(pmcProfile: IPmcData): void; + /** + * Some profiles have hideout maxed and therefore no improvements + * @param pmcProfile Profile to add improvement data to + */ + protected addMissingWallImprovements(pmcProfile: IPmcData): void; /** * A new property was added to slot items "locationIndex", if this is missing, the hideout slot item must be removed * @param pmcProfile Profile to find and remove slots from @@ -85,4 +94,19 @@ export declare class ProfileFixerService { * @param pmcProfile Profile to check inventory of */ checkForOrphanedModdedItems(pmcProfile: IPmcData): void; + /** + * Add `Improvements` object to hideout if missing - added in eft 13.0.21469 + * @param pmcProfile profile to update + */ + addMissingUpgradesPropertyToHideout(pmcProfile: IPmcData): void; + /** + * Iterate over associated profile template and check all hideout areas exist, add if not + * @param fullProfile Profile to update + */ + addMissingHideoutAreasToProfile(fullProfile: IAkiProfile): void; + /** + * These used to be used for storing scav case rewards, rewards are now generated on pickup + * @param pmcProfile Profile to update + */ + removeLegacyScavCaseProductionCrafts(pmcProfile: IPmcData): void; } diff --git a/types/services/RagfairCategoriesService.d.ts b/types/services/RagfairCategoriesService.d.ts index 83910e5..490b0bb 100644 --- a/types/services/RagfairCategoriesService.d.ts +++ b/types/services/RagfairCategoriesService.d.ts @@ -22,9 +22,9 @@ export declare class RagfairCategoriesService { protected processOffersIntoCategories(offers: IRagfairOffer[]): Record; /** * Increment or decrement a category array - * @param offer offer to process - * @param categories categories to update - * @param increment should item be incremented or decremented + * @param offer Offer to process + * @param categories Categories to update + * @param increment (Optional) Should item be incremented or decremented */ protected addOrIncrementCategory(offer: IRagfairOffer, categories: Record, increment?: boolean): void; /** diff --git a/types/services/RagfairLinkedItemService.d.ts b/types/services/RagfairLinkedItemService.d.ts index 6c34ee0..51511f9 100644 --- a/types/services/RagfairLinkedItemService.d.ts +++ b/types/services/RagfairLinkedItemService.d.ts @@ -1,10 +1,21 @@ -import { DatabaseServer } from "../servers/DatabaseServer"; +import { ItemHelper } from "../helpers/ItemHelper"; import { ITemplateItem } from "../models/eft/common/tables/ITemplateItem"; +import { DatabaseServer } from "../servers/DatabaseServer"; export declare class RagfairLinkedItemService { protected databaseServer: DatabaseServer; + protected itemHelper: ItemHelper; protected linkedItemsCache: Record>; - constructor(databaseServer: DatabaseServer); + constructor(databaseServer: DatabaseServer, itemHelper: ItemHelper); getLinkedItems(linkedSearchId: string): Iterable; + /** + * Create Dictionary of every item and the items associated with it + */ protected buildLinkedItemTable(): void; + /** + * Add ammo to revolvers linked item dictionary + * @param cylinder Revolvers cylinder + * @param applyLinkedItems + */ + protected addRevolverCylinderAmmoToLinkedItems(cylinder: ITemplateItem, applyLinkedItems: (items: string[]) => void): void; protected getFilters(item: ITemplateItem, slot: string): string[]; } diff --git a/types/services/RagfairOfferService.d.ts b/types/services/RagfairOfferService.d.ts index 86c1e52..fc08d39 100644 --- a/types/services/RagfairOfferService.d.ts +++ b/types/services/RagfairOfferService.d.ts @@ -10,6 +10,7 @@ import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { SaveServer } from "../servers/SaveServer"; import { HttpResponseUtil } from "../utils/HttpResponseUtil"; +import { RagfairOfferHolder } from "../utils/RagfairOfferHolder"; import { TimeUtil } from "../utils/TimeUtil"; import { LocalisationService } from "./LocalisationService"; import { RagfairCategoriesService } from "./RagfairCategoriesService"; @@ -26,10 +27,9 @@ export declare class RagfairOfferService { protected localisationService: LocalisationService; protected configServer: ConfigServer; protected playerOffersLoaded: boolean; - protected expiredOffers: Item[]; - /** offerId, offer */ - protected offers: Record; + protected expiredOffers: Record; protected ragfairConfig: IRagfairConfig; + 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 @@ -45,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 @@ -53,8 +53,17 @@ export declare class RagfairOfferService { * @returns offer exists - true */ doesOfferExist(offerId: string): boolean; + /** + * Remove an offer from ragfair by offer id + * @param offerId Offer id to remove + */ removeOfferById(offerId: string): void; - removeOfferStack(offerID: string, amount: number): void; + /** + * Reduce size of an offer stack by specified amount + * @param offerId Offer to adjust stack size of + * @param amount How much to deduct from offers stack size + */ + removeOfferStack(offerId: string, amount: number): void; removeAllOffersByTrader(traderId: string): void; /** * Do the trader offers on flea need to be refreshed @@ -65,11 +74,9 @@ export declare class RagfairOfferService { addPlayerOffers(): void; expireStaleOffers(): void; /** - * Get an array of stale offers that are still shown to player - * @returns IRagfairOffer array + * Remove stale offer from flea + * @param staleOffer Stale offer to process */ - 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 4ac7794..8b68bc4 100644 --- a/types/services/RagfairPriceService.d.ts +++ b/types/services/RagfairPriceService.d.ts @@ -1,6 +1,8 @@ +import { OnLoad } from "../di/OnLoad"; import { HandbookHelper } from "../helpers/HandbookHelper"; import { ItemHelper } from "../helpers/ItemHelper"; import { PresetHelper } from "../helpers/PresetHelper"; +import { TraderHelper } from "../helpers/TraderHelper"; import { Preset } from "../models/eft/common/IGlobals"; import { Item } from "../models/eft/common/tables/IItem"; import { IBarterScheme } from "../models/eft/common/tables/ITrader"; @@ -10,29 +12,38 @@ import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { RandomUtil } from "../utils/RandomUtil"; -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; protected itemHelper: ItemHelper; protected presetHelper: PresetHelper; + protected traderHelper: TraderHelper; 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); - onLoad(): void; + constructor(handbookHelper: HandbookHelper, databaseServer: DatabaseServer, logger: ILogger, itemHelper: ItemHelper, presetHelper: PresetHelper, traderHelper: TraderHelper, 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; + /** + * 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. + * Get the dynamic price for an item. If value doesn't exist, use static (handbook) value. * if no static value, return 1 * @param tplId Item tpl id to get price for * @returns price in roubles @@ -51,7 +62,12 @@ export declare class RagfairPriceService implements OnLoad { * @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; + getAllStaticPrices(): Record; /** * Get the percentage difference between two values * @param a numerical value a @@ -59,7 +75,18 @@ export declare class RagfairPriceService implements OnLoad { * @returns different in percent */ protected getPriceDifference(a: number, b: number): 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 @@ -83,11 +110,20 @@ export declare class RagfairPriceService implements OnLoad { * @returns */ protected getWeaponPresetPrice(item: Item, items: Item[], existingPrice: number): number; + /** + * Get the highest price for an item that is stored in handbook or trader assorts + * @param itemTpl Item to get highest price of + * @returns rouble cost + */ + protected getHighestHandbookOrTraderPriceAsRouble(itemTpl: string): number; /** * Attempt to get the default preset for a weapon, failing that get the first preset in the array * (assumes default = has encyclopedia entry) * @param presets weapon presets to choose from * @returns Default preset object */ - protected getDefaultWeaponPreset(presets: Preset[], weapon: Item): Preset; + protected getWeaponPreset(presets: Preset[], weapon: Item): { + isDefault: boolean; + preset: Preset; + }; } 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 index d3f1b35..a3c6c7a 100644 --- a/types/services/RepairService.d.ts +++ b/types/services/RepairService.d.ts @@ -1,27 +1,33 @@ +import { ItemHelper } from "../helpers/ItemHelper"; import { QuestHelper } from "../helpers/QuestHelper"; import { RepairHelper } from "../helpers/RepairHelper"; import { TraderHelper } from "../helpers/TraderHelper"; +import { WeightedRandomHelper } from "../helpers/WeightedRandomHelper"; 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 { BonusSettings, IRepairConfig } from "../models/spt/config/IRepairConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; +import { RandomUtil } from "../utils/RandomUtil"; import { PaymentService } from "./PaymentService"; export declare class RepairService { protected logger: ILogger; protected databaseServer: DatabaseServer; protected questHelper: QuestHelper; + protected randomUtil: RandomUtil; + protected itemHelper: ItemHelper; protected traderHelper: TraderHelper; + protected weightedRandomHelper: WeightedRandomHelper; 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); + protected repairConfig: IRepairConfig; + constructor(logger: ILogger, databaseServer: DatabaseServer, questHelper: QuestHelper, randomUtil: RandomUtil, itemHelper: ItemHelper, traderHelper: TraderHelper, weightedRandomHelper: WeightedRandomHelper, paymentService: PaymentService, repairHelper: RepairHelper, configServer: ConfigServer); /** * Use trader to repair an items durability * @param sessionID Session id @@ -46,9 +52,8 @@ export declare class RepairService { * @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; + addRepairSkillPoints(sessionId: string, repairDetails: RepairDetails, pmcData: IPmcData): void; /** * * @param sessionId Session id @@ -59,15 +64,65 @@ export declare class RepairService { * @returns Details of repair, item/price */ repairItemByKit(sessionId: string, pmcData: IPmcData, repairKits: RepairKitsInfo[], itemToRepairId: string, output: IItemEventRouterResponse): RepairDetails; + /** + * Calculate value repairkit points need to be divided by to get the durability points to be added to an item + * @param itemToRepairDetails Item to repair details + * @param isArmor Is the item being repaired armor + * @param pmcData Player profile + * @returns Number to divide kit points by + */ + protected getKitDivisor(itemToRepairDetails: ITemplateItem, isArmor: boolean, pmcData: IPmcData): number; + /** + * Get the bonus multiplier for a skill from a player profile + * @param skillBonusName Name of bonus to get multipler of + * @param pmcData Player profile to look in for skill + * @returns Multiplier value + */ + protected getBonusMultiplierValue(skillBonusName: string, pmcData: IPmcData): number; /** * 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; + /** + * Chance to apply buff to an item (Armor/weapon) if repaired by armor kit + * @param repairDetails Repair details of item + * @param pmcData Player profile + */ + addBuffToItem(repairDetails: RepairDetails, pmcData: IPmcData): void; + /** + * Add buff to item + * @param itemConfig weapon/armor config + * @param repairDetails Details for item to repair + */ + protected addBuff(itemConfig: BonusSettings, repairDetails: RepairDetails): void; + /** + * Check if item should be buffed by checking the item type and relevant player skill level + * @param repairDetails Item that was repaired + * @param itemTpl tpl of item to be buffed + * @param pmcData Player profile + * @returns True if item should have buff applied + */ + protected shouldBuffItem(repairDetails: RepairDetails, pmcData: IPmcData): boolean; + /** + * Based on item, what underlying skill does this item use for buff settings + * @param itemTemplate Item to check for skill + * @returns Skill name + */ + protected getItemSkillType(itemTemplate: ITemplateItem): string; + /** + * Ensure multiplier is between 1 and 0.01 + * @param receiveDurabilityMaxPercent Max durabiltiy percent + * @param receiveDurabilityPercent current durability percent + * @returns durability multipler value + */ + protected getDurabilityMultiplier(receiveDurabilityMaxPercent: number, receiveDurabilityPercent: number): number; } export declare class RepairDetails { repairCost?: number; repairedItem: Item; repairedItemIsArmor: boolean; + repairAmount: number; + repairedByKit: boolean; } diff --git a/types/services/SeasonalEventService.d.ts b/types/services/SeasonalEventService.d.ts new file mode 100644 index 0000000..7474018 --- /dev/null +++ b/types/services/SeasonalEventService.d.ts @@ -0,0 +1,114 @@ +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[]; + protected get halloweenEventItems(): string[]; + /** + * Get an array of christmas items found in bots inventories as loot + * @returns array + */ + getChristmasEventItems(): string[]; + /** + * Get an array of halloween items found in bots inventories as loot + * @returns array + */ + getHalloweenEventItems(): string[]; + itemIsChristmasRelated(itemTpl: string): boolean; + itemIsHalloweenRelated(itemTpl: string): boolean; + /** + * Check if item id exists in christmas or halloween event arrays + * @param itemTpl item tpl to check for + * @returns + */ + itemIsSeasonalRelated(itemTpl: string): boolean; + /** + * Get an array of items that appear during a seasonal event + * returns multiple seasonal event items if they are both active + * @returns array of tpl strings + */ + getAllSeasonalEventItems(): string[]; + /** + * Get an array of seasonal items that should be blocked as seasonal is not active + * @returns Array of tpl strings + */ + getSeasonalEventItemsToBlock(): string[]; + /** + * Is a seasonal event currently active + * @returns true if event is active + */ + seasonalEventEnabled(): boolean; + /** + * is christmas event active + * @returns true if active + */ + christmasEventEnabled(): boolean; + /** + * is christmas event active + * @returns true if active + */ + halloweenEventEnabled(): 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; + /** + * Add lootble items from backpack into patrol.ITEMS_TO_DROP difficulty property + */ + protected addLootItemsToGifterDropItemsList(): 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 addEventGearToBots(eventName: string): void; + protected addPumpkinsToScavBackpacks(): void; + /** + * Set Khorovod(dancing tree) chance to 100% on all maps that support it + */ + protected enableDancingTree(): void; + /** + * Add santa to maps + */ + protected addGifterBotToMaps(): 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/onLoad/OnLoadMod.d.ts b/types/services/mod/onLoad/OnLoadMod.d.ts index 53fb062..a4b58b5 100644 --- a/types/services/mod/onLoad/OnLoadMod.d.ts +++ b/types/services/mod/onLoad/OnLoadMod.d.ts @@ -1,8 +1,8 @@ import { OnLoad } from "../../../di/OnLoad"; -export declare class OnLoadMod extends OnLoad { +export declare class OnLoadMod implements 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..8dfe6dd 100644 --- a/types/services/mod/onUpdate/OnUpdateMod.d.ts +++ b/types/services/mod/onUpdate/OnUpdateMod.d.ts @@ -1,8 +1,8 @@ import { OnUpdate } from "../../../di/OnUpdate"; -export declare class OnUpdateMod extends OnUpdate { +export declare class OnUpdateMod implements 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 cc8a5af..b947c83 100644 --- a/types/utils/App.d.ts +++ b/types/utils/App.d.ts @@ -11,7 +11,7 @@ export declare class App { protected onUpdateComponents: OnUpdate[]; protected onUpdateLastRun: {}; constructor(logger: ILogger, timeUtil: TimeUtil, localisationService: LocalisationService, onLoadComponents: OnLoad[], onUpdateComponents: OnUpdate[]); - load(): void; - protected update(onUpdateComponents: OnUpdate[]): void; + load(): Promise; + protected update(onUpdateComponents: OnUpdate[]): Promise; protected logUpdateException(err: any, updateable: OnUpdate): void; } diff --git a/types/utils/AyncQueue.d.ts b/types/utils/AsyncQueue.d.ts similarity index 100% rename from types/utils/AyncQueue.d.ts rename to types/utils/AsyncQueue.d.ts diff --git a/types/utils/DatabaseImporter.d.ts b/types/utils/DatabaseImporter.d.ts index 31670ae..7698f07 100644 --- a/types/utils/DatabaseImporter.d.ts +++ b/types/utils/DatabaseImporter.d.ts @@ -1,26 +1,49 @@ import { OnLoad } from "../di/OnLoad"; -import { IDatabaseTables } from "../models/spt/server/IDatabaseTables"; +import { IHttpConfig } from "../models/spt/config/IHttpConfig"; import { ILogger } from "../models/spt/utils/ILogger"; import { ImageRouter } from "../routers/ImageRouter"; +import { ConfigServer } from "../servers/ConfigServer"; import { DatabaseServer } from "../servers/DatabaseServer"; import { LocalisationService } from "../services/LocalisationService"; +import { EncodingUtil } from "./EncodingUtil"; +import { HashUtil } from "./HashUtil"; +import { ImporterUtil } from "./ImporterUtil"; import { JsonUtil } from "./JsonUtil"; import { VFS } from "./VFS"; -export declare class DatabaseImporter extends OnLoad { +export declare class DatabaseImporter implements 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, localisationService: LocalisationService, databaseServer: DatabaseServer, imageRouter: ImageRouter); - onLoad(): void; + protected encodingUtil: EncodingUtil; + protected hashUtil: HashUtil; + protected importerUtil: ImporterUtil; + protected configServer: ConfigServer; + private hashedFile; + private valid; + private filepath; + protected httpConfig: IHttpConfig; + constructor(logger: ILogger, vfs: VFS, jsonUtil: JsonUtil, localisationService: LocalisationService, databaseServer: DatabaseServer, imageRouter: ImageRouter, encodingUtil: EncodingUtil, hashUtil: HashUtil, importerUtil: ImporterUtil, configServer: ConfigServer); + 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; + private onReadValidate; getRoute(): string; - loadRecursive(filepath: string): IDatabaseTables; - loadImages(filepath: string): void; + private validateFile; + /** + * Find and map files with image router inside a designated path + * @param filepath Path to find files in + */ + loadImages(filepath: string, routes: string[]): void; + /** + * Check for a path override in the http json config file + * @param imagePath Key + * @returns override for key + */ + protected getImagePathOverride(imagePath: string): string; } diff --git a/types/utils/EncodingUtil.d.ts b/types/utils/EncodingUtil.d.ts new file mode 100644 index 0000000..dabb97a --- /dev/null +++ b/types/utils/EncodingUtil.d.ts @@ -0,0 +1,15 @@ +export declare class EncodingUtil { + encode(value: string, encode: EncodeType): string; + decode(value: string, encode: EncodeType): string; + fromBase64(value: string): string; + toBase64(value: string): string; + fromHex(value: string): string; + toHex(value: string): string; +} +export declare enum EncodeType { + BASE64 = "base64", + HEX = "hex", + ASCII = "ascii", + BINARY = "binary", + UTF8 = "utf8" +} diff --git a/types/utils/ImporterUtil.d.ts b/types/utils/ImporterUtil.d.ts new file mode 100644 index 0000000..75aaf54 --- /dev/null +++ b/types/utils/ImporterUtil.d.ts @@ -0,0 +1,21 @@ +import { JsonUtil } from "./JsonUtil"; +import { VFS } from "./VFS"; +export declare class ImporterUtil { + protected vfs: VFS; + protected jsonUtil: JsonUtil; + constructor(vfs: VFS, jsonUtil: JsonUtil); + /** + * Load files into js objects recursively (asynchronous) + * @param filepath Path to folder with files + * @returns Promise return T type associated with this class + */ + loadRecursiveAsync(filepath: string, onReadCallback?: (fileWithPath: string, data: string) => void, onObjectDeserialized?: (fileWithPath: string, object: any) => void): Promise; + /** + * Load files into js objects recursively (synchronous) + * @param filepath Path to folder with files + * @returns + */ + loadRecursive(filepath: string, onReadCallback?: (fileWithPath: string, data: string) => void, onObjectDeserialized?: (fileWithPath: string, object: any) => void): T; + loadAsync(filepath: string, strippablePath?: string, onReadCallback?: (fileWithPath: string, data: string) => void, onObjectDeserialized?: (fileWithPath: string, object: any) => void): Promise; + protected placeObject(fileDeserialized: any, strippedFilePath: string, result: T, strippablePath: string): void; +} diff --git a/types/utils/JsonUtil.d.ts b/types/utils/JsonUtil.d.ts index 71e95f6..229dc26 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 @@ -13,13 +14,14 @@ export declare class JsonUtil { * @param prettify Should output be prettified? * @returns string */ - serialize(data: any, prettify?: boolean): string; + serialize(data: T, prettify?: boolean): string; /** * From string to object * @param jsonString json string to turn into object * @returns object */ - deserialize(jsonString: string): any; - deserializeWithCacheCheck(jsonString: string, filePath: string): string; + deserialize(jsonString: string, filename?: string): T; + deserializeWithCacheCheckAsync(jsonString: string, filePath: string): Promise; + deserializeWithCacheCheck(jsonString: string, filePath: string): T; clone(data: T): T; } 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 aa556e3..fc0b05d 100644 --- a/types/utils/RandomUtil.d.ts +++ b/types/utils/RandomUtil.d.ts @@ -110,6 +110,7 @@ export declare class RandomUtil { getIntEx(max: number): number; getFloat(min: number, max: number): number; getBool(): boolean; + getPercentOfValue(percent: number, number: number, toFixed?: number): number; /** * Check if number passes a check out of 100 * @param chancePercent value check needs to be above diff --git a/types/utils/UUidGenerator.d.ts b/types/utils/UUidGenerator.d.ts index 000b719..ed1ffa6 100644 --- a/types/utils/UUidGenerator.d.ts +++ b/types/utils/UUidGenerator.d.ts @@ -1,4 +1,4 @@ import { IUUidGenerator } from "../models/spt/utils/IUuidGenerator"; export declare class UUidGenerator implements IUUidGenerator { - generate: () => string; + generate(): string; } diff --git a/types/utils/VFS.d.ts b/types/utils/VFS.d.ts index e5eaf02..267b10f 100644 --- a/types/utils/VFS.d.ts +++ b/types/utils/VFS.d.ts @@ -1,7 +1,7 @@ /// /// -import "reflect-metadata"; import fs from "fs"; +import "reflect-metadata"; import { IAsyncQueue } from "../models/spt/utils/IAsyncQueue"; import { IUUidGenerator } from "../models/spt/utils/IUuidGenerator"; export declare class VFS { @@ -32,8 +32,9 @@ export declare class VFS { createDirAsync(filepath: string): Promise; copyDir(filepath: string, target: string, fileExtensions?: string | string[]): void; copyDirAsync(filepath: string, target: string, fileExtensions: string | string[]): Promise; - readFile(filepath: string): any; - readFileAsync(filepath: string): Promise; + readFile(...args: Parameters): string; + readFileAsync(path: fs.PathLike): Promise; + private isBuffer; writeFile(filepath: any, data?: string, append?: boolean, atomic?: boolean): void; writeFileAsync(filepath: any, data?: string, append?: boolean, atomic?: boolean): Promise; getFiles(filepath: string): string[]; diff --git a/types/utils/Watermark.d.ts b/types/utils/Watermark.d.ts index e02eba2..f870cf1 100644 --- a/types/utils/Watermark.d.ts +++ b/types/utils/Watermark.d.ts @@ -30,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 */ diff --git a/types/utils/collections/queue/Queue.d.ts b/types/utils/collections/queue/Queue.d.ts new file mode 100644 index 0000000..645d462 --- /dev/null +++ b/types/utils/collections/queue/Queue.d.ts @@ -0,0 +1,12 @@ +export declare class Queue { + private elements; + private head; + private tail; + constructor(); + enqueue(element: T): void; + enqueueAll(elements: T[]): void; + dequeue(): T; + peek(): T; + getLength(): number; + isEmpty(): boolean; +} diff --git a/types/utils/decorators/Singleton.d.ts b/types/utils/decorators/Singleton.d.ts deleted file mode 100644 index 7e89026..0000000 --- a/types/utils/decorators/Singleton.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -import type constructor from "./constructor"; -import { InjectionToken } from "tsyringe"; -declare function singleton(token?: InjectionToken): (target: constructor) => void; -export default singleton; diff --git a/types/utils/decorators/constructor.d.ts b/types/utils/decorators/constructor.d.ts deleted file mode 100644 index 416f354..0000000 --- a/types/utils/decorators/constructor.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -declare type constructor = { - new (...args: any[]): T; -}; -export default constructor; diff --git a/types/utils/Logger.d.ts b/types/utils/logging/AbstractWinstonLogger.d.ts similarity index 62% rename from types/utils/Logger.d.ts rename to types/utils/logging/AbstractWinstonLogger.d.ts index 3d9013f..1ae1100 100644 --- a/types/utils/Logger.d.ts +++ b/types/utils/logging/AbstractWinstonLogger.d.ts @@ -1,19 +1,17 @@ /// import fs from "fs"; import winston from "winston"; -import { Daum } from "../models/eft/itemEvent/IItemEventRouterRequest"; -import { LogBackgroundColor } from "../models/spt/logging/LogBackgroundColor"; -import { LogTextColor } from "../models/spt/logging/LogTextColor"; -import { SptLogger } from "../models/spt/logging/SptLogger"; -import { IAsyncQueue } from "../models/spt/utils/IAsyncQueue"; -import { ILogger } from "../models/spt/utils/ILogger"; -import { IUUidGenerator } from "../models/spt/utils/IUuidGenerator"; -export declare class WinstonLogger implements ILogger { +import { Daum } from "../../models/eft/itemEvent/IItemEventRouterRequest"; +import { LogBackgroundColor } from "../../models/spt/logging/LogBackgroundColor"; +import { LogTextColor } from "../../models/spt/logging/LogTextColor"; +import { SptLogger } from "../../models/spt/logging/SptLogger"; +import { IAsyncQueue } from "../../models/spt/utils/IAsyncQueue"; +import { ILogger } from "../../models/spt/utils/ILogger"; +import { IUUidGenerator } from "../../models/spt/utils/IUuidGenerator"; +export declare abstract class AbstractWinstonLogger implements ILogger { protected asyncQueue: IAsyncQueue; protected uuidGenerator: IUUidGenerator; protected showDebugInConsole: boolean; - protected folderPath: string; - protected file: string; protected filePath: string; protected logLevels: { levels: { @@ -47,12 +45,25 @@ export declare class WinstonLogger implements ILogger { protected logger: winston.Logger & SptLogger; protected writeFilePromisify: (path: fs.PathLike, data: string, options?: any) => Promise; constructor(asyncQueue: IAsyncQueue, uuidGenerator: IUUidGenerator); + protected abstract isLogToFile(): boolean; + protected abstract isLogToConsole(): boolean; + protected abstract isLogExceptions(): boolean; + protected abstract getFilePath(): string; + protected abstract getFileName(): string; + protected getLogMaxSize(): string; + protected getLogMaxFiles(): string; writeToLogFile(data: string | Daum): Promise; log(data: string | Error | Record, color: string, backgroundColor?: string): Promise; error(data: string | Record): Promise; 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/logging/WinstonMainLogger.d.ts b/types/utils/logging/WinstonMainLogger.d.ts new file mode 100644 index 0000000..3c67902 --- /dev/null +++ b/types/utils/logging/WinstonMainLogger.d.ts @@ -0,0 +1,13 @@ +import { IAsyncQueue } from "../../models/spt/utils/IAsyncQueue"; +import { IUUidGenerator } from "../../models/spt/utils/IUuidGenerator"; +import { AbstractWinstonLogger } from "./AbstractWinstonLogger"; +export declare class WinstonMainLogger extends AbstractWinstonLogger { + protected asyncQueue: IAsyncQueue; + protected uuidGenerator: IUUidGenerator; + constructor(asyncQueue: IAsyncQueue, uuidGenerator: IUUidGenerator); + protected isLogExceptions(): boolean; + protected isLogToFile(): boolean; + protected isLogToConsole(): boolean; + protected getFilePath(): string; + protected getFileName(): string; +} diff --git a/types/utils/logging/WinstonRequestLogger.d.ts b/types/utils/logging/WinstonRequestLogger.d.ts new file mode 100644 index 0000000..1475e43 --- /dev/null +++ b/types/utils/logging/WinstonRequestLogger.d.ts @@ -0,0 +1,14 @@ +import { IAsyncQueue } from "../../models/spt/utils/IAsyncQueue"; +import { IUUidGenerator } from "../../models/spt/utils/IUuidGenerator"; +import { AbstractWinstonLogger } from "./AbstractWinstonLogger"; +export declare class WinstonRequestLogger extends AbstractWinstonLogger { + protected asyncQueue: IAsyncQueue; + protected uuidGenerator: IUUidGenerator; + constructor(asyncQueue: IAsyncQueue, uuidGenerator: IUUidGenerator); + protected isLogExceptions(): boolean; + protected isLogToFile(): boolean; + protected isLogToConsole(): boolean; + protected getFilePath(): string; + protected getFileName(): string; + protected getLogMaxSize(): string; +}