Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:06Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Returns a localised string from one of the client's string tables.

<pre>
text = GetStringFromTable(tableName, id)
</pre>

== Arguments ==
;tableName : <code>string</code> – Name of the string table, for example <code>"Default"</code> or <code>"HUDStrings"</code>.
;id : <code>number</code> – Index of the string in the table. The stock UI uses the constants in <code>StringTables.''tableName''</code>.

== Returns ==
;text : <code>wstring</code> – The string, or <code>L""</code> if it cannot be found.

== Details ==
* The table name is matched without regard to case.
* If the table does not exist, two messages are logged (see [[#Errors|Errors]]) and <code>L""</code> is returned.
* If <code>id</code> is outside the table, <code>L""</code> is returned without any message.
* The text is returned as stored. Placeholders are not filled in; use [[API:GetStringFormatFromTable|GetStringFormatFromTable]] for that.
* The function needs at least two arguments and only reads the last two.

== Errors ==
* <code>StringTable %s does not exist.</code>
* <code>Error in function call 'GetStringFromTable': String Table %s does not exist.</code>

== Example ==
From <code>easystem_eventtext/source/system_eventtext.lua</code>:
<pre>
[ GameData.CombatEvent.BLOCK ] = GetStringFromTable("CombatEvents", StringTables.CombatEvents.LABEL_BLOCK ),
[ GameData.CombatEvent.PARRY ] = GetStringFromTable("CombatEvents", StringTables.CombatEvents.LABEL_PARRY ),
</pre>

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

API:GetStringFromTable - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)