Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:49Z

UI Lua API import (WAR 1.4.8)

New page

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

<pre>
TextEditBoxSetAllowEditing(editBoxName, allowEditing)
</pre>

== Arguments ==
;editBoxName : <code>string</code> – Name of a TextEditBox window.
;allowEditing : <code>boolean</code> – <code>true</code> to allow editing, <code>false</code> to make the box read-only.

== Returns ==
Nothing.

== Details ==
* The value is stored in the box's allow-editing flag, which [[API:TextEditBoxGetAllowEditing|TextEditBoxGetAllowEditing]] returns.
* If a certain state flag of the box is set when the call is made, the client also updates the box and its child windows right away.
* The stock guild recruiting profile uses it to make its text fields read-only for players who lack the guild's <code>SET_RECRUITERS</code> permission.
* <code>allowEditing</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* 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 'TextEditBoxSetAllowEditing': Window %s does not exist</code>
* <code>Error in function call 'TextEditBoxSetAllowEditing': Window %s is not a TextEditBox</code>

== Example ==
From <code>ea_guildwindow/source/guildwindowtabrecruitprofile.lua</code>:
<pre>
-- Brief Description
TextEditBoxSetAllowEditing( "GWRecruitProfileDescEditBox", not disabled )

-- Public Summary
TextEditBoxSetAllowEditing( "GWRecruitProfileSummaryEditBox", not disabled )
</pre>

== See also ==
* [[API:TextEditBoxGetAllowEditing|TextEditBoxGetAllowEditing]]
* [[API:TextEditBoxSetText|TextEditBoxSetText]]

API:TextEditBoxSetAllowEditing - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)