Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:40:49Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Button}}
Sets the text shown on a Button.

<pre>
ButtonSetText(buttonName, text)
</pre>

== Arguments ==
;buttonName : <code>string</code> – Name of a Button window.
;text : <code>wstring</code> – The text to show. It must be a wide string: <code>L"Accept"</code> works, <code>"Accept"</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.
* A Button with no text label (for example an icon-only button) silently ignores the call.
* If the button is set to resize to its text, it is resized to fit the new text, plus its text padding on each side.
* If the text does not fit, the client may print one of these warnings to the debug log. This happens only for buttons that have clipping warnings enabled.
** <code>Text is cut off in Button %s.</code>
** <code>Font sized is auto-scaled down in Button %s.</code>
* The function needs at least two arguments and only reads the last two.

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

== Example ==
From <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
ButtonSetText( "TextEntryDlg"..dlg.."ButtonCancel", GetPregameString(StringTables.Pregame.LABEL_CANCEL) )
ButtonSetText( "OneButtonDlg"..dlgIndex.."BoxButton1", buttonText )
</pre>

== See also ==
* [[API:ButtonGetText|ButtonGetText]]
* [[API:LabelSetText|LabelSetText]]

API:ButtonSetText - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)