i18n_set_locale()

The i18n_set_locale() function is used to change the current locale used by the GM-I18n system.

This function can only be used after the i18n_create() function is called.

Syntax

Usage
i18n_set_locale(code, [update_refs], [i18n]);
Signature
function i18n_set_locale(
    code: string,
    update_refs?: boolean,         // default = true
    i18n?: I18n | boolean          // default = false (using global i18n struct)
): void

Parameters

NameTypeDefaultDescription
codeStringThe locale code to switch to.
update_refsBooleantrueUpdate all references (message and asset) to the new locale.
i18nBoolean | I18nfalseThe i18n struct reference, or leave it empty to use the global i18n struct.

Returns

Void

Examples

Create Event
// assume the system is initialized on global variable

// change the locale to "id"
i18n_set_locale("id");
Edit this page on GitHub
Table of Contents