@peacockproject/core
Version:
Type definitions for Peacock's core.
125 lines (124 loc) • 4.21 kB
TypeScript
import type { GameVersion } from "./types/types";
/**
* All the configurations. Gets modified before being exported.
*
* @private
*/
declare const configs: {
Roadmap: any;
StoreData: any;
FilterData: any;
LocationsData: any;
LeaderboardsViewTemplate: any;
LeaderboardEntriesTemplate: any;
GameChangerProperties: any;
allunlockables: any;
ServerVersionConfig: any;
OnlineConfig: any;
PrivacyPolicy: any;
UserDefault: any;
AgencyPickups: any;
Entrances: any;
MissionEndReadyTemplate: any;
MissionEndNotReadyTemplate: any;
SelectAgencyPickupTemplate: any;
SelectEntranceTemplate: any;
StashpointTemplate: any;
LoadMenuTemplate: any;
SaveMenuTemplate: any;
Playstyles: any;
HubPageData: any;
DashboardCategoryEscalation: any;
GlobalChallenges: any;
ContractsTemplate: any;
CreateContractPlanningTemplate: any;
CreateContractReturnTemplate: any;
PlayerProfilePage: any;
Legacyallunlockables: any;
LegacyGlobalChallenges: any;
LegacySafehouseTemplate: any;
LegacyHubTemplate: any;
LegacyPlanningTemplate: any;
LegacySelectAgencyPickupTemplate: any;
LegacySelectEntranceTemplate: any;
LegacyStashpointTemplate: any;
LegacyUserDefault: any;
LegacyFilterData: any;
PlayNextTemplate: any;
LookupContractByIdTemplate: any;
LookupContractFavoriteTemplate: any;
MissionStories: any;
DebriefingLeaderboardsTemplate: any;
LegacyHitsCategoryTemplate: any;
LegacyStoreData: any;
LegacyDestinationTemplate: any;
LegacyLocationsData: any;
LegacySaveMenuTemplate: any;
LegacyLoadMenuTemplate: any;
LegacyContractSearchResponseTemplate: any;
LegacyDebriefingChallengesTemplate: any;
DebriefingChallengesTemplate: any;
LegacyLookupContractByIdTemplate: any;
EiderDashboard: any;
H2allunlockables: any;
H2DestinationsData: any;
H2StoreData: any;
H2ContractSearchResponseTemplate: any;
H2LocationsData: any;
H2LookupContractByIdTemplate: any;
H2LookupContractFavoriteTemplate: any;
H2FilterData: any;
H2CareerTemplate: any;
H2DashboardTemplate: any;
H2SniperContentTemplate: any;
Videos: any;
ChallengeLocationTemplate: any;
H2ChallengeLocationTemplate: any;
LegacyChallengeLocationTemplate: any;
ReportTemplate: any;
ContractSearchPageTemplate: any;
ContractSearchPaginateTemplate: any;
ContractSearchResponseTemplate: any;
MasteryUnlockablesTemplate: any;
DiscordRichAssetsForBricks: any;
EscalationCodenames: any;
ScoreOverviewTemplate: any;
PeacockGameChangerProperties: any;
MultiplayerPresets: any;
LobbySlimTemplate: any;
MasteryDataForLocationTemplate: any;
LegacyMasteryLocationTemplate: any;
DefaultCpdConfigs: any;
EvergreenGameChangerProperties: any;
AreaMap: any;
ArcadePageTemplate: any;
HitsCategoryElusiveTemplate: any;
HitsCategoryContractAttackTemplate: any;
MissionRewardsTemplate: any;
SniperUnlockables: any;
VersusUnlockables: any;
LegacyStatisticsTemplate: any;
DynresModal: any;
};
export { configs };
/**
* Get a config file.
* Configs for H1 start with "Legacy", "H2" for HITMAN 2, and no prefix for HITMAN 3.
*
* @param config The name of the config file.
* @param clone If the value should be cloned (saves memory if false, but as a side effect, modifications will affect the actual config).
* @returns The config.
* @throws {Error} If the config file specified doesn't exist.
*/
export declare function getConfig<T = unknown>(config: keyof typeof configs, clone: boolean): T;
/**
* Get a config file intended for the specified game version.
*
* @param config The name of the config file.
* @param gameVersion The game's version ("h1", "h2", or "h3").
* @param clone If the config should be cloned (saves memory if false, but as a side effect, modifications will affect the actual config).
* @returns The config.
* @see getConfig
* @throws {Error} If the config file specified doesn't exist.
*/
export declare function getVersionedConfig<T = unknown>(config: string, gameVersion: GameVersion, clone: boolean): T;