> For the complete documentation index, see [llms.txt](https://docs.gamesense.biz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gamesense.biz/api-reference/locale.md).

# Locale

Translate UI strings from Lua.

The `locale` library registers and retrieves translations for interface strings.

## locale.set

`locale.set(original: string, translated: string)`

Adds or updates a translation.

```lua
locale.set("Enabled", "Включено")
```

## locale.load

`locale.load(translations: table)`

Registers multiple translations. Table keys are original strings; values are translations.

```lua
locale.load({
    ["Enabled"] = "Включено",
    ["Disabled"] = "Выключено",
    ["Settings"] = "Настройки"
})
```

## locale.translate

`locale.translate(text: string): string`

Returns the translated string, or the original string if no translation is available.

```lua
local title = locale.translate("Settings")
menu.label(title)
```

## locale.get

`locale.get(original: string): string | nil`

Returns a translation or `nil` if it does not exist.

## locale.clear

`locale.clear()`

Removes translations registered by the **current script**.

## locale.strings

`locale.strings([prefix: string]): table`

Returns discovered interface strings. An optional prefix filters the results.

## locale.export\_template

`locale.export_template(): boolean`

Exports a translation template to the scripts folder (`language_template.lua`). Returns `true` on success.

**Limits:** source strings up to 200 characters, translations up to 400 characters, and up to 6,000 translations per script.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.gamesense.biz/api-reference/locale.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.