Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:47Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextEditBox}}
Inserts text into a TextEditBox without replacing what is already there.

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

== Arguments ==
;editBoxName : <code>string</code> – Name of a TextEditBox window.
;text : <code>wstring</code> – The text to insert. It must be a wide string.

== Returns ==
Nothing.

== Details ==
* The stock chat window uses it to put links at the cursor position of the chat input line; its comment reads ''"Insert the text at the current cursor location"''. To replace the whole text use [[API:TextEditBoxSetText|TextEditBoxSetText]].
* Passing an ordinary Lua string raises an ''Invalid Parameters'' error. Convert with <code>towstring()</code> first.
* The function needs at least two arguments and only reads the last two.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'TextEditBoxInsertText': Window %s does not exist</code>
* <code>Error in function call 'TextEditBoxInsertText': Window %s is not a TextEditBox</code>

== Example ==
From <code>ea_chatwindow/source/chatwindow.lua</code>:
<pre>
function EA_ChatWindow.InsertText( text )

-- Insert the text at the current cursor location
TextEditBoxInsertText( "EA_TextEntryGroupEntryBoxTextInput", text )
</pre>

== See also ==
* [[API:TextEditBoxSetText|TextEditBoxSetText]]
* [[API:CreateHyperLink|CreateHyperLink]]
* [[API:TextEditBoxSetMaxChars|TextEditBoxSetMaxChars]]

API:TextEditBoxInsertText - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)