Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:18Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Adds an anchor that attaches a point of a window to a point of another window.

<pre>
WindowAddAnchor(windowName, point, relativeTo, relativePoint, xOffset, yOffset)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window to anchor.
;point : <code>string</code> – Point on the <code>relativeTo</code> window.
;relativeTo : <code>string</code> – Name of the window to anchor to. <code>"Root"</code> is the whole screen.
;relativePoint : <code>string</code> – Point on the anchored window (<code>windowName</code>) that is placed on <code>point</code>.
;xOffset, yOffset : <code>number</code> – Offset from <code>point</code>. A positive <code>yOffset</code> moves the window down.

== Returns ==
Nothing.

== Details ==
* Valid point names are <code>"topleft"</code>, <code>"top"</code>, <code>"topright"</code>, <code>"left"</code>, <code>"center"</code>, <code>"right"</code>, <code>"bottomleft"</code>, <code>"bottom"</code> and <code>"bottomright"</code>. Case does not matter.
* An unknown point name is not rejected. The anchor is stored with the point <code>"none"</code>, which is what [[API:WindowGetAnchor|WindowGetAnchor]] then reports.
* The second argument names the point on the '''other''' window and the fourth names the point on the window being anchored. For example, <code>WindowAddAnchor(new, "bottom", previous, "top", 0, 0)</code> puts the top of <code>new</code> on the bottom of <code>previous</code>, so <code>new</code> sits below it.
* The anchor is added to the window's existing anchors. Nothing is replaced, so call [[API:WindowClearAnchors|WindowClearAnchors]] first if the window should only follow the new anchor.
* <code>relativeTo</code> must name an existing window when the call is made. The client stores the name, not the window.
* The window and its child windows are laid out again straight away.
* How anchors are applied:
** With one anchor, the anchor sets the window's position.
** With two anchors, the anchors set the position and, if both relative points are corners, the size too. Two opposite corners (for example <code>"topleft"</code> and <code>"bottomright"</code>) set width and height. Two corners on the same edge set only the width or only the height.
** With three or more anchors, the client does not position the window from its anchors at all.
** If an anchor's relative window cannot be found when the anchors are processed, the window is not repositioned.
* All four names must be strings and both offsets must be numbers.

== Errors ==
* <code>Error in function call 'WindowAddAnchor': Window %s does not exist</code>
* <code>Error in function call 'WindowAddAnchor': Relative window %s does not exist</code>
* <code>Error in function call 'WindowAddAnchor': 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 ==
Stacking colour boxes in a column, from <code>ea_guildwindow/source/colorpicker.lua</code>:
<pre>
WindowAddAnchor( newWindowName, "bottom", previousWindowName, "top", 0, 0 )
</pre>

Making a window fill its parent with two corner anchors, from <code>easystem_glyphdisplay/source/glyphdisplay.lua</code>:
<pre>
WindowClearAnchors (self.windowName);
WindowAddAnchor (self.windowName, "topleft", self.parentName, "topleft", 0, 0);
WindowAddAnchor (self.windowName, "bottomright", self.parentName, "bottomright", 0, 0);
</pre>

== See also ==
* [[API:WindowClearAnchors|WindowClearAnchors]]
* [[API:WindowGetAnchor|WindowGetAnchor]]
* [[API:WindowGetAnchorCount|WindowGetAnchorCount]]
* [[API:WindowForceProcessAnchors|WindowForceProcessAnchors]]

API:WindowAddAnchor - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)