Valens-Progression/types/services/LocaleService.d.ts
2022-12-25 18:45:30 -05:00

42 lines
1.5 KiB
TypeScript

import { ILocaleConfig } from "../models/spt/config/ILocaleConfig";
import { ILogger } from "../models/spt/utils/ILogger";
import { ConfigServer } from "../servers/ConfigServer";
import { DatabaseServer } from "../servers/DatabaseServer";
/**
* Handles getting locales from config or users machine
*/
export declare class LocaleService {
protected logger: ILogger;
protected databaseServer: DatabaseServer;
protected configServer: ConfigServer;
protected localeConfig: ILocaleConfig;
constructor(logger: ILogger, 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 dictionary
*/
getLocaleDb(): Record<string, string>;
/**
* Gets the game locale key from the locale.json file,
* if value is 'system' get system locale
* @returns locale e.g en/ge/cz/cn
*/
getDesiredGameLocale(): string;
/**
* Gets the game locale key from the locale.json file,
* if value is 'system' get system locale
* @returns locale e.g en/ge/cz/cn
*/
getDesiredServerLocale(): string;
/**
* Get array of languages supported for localisation
* @returns array of locales e.g. en/fr/cn
*/
getServerSupportedLocales(): string[];
/**
* Get the locale of the computer running the server
* @returns langage part of locale e.g. 'en' part of 'en-US'
*/
protected getPlatformLocale(): string;
}