Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:42Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextEditBox}}
Returns whether the player may edit the text of a TextEditBox.

<pre>
allowEditing = TextEditBoxGetAllowEditing(editBoxName)
</pre>

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

== Returns ==
;allowEditing : <code>boolean</code> – The box's allow-editing flag, as set by [[API:TextEditBoxSetAllowEditing|TextEditBoxSetAllowEditing]].

== Details ==
* If the window does not exist or is not a TextEditBox, the error is logged and nothing is returned.
* The function needs at least one argument and only reads the last one.
* The stock UI never calls <code>TextEditBoxGetAllowEditing</code>.

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

== Example ==
A minimal example built from the signature above:
<pre>
if( TextEditBoxGetAllowEditing( "MyEditBox" ) ) then
TextEditBoxSetText( "MyEditBox", L"" )
end
</pre>

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

API:TextEditBoxGetAllowEditing - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)