i18n_get_locale()

The i18n_get_locale() function is used to get the current locale code used by the GM-I18n system.

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

Syntax

Usage
i18n_get_locale([i18n]);
Signature
function i18n_get_locale(
    i18n?: I18n | boolean           // default = false (using global i18n struct)
): string

Parameters

NameTypeDefaultDescription
i18nBoolean | I18nfalseThe i18n struct reference, or leave it empty to use the global i18n struct.

Returns

String

Examples

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

// get the current locale
var locale = i18n_get_locale();