Class default

Hierarchy

Host<ILanguageEvents>
- default

Index

Constructors

Properties

Accessors

language loadID orderedProviders providers

Methods

add deserialize generateSchema getTranslation initialize reformatSingularNoun refreshUiTranslations remove reserializeFromFiles serialize serializeLanguageToFile serializeToFiles shouldUseAlternateFontStyle

Constructors

constructor

new default(game: Game): default
Parameters
- game: Game
Returns default
Overrides EventEmitter.Host<ILanguageEvents>.constructor
- Defined in src/game/language/LanguageManager.ts:94

Properties

`Readonly` event

event: IEventEmitter<default, ILanguageEvents>

Accessors

language

get language(): string
Returns string
- Defined in src/game/language/LanguageManager.ts:98
set language(languageName: string): void
Parameters
- languageName: string
Returns void
- Defined in src/game/language/LanguageManager.ts:102

loadID

get loadID(): number
Returns number
- Defined in src/game/language/LanguageManager.ts:137

orderedProviders

get orderedProviders(): readonly default[]
Returns readonly default[]
- Defined in src/game/language/LanguageManager.ts:120

providers

get providers(): readonly default[]
Returns readonly default[]
- Defined in src/game/language/LanguageManager.ts:115

Methods

add

add(provider: default): void
Parameters
- provider: default
Returns void
- Defined in src/game/language/LanguageManager.ts:299

deserialize

deserialize(serialized: ISerializedLanguage | ISerializedLanguageExtension): default | default
Parameters
- serialized: ISerializedLanguage | ISerializedLanguageExtension
Returns default | default
- Defined in src/game/language/LanguageManager.ts:439

generateSchema

generateSchema(): void
Returns void
- Defined in src/game/language/LanguageManager.ts:475

getTranslation

getTranslation(dictionary: default, entry: string | number, ignoreInvalid?: boolean): undefined | string[]
Parameters
- dictionary: default
- entry: string | number
- ignoreInvalid: boolean = false
Returns undefined | string[]
- Defined in src/game/language/LanguageManager.ts:256

initialize

initialize(): void
Returns void
- Defined in src/game/language/LanguageManager.ts:141

reformatSingularNoun

reformatSingularNoun(noun: string, count: number, article?: false | "definite" | "indefinite"): string
Parameters
- noun: string
- count: number
- article: false | "definite" | "indefinite" = "indefinite"
Returns string
- Defined in src/game/language/LanguageManager.ts:479

refreshUiTranslations

refreshUiTranslations(): void
Returns void
- Defined in src/game/language/LanguageManager.ts:191

remove

remove(provider: default): void
Parameters
- provider: default
Returns void
- Defined in src/game/language/LanguageManager.ts:308

reserializeFromFiles

reserializeFromFiles(files: Map<string, Record<string, any>>): ISerializedLanguage
Unserializes the language from individual pieces (from Weblate), into an ISerializedLanguage object
Parameters
- files: Map<string, Record<string, any>>
Returns ISerializedLanguage
- Defined in src/game/language/LanguageManager.ts:389

serialize

serialize(languageName?: string, caseStyle?: CaseStyle): undefined | ISerializedLanguage
Parameters
- languageName: string = ...
- caseStyle: CaseStyle = CaseStyle.CamelCase
Returns undefined | ISerializedLanguage
- Defined in src/game/language/LanguageManager.ts:321

serializeLanguageToFile

serializeLanguageToFile(language?: string, caseStyle?: CaseStyle): void
Parameters
- language: string = ...
- Optional caseStyle: CaseStyle
Returns void
- Defined in src/game/language/LanguageManager.ts:358

serializeToFiles

serializeToFiles(language?: string, caseStyle?: CaseStyle): Map<string, string>
Serializes the language into individual pieces for use by Weblate
Parameters
- language: string = ...
- caseStyle: CaseStyle = CaseStyle.PascalCase
Returns Map<string, string>
- Defined in src/game/language/LanguageManager.ts:365

shouldUseAlternateFontStyle

shouldUseAlternateFontStyle(): boolean
Returns boolean
- Defined in src/game/language/LanguageManager.ts:184

Generated using TypeDoc