Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:28Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Label}}
Sets the text shown by a Label.

<pre>
LabelSetText(labelName, text)
</pre>

== Arguments ==
;labelName : <code>string</code> – Name of a Label window.
;text : <code>wstring</code> – The text to show. It must be a wide string: <code>L"Hello"</code> works, <code>"Hello"</code> does not.

== Returns ==
Nothing.

== Details ==
* Passing an ordinary Lua string or a number as <code>text</code> raises an ''Invalid Parameters'' error. Convert with <code>towstring()</code> first if necessary.
* If the new text is the same as the current text, nothing happens.
* Otherwise the client stores the text, processes a copy for display, shortens that copy if it is longer than the label's maximum length, and lays the text out again. [[API:LabelGetText|LabelGetText]] returns the displayed copy.
* For windows with state tracking enabled, the client writes the new text to <code>''labelName''.STATE.LABEL_TEXT</code> (see [[API:LabelGetText|LabelGetText]]).
* The function needs at least two arguments and only reads the last two.

== Errors ==
* <code>Error in function call 'LabelSetText': Window %s does not exist</code>
* <code>Error in function call 'LabelSetText': Window %s is not a Label</code>

== Example ==
From <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
LabelSetText( "TwoButtonDlg"..dlgIndex.."BoxText", dialogText )
LabelSetText( "TwoButtonDlg"..dlgIndex.."BoxTimer", L"" )
</pre>

== See also ==
* [[API:LabelGetText|LabelGetText]]
* [[API:LabelSetTextColor|LabelSetTextColor]]
* [[API:ButtonSetText|ButtonSetText]]

API:LabelSetText - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)