Locales

Texts shown to players, per language. Each has a key and an English default. You can set your own text for any language, and add keys for your own content. A player sees the text in their game's language (player.language), then the server's English text, then the default. Placeholders such as {thief} are filled in by name.

locales.defaultLanguage

defaultLanguage: string

The language used when a player's language has no text: 'english'.

locales.defaults.pickpocket.victimNotice

defaults.pickpocket.victimNotice: string

Default text of the notice a pickpocket's victim sees.

locales.defaults.items.maxTooltip

defaults.items.maxTooltip: string

Default tooltip for an item's carry limit.

locales.defaults.items.limitReached

defaults.items.limitReached: string

Default text for reaching an item's carry limit.

locales.defaults.stash.inUse

defaults.stash.inUse: string

Default text shown mid-screen when a container is open for another player.

locales.set()

Locales.set(language, texts)

Sets your texts for a language. An empty text returns a key to its default.

locales.get()

Locales.get(key, language)

A key's text in a language: your text, then your English text, then the default, or undefined if there is none.

locales.text()

Locales.text(player, key, params)

A key's text in a player's game language, with placeholders filled in, or the key itself if there is no text.