system.getLocale

since 1.1.0

Return the current locale.

system.getLocale()

Parameters

None.

Returns

Locale as a string, i.e. "en", "fr"

Examples

local NAMES = { en = "Battery", fr = "Batterie", de = "Akku" }

local function name()
  return NAMES[system.getLocale()] or NAMES.en
end

system.registerWidget({ key = "batt", name = name, create = create, paint = paint })

See Translations for a translation-file pattern.

Used in

• source
• tool-servo
• widget-gauge
• widget-sinus

Real-world usage

Called 17 times across 3 open-source Ethos Lua projects. A few short excerpts:

Example 1Example 2Example 3

changeLocale(system.getLocale())

gps-qrcode/i18n/i18n.lua:24

local locale = system.getLocale()

lua/frsky/RB25_S/stab/i18n/i18n.lua:1

dashx.session.telemetryTypeChanged = nil
dashx.session.telemetrySensor = nil
dashx.session.repairSensors = false
dashx.session.locale = system.getLocale()

src/dashx/lib/utils.lua:45