Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:05Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Returns a localised string from a string table with parameters filled in.

<pre>
text = GetStringFormatFromTable(tableName, id, params)
</pre>

== Arguments ==
;tableName : <code>string</code> – Name of the string table.
;id : <code>number</code> – Index of the string in the table.
;params : <code>wstring-table</code> – Array of wide strings to substitute into the string's placeholders, in order.

== Returns ==
;text : <code>wstring</code> – The string with the parameters substituted.

== Details ==
* The table name is matched without regard to case.
* Every entry of <code>params</code> must be a wide string. The stock helper in <code>easystem_strings/source/stringutils.lua</code> converts each entry with <code>WideStringFromData</code> before calling.
* If <code>id</code> is outside the table, the result is built from an empty string, so <code>L""</code> is returned. No message is logged.
* If the table does not exist, error messages are logged and no string is produced. The stock helper guards against this with <code>or L""</code>.

== Errors ==
* <code>StringTable %s does not exist.</code>
* <code>Error in function call 'GetStringFormatFromTable': String Table %s does not exist.</code>
* <code>Error in function call 'GetStringFormatFromTable': Id %d is invalid for table %s.</code><br/>This message exists in the client but never appears: the string lookup it depends on always reports success.

== Example ==
From <code>easystem_strings/source/stringutils.lua</code>:
<pre>
return GetStringFormatFromTable( "Default", StringTables.Default.LABEL_LIST_FORMAT, { currentListText, newItemText } )
</pre>

From the same file:
<pre>
-- Convert all params to wstrings
for index, parameter in ipairs (paramTable)
do
paramTable[index] = WideStringFromData (parameter)
end

text = GetStringFormatFromTable( tableName, id, paramTable ) or L""
</pre>

== See also ==
* [[API:GetStringFromTable|GetStringFromTable]]

API:GetStringFormatFromTable - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)