Class: Localization

The engine's text lookup (Engine.GetLocalization, Game.locale). Tables are registered by id — DataProject from the build manifest, the editor from the project's .strings assets — and a key in several tables takes the last-registered one. A missing translation falls back to the default language, then to the key itself, so an untranslated string is visible, not blank.

version bumps on any change (language, tables): LocalizedTextSystem re-resolves on it.

Constructors

Constructor

new Localization(): Localization;

Returns

Localization

Accessors

defaultLanguage

Get Signature

get defaultLanguage(): string;

Used when the current language lacks a key.

Returns

string

Set Signature

set defaultLanguage(language): void;

Parameters

Parameter	Type
language	string

Returns

void

---

language

Get Signature

get language(): string;

Returns

string

Set Signature

set language(language): void;

Parameters

Parameter	Type
language	string

Returns

void

---

languages

Get Signature

get languages(): string[];

Every language any table has, in first-seen order.

Returns

string[]

---

version

Get Signature

get version(): number;

Returns

number

Methods

AddTable()

AddTable(id, data): void;

Parameters

Parameter	Type
id	string
data	StringTableData

Returns

void

---

Detect()

Detect(preferred?): string;

The supported language that best matches the player's preferences (navigator.languages): an exact tag, else the same base language ('fr-CA' → 'fr'). The default when none does.

Parameters

Parameter	Type
preferred	readonly string[]

Returns

string

---

Get()

Get(key, params?): string;

The text for key in the current language, with {name} params filled in.

Parameters

Parameter	Type
key	string
params?	Readonly<Record<string, string | number>> | null

Returns

string

---

GetTableIds()

GetTableIds(): string[];

Returns

string[]

---

Has()

Has(key): boolean;

Parameters

Parameter	Type
key	string

Returns

boolean

---

OnLanguageChanged()

OnLanguageChanged(cb): () => void;

Parameters

Parameter	Type
cb	(language) => void

Returns

() => void

---

RemoveTable()

RemoveTable(id): void;

Parameters

Parameter	Type
id	string

Returns

void