Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:58Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Moves a window to a position relative to its parent's top-left corner.

<pre>
WindowSetOffsetFromParent(windowName, x, y)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.
;x, y : <code>number</code> – New offset of the window's top-left corner from its parent's top-left corner, before the window's scale is applied.

== Returns ==
Nothing.

== Details ==
* The client multiplies <code>x</code> and <code>y</code> by the window's scale ([[API:WindowGetScale|WindowGetScale]]) and stores the result in screen pixels. [[API:WindowGetOffsetFromParent|WindowGetOffsetFromParent]] uses the same units.
* If the position does not change, nothing happens. Otherwise the window and its children move.
* The client may change the offset to keep the window on screen. See [[API:WindowIsSticky|WindowIsSticky]].
* The window's anchors are not removed. When they are processed again (for example by [[API:WindowForceProcessAnchors|WindowForceProcessAnchors]]), they set the position again. Clear the anchors first with [[API:WindowClearAnchors|WindowClearAnchors]] if the window should stay where you put it.

== Errors ==
* <code>Error in function call 'WindowSetOffsetFromParent': Window %s does not exist</code>
* <code>Error in function call 'WindowSetOffsetFromParent': 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 floating combat text a little each frame, from <code>easystem_eventtext/source/system_eventtext.lua</code>:
<pre>
self.m_AnimationData.current.x = self.m_AnimationData.current.x + stepX
self.m_AnimationData.current.y = self.m_AnimationData.current.y + stepY

-- This system doesn't use the standard window animation system due to the speed-variable animations.
WindowSetOffsetFromParent(self:GetName(), self.m_AnimationData.current.x, self.m_AnimationData.current.y)
</pre>

== See also ==
* [[API:WindowGetOffsetFromParent|WindowGetOffsetFromParent]]
* [[API:WindowClearAnchors|WindowClearAnchors]]
* [[API:WindowStartPositionAnimation|WindowStartPositionAnimation]]

API:WindowSetOffsetFromParent - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)