Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:20Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Removes all anchors from a window.

<pre>
WindowClearAnchors(windowName)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.

== Returns ==
Nothing.

== Details ==
* Every anchor is removed, whether it was added with [[API:WindowAddAnchor|WindowAddAnchor]] or came from the window's XML.
* After removing the anchors, the client sets the window's offset from its parent to (0, 0). The window moves to the top-left corner of its parent until it is anchored or positioned again. The client may shift this position to keep the window on screen (see [[API:WindowIsSticky|WindowIsSticky]]).
* The usual pattern is to clear the anchors and then add new ones straight away.

== Errors ==
* <code>Error in function call 'WindowClearAnchors': Window %s does not exist</code>
* <code>Error in function call 'WindowClearAnchors': 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]].

== Example ==
Moving a dialog by rebuilding its first anchor, from <code>easystem_dialogmanager/source/dialogmanager.lua</code>:
<pre>
local point, relativePoint, relativeTo, xoffs, yoffs = WindowGetAnchor( windowName, 1 )
xoffs = dialog.dialogPosition.xOffset
yoffs = dialog.dialogPosition.yOffset
WindowClearAnchors( windowName )
WindowAddAnchor( windowName, point, relativeTo, relativePoint, xoffs, yoffs )
</pre>

== See also ==
* [[API:WindowAddAnchor|WindowAddAnchor]]
* [[API:WindowGetAnchorCount|WindowGetAnchorCount]]
* [[API:WindowSetOffsetFromParent|WindowSetOffsetFromParent]]

API:WindowClearAnchors - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)