Class Localization

Public API for player localization.

Implements

LocalizationApi
Destroyable

Index

Constructors

Accessors

localizationDetached localizationLocal

Methods

destroy get restoreLocalization wireDetached

Constructors

constructor

new Localization(
ompProvider: OmpProvider,
config: LocalizationConfig,
): Localization
Parameters
- ompProvider: OmpProvider
- config: LocalizationConfig
Returns Localization
- Defined in src/localization/localization.ts:40

Accessors

localizationDetached

get localizationDetached(): LocalizationDetachedApi | undefined
Returns LocalizationDetachedApi | undefined
- Defined in src/localization/localization.ts:69

localizationLocal

get localizationLocal(): LocalizationLocalApi
Returns LocalizationLocalApi
- Defined in src/localization/localization.ts:65

Methods

destroy

destroy(): void
Returns void
Implementation of Destroyable.destroy
- Defined in src/localization/localization.ts:106

get

get(key: "live" | "markIn" | "markOut"): string
Fetches the localized string for the given localization key. Falls back to the default localization value for that key if no override was configured.
Parameters
- key: "live" | "markIn" | "markOut"
  Localization key
Returns string
Implementation of LocalizationApi.get
- Defined in src/localization/localization.ts:83

restoreLocalization

restoreLocalization(
    overrides:
        | Partial<Record<"live" | "markIn" | "markOut", string>>
        | undefined,
): Observable<void>
Parameters
- overrides: Partial<Record<"live" | "markIn" | "markOut", string>> | undefined
Returns Observable<void>
- Defined in src/localization/localization.ts:87

wireDetached

wireDetached(localizationDetached: LocalizationDetachedApi): void
Parameters
- localizationDetached: LocalizationDetachedApi
Returns void
- Defined in src/localization/localization.ts:45