ISource2ModTranslations

A phrase is a name ("Welcome") with a text per language and, optionally, a format that says what its {1}, {2}, ... placeholders are ("{1:s},{2:d}"). Phrases come from wherever the plugin has them: a phrase file (translations/<file>.txt, SourceMod's layout), JSON, or one call per text at runtime -- a plugin that downloads its texts (HTTP, SQL) pushes them when they arrive and can change or remove them later. Files are only one source.

Lookups never fail: a phrase without the asked language falls back to the server's language, then English, then the phrase name itself.

auto* tr = g_pSource2ModTranslations;
tr->AddPhrase(g_PluginID, "Welcome", "en", "Welcome, {1}!", "{1:s}");
tr->AddPhrase(g_PluginID, "Welcome", "cze", "Vítej, {1}!");

const char* args[] = { player->GetPlayerName() };
char text[256];
tr->FormatPhrase(g_PluginID, "Welcome", player->GetPlayerSlot(), args, 1, text, sizeof(text));

Interface id ISource2ModTranslations001 (SOURCE2MOD_TRANSLATIONS_INTERFACE) · Global g_pSource2ModTranslations · Header source2mod/ISource2ModTranslations.h

Methods

`GetLanguageCount`

virtual int GetLanguageCount() = 0;

Languages known: configs/languages.cfg plus those added at runtime.

`GetLanguageInfo`

virtual bool GetLanguageInfo(int language, const char** code, const char** name) = 0;

A language's code ("en", "cze") and name ("English").

Parameter	Type
`language`	`int`
`code`	`const char**`
`name`	`const char**`

Returns bool — false for an index out of range.

`FindLanguage`

virtual int FindLanguage(const char* codeOrName) = 0;

A language by its code or its name (either, case-insensitive); -1 when unknown.

Parameter	Type
`codeOrName`	`const char*`

`AddLanguage`

virtual int AddLanguage(const char* code, const char* name) = 0;

Adds a language at runtime (or finds it when the code is known).

Parameter	Type
`code`	`const char*`
`name`	`const char*`

Returns int — Its index.

`GetServerLanguage`

virtual int GetServerLanguage() = 0;

The server's language (ServerLang in core.json).

`GetPlayerLanguage`

virtual int GetPlayerLanguage(CPlayerSlot slot) = 0;

A player's language: one set with SetPlayerLanguage, else the client's own (its cl_language), else the server's.

Parameter	Type
`slot`	`CPlayerSlot`

`SetPlayerLanguage`

virtual void SetPlayerLanguage(CPlayerSlot slot, int language) = 0;

Overrides a player's language until they disconnect; -1 goes back to theirs.

Parameter	Type
`slot`	`CPlayerSlot`
`language`	`int`

`LoadPhraseFile`

virtual bool LoadPhraseFile(PluginId owner, const char* file, char* error, size_t maxlen) = 0;

Loads translations/<file>.txt and translations/<code>/<file>.txt for every language (SourceMod's phrase files) into @p owner's phrases.

Parameter	Type
`owner`	`PluginId`
`file`	`const char*`
`error`	`char*`
`maxlen`	`size_t`

Returns bool — false (and why in @p error) when the base file is missing or broken.

`LoadPhrasesJson`

virtual bool LoadPhrasesJson(PluginId owner, const char* json, char* error, size_t maxlen) = 0;

Loads phrases from JSON: {"<phrase>": {"#format": "{1:s}", "<code>": "<text>", ...}, ...}. Unknown language codes are added.

Parameter	Type
`owner`	`PluginId`
`json`	`const char*`
`error`	`char*`
`maxlen`	`size_t`

Returns bool — false (and why in @p error) for text that is not such an object.

`AddPhrase`

virtual void AddPhrase(PluginId owner, const char* phrase, const char* language, const char* text, const char* format = nullptr) = 0;

Adds or replaces one text of a phrase.

Parameter	Type	Default	Description
`owner`	`PluginId`
`phrase`	`const char*`
`language`	`const char*`		A language code; one not known yet is added.
`text`	`const char*`
`format`	`const char*`	`nullptr`	The phrase's placeholder format ("{1:s},{2:d}"); nullptr keeps the one it has.

`RemovePhrase`

virtual bool RemovePhrase(PluginId owner, const char* phrase, const char* language = nullptr) = 0;

Removes a phrase's text in one language, or the whole phrase for a null / empty @p language.

Parameter	Type	Default
`owner`	`PluginId`
`phrase`	`const char*`
`language`	`const char*`	`nullptr`

Returns bool — false when there was nothing to remove.

`ClearPhrases`

virtual void ClearPhrases(PluginId owner) = 0;

Drops every phrase of @p owner (a plugin's go when it unloads anyway).

Parameter	Type
`owner`	`PluginId`

`PhraseExists`

virtual bool PhraseExists(PluginId owner, const char* phrase) = 0;

Parameter	Type
`owner`	`PluginId`
`phrase`	`const char*`

`IsTranslatedFor`

virtual bool IsTranslatedFor(PluginId owner, const char* phrase, int language) = 0;

Parameter	Type
`owner`	`PluginId`
`phrase`	`const char*`
`language`	`int`

`Translate`

virtual size_t Translate(PluginId owner, const char* phrase, CPlayerSlot target, char* buffer, size_t maxlen) = 0;

The raw text of a phrase for a target ({n} placeholders left in).

Parameter	Type	Description
`owner`	`PluginId`
`phrase`	`const char*`
`target`	`CPlayerSlot`	A player, or SOURCE2MOD_LANG_SERVER.
`buffer`	`char*`
`maxlen`	`size_t`

Returns size_t — Bytes written; the fallbacks (server language, English, the phrase name) mean there always is a text.

`FormatPhrase`

virtual size_t FormatPhrase(PluginId owner, const char* phrase, CPlayerSlot target, const char* const* args, int numArgs, char* buffer, size_t maxlen) = 0;

The text for a target with its {1}..{n} replaced by @p args. The values are text already; the phrase's format is not applied.

Parameter	Type
`owner`	`PluginId`
`phrase`	`const char*`
`target`	`CPlayerSlot`
`args`	`const char* const*`
`numArgs`	`int`
`buffer`	`char*`
`maxlen`	`size_t`

Returns size_t — Bytes written.

Macros

`SOURCE2MOD_LANG_SERVER`

#define SOURCE2MOD_LANG_SERVER CPlayerSlot(-1)

The server, as a translation target (FormatPhrase / Translate).

ISource2ModTranslations

On this page