https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AWindowAssignFocusAPI:WindowAssignFocus - Revision history2026-10-17T17:54:06ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:WindowAssignFocus&diff=30862&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:51:19Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Window}}<br />
Gives keyboard focus to a window, or takes it away.<br />
<br />
<pre><br />
WindowAssignFocus(windowName, focus)<br />
</pre><br />
<br />
== Arguments ==<br />
;windowName : <code>string</code> – Name of the window, typically a TextEditBox.<br />
;focus : <code>boolean</code> – <code>true</code> to give the window focus, <code>false</code> to take it away.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* With <code>true</code>, the window must currently be drawn on screen. Show it (and its parents) first, otherwise the call raises the ''is not visible'' error.<br />
* With <code>false</code>, there is no visibility check.<br />
* <code>focus</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.<br />
* The function needs at least two arguments and only reads the last two.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'WindowAssignFocus': Window %s does not exist</code><br />
* <code>Error in function call 'WindowAssignFocus': Window %s is not visible. You may not set focus to a window that is not currently being drawn on the screen.</code><br />
* <code>Error in function call 'WindowAssignFocus': Window %s is currently locked and may not be modified from lua. ...</code><br/>This check never triggers in the current client. See [[API:WindowSetShowing|WindowSetShowing]].<br />
<br />
== Example ==<br />
Showing a text entry dialog and focusing its edit box, from <code>easystem_dialogmanager/source/dialogmanager.lua</code>:<br />
<pre><br />
-- Finally, show the dialog.<br />
WindowSetShowing( "TextEntryDlg"..dlgIndex, true )<br />
WindowAssignFocus( "TextEntryDlg"..dlgIndex.."TextEntry", true )<br />
TextEditBoxSelectAll( "TextEntryDlg"..dlgIndex.."TextEntry" )<br />
</pre><br />
<br />
Releasing the focus when the dialog is closed, same file:<br />
<pre><br />
-- Ideally this should be done automatically when the window is hidden, but whatever.<br />
WindowAssignFocus( "TextEntryDlg"..dlgIndex.."TextEntry", false )<br />
</pre><br />
<br />
== See also ==<br />
* [[API:WindowSetShowing|WindowSetShowing]]<br />
* [[API:WindowSetTabOrder|WindowSetTabOrder]]</div>Maintenance script