Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:44Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextEditBox}}
Returns the input history of a TextEditBox.

<pre>
history = TextEditBoxGetHistory(editBoxName)
</pre>

== Arguments ==
;editBoxName : <code>string</code> – Name of a TextEditBox window.

== Returns ==
;history : <code>wstring-table</code> – Array of the stored history lines, indexed from 1. An empty table if there is no history.

== Details ==
* A TextEditBox with history enabled stores each non-empty line the player confirms with Enter, and the player can step back through the stored lines.
* The table can be passed back to [[API:TextEditBoxSetHistory|TextEditBoxSetHistory]] later, which is how the chat window keeps its history across logins.

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

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

-- Retrieve the history (this preserves it across logging in/out)
GameData.ChatData.history = TextEditBoxGetHistory("EA_TextEntryGroupEntryBoxTextInput")
end
</pre>

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

API:TextEditBoxGetHistory - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)