https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AWindowGetAnchorAPI:WindowGetAnchor - Revision history2026-10-18T04:53:37ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:WindowGetAnchor&diff=30867&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:51:26Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Window}}<br />
Returns one of a window's anchors.<br />
<br />
<pre><br />
point, relativePoint, relativeTo, xOffset, yOffset = WindowGetAnchor(windowName, anchorIndex)<br />
</pre><br />
<br />
== Arguments ==<br />
;windowName : <code>string</code> – Name of the window.<br />
;anchorIndex : <code>number</code> – Which anchor to read, starting at 1.<br />
<br />
== Returns ==<br />
;point : <code>string</code> – Point on the relative window, for example <code>"bottomleft"</code>.<br />
;relativePoint : <code>string</code> – Point on this window.<br />
;relativeTo : <code>string</code> – Name of the window the anchor is attached to.<br />
;xOffset, yOffset : <code>number</code> – The anchor's offsets.<br />
<br />
== Details ==<br />
* The order differs from [[API:WindowAddAnchor|WindowAddAnchor]], which takes <code>relativeTo</code> before <code>relativePoint</code>. Copy an anchor with <code>WindowAddAnchor(name, point, relativeTo, relativePoint, xOffset, yOffset)</code>.<br />
* Anchors are counted in the order they were added. [[API:WindowGetAnchorCount|WindowGetAnchorCount]] gives the number of anchors.<br />
* <code>anchorIndex</code> is truncated to a whole number.<br />
* A point name the client did not recognise when the anchor was added is returned as <code>"none"</code>.<br />
* If the anchor has no relative window name, the name of the window's parent is returned instead. For a window without a parent, an empty '''wide''' string (<code>L""</code>) is returned in that case.<br />
* The function needs at least two arguments and only reads the last two.<br />
<br />
== Errors ==<br />
* <code>Error in function call 'WindowGetAnchor'</code><br/>Raised both when the window does not exist and when <code>anchorIndex</code> is less than 1 or greater than the number of anchors. The message does not say which.<br />
<br />
== Example ==<br />
Copying all anchors from one window to another with an extra offset, from <code>easystem_layouteditor/source/layouteditorutils.lua</code>:<br />
<pre><br />
WindowClearAnchors( destinationWindow )<br />
<br />
local numAnchors = WindowGetAnchorCount( sourceWindow )<br />
for index = 1, numAnchors<br />
do<br />
local point, relativePoint, relativeTo, xoffs, yoffs = WindowGetAnchor( sourceWindow, index )<br />
WindowAddAnchor( destinationWindow , point, relativeTo, relativePoint, xoffs+xOffset, yoffs+yOffset )<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:WindowGetAnchorCount|WindowGetAnchorCount]]<br />
* [[API:WindowAddAnchor|WindowAddAnchor]]<br />
* [[API:WindowClearAnchors|WindowClearAnchors]]</div>Maintenance script