Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:38Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=StringTable}}
Loads a localized string table from the game data so its strings can be looked up by the UI.

<pre>
LoadStringTable(tableName, directory, fileName, cacheDirectory, luaTableName)
</pre>

== Arguments ==
;tableName : <code>string</code> – Name to register the table under. Used later with [[API:UnloadStringTable|UnloadStringTable]] and the string lookup functions.
;directory : <code>string</code> – Folder of the string file, for example <code>"data/strings/<LANG>"</code>.
;fileName : <code>string</code> – Name of the string file in that folder, for example <code>"pregame.txt"</code>.
;cacheDirectory : <code>string</code> – Folder for the client's cache files of the table, for example <code>"cache/<LANG>"</code>.
;luaTableName : <code>string</code> – Path of a Lua table to fill with the string keys, for example <code>"StringTables.Pregame"</code>. Pass <code>""</code> for none.

== Returns ==
Nothing.

== Details ==
* The file path is <code>directory</code> and <code>fileName</code> joined with a <code>/</code> (none is added if <code>directory</code> already ends with one).
* The stock UI writes <code><LANG></code> in the folder names; the client replaces it with the current language.
* The cache file is <code>''cacheDirectory''/''tableName''.cache</code>. When <code>luaTableName</code> is not empty, a second cache file <code>''cacheDirectory''/''tableName''.cache2</code> is used as well.
* <code>tableName</code> is compared without regard to case. A name that is already loaded is refused with an error.
* When <code>luaTableName</code> is not empty, the Lua table at that path gets one number field per string key, named after the key. The stock UI uses these fields to look strings up, for example <code>GetPregameString(StringTables.Pregame.LABEL_CANCEL)</code>.
* If loading fails, the table is not registered and an error is raised.
* The function needs at least five arguments and only reads the last five. All must be strings.

== Errors ==
* <code>No StringTable file specified.</code> (empty <code>fileName</code>)
* <code>StringTable name %s is already in use.</code>
* <code>StringTable %s: %s</code> (loading failed; the second value is the client's reason)

== Example ==
From <code>interfacecore/interfacecore.lua</code>:
<pre>
LoadStringTable("Pregame", "data/strings/<LANG>", "pregame.txt", "cache/<LANG>", "StringTables.Pregame" )
LoadStringTable("Hardcoded", "data/strings/<LANG>", "hardcoded.txt", "cache/<LANG>", "" )
</pre>

== See also ==
* [[API:UnloadStringTable|UnloadStringTable]]
* [[API:BuildTableFromCSV|BuildTableFromCSV]]

API:LoadStringTable - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)