Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:54Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextEditBox}}
Replaces the text in a TextEditBox.

<pre>
TextEditBoxSetText(editBoxName, text)
</pre>

== Arguments ==
;editBoxName : <code>string</code> – Name of a TextEditBox window.
;text : <code>wstring</code> – The new text. It must be a wide string: <code>L""</code> clears the box.

== Returns ==
Nothing.

== Details ==
* If <code>text</code> equals the current text, nothing happens.
* Otherwise the box is cleared and the new text is inserted.
* Passing an ordinary Lua string raises an ''Invalid Parameters'' error. Convert with <code>towstring()</code> first.
* While the box has keyboard focus and an IME composition is in progress, the call is ignored.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

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

== Example ==
Clearing the chat input line, from <code>ea_chatwindow/source/chatwindow.lua</code>:
<pre>
TextEditBoxSetText("EA_TextEntryGroupEntryBoxTextInput", L"")
</pre>

Filling a text entry dialog with a default, from <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
TextEditBoxSetText( "TextEntryDlg"..dlgIndex.."TextEntry", defaultUserText )
</pre>

== See also ==
* [[API:TextEditBoxGetText|TextEditBoxGetText]]
* [[API:TextEditBoxSelectAll|TextEditBoxSelectAll]]

API:TextEditBoxSetText - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)