Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:39Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Returns the screen position of a window's top-left corner.

<pre>
x, y = WindowGetScreenPosition(windowName)
</pre>

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

== Returns ==
;x, y : <code>number</code> – Position of the top-left corner in screen pixels, measured from the top-left of the screen.

== Details ==
* The values are in screen pixels. Unlike [[API:WindowGetOffsetFromParent|WindowGetOffsetFromParent]], they are not divided by the window's scale.
* To get the size on screen to go with the position, multiply [[API:WindowGetDimensions|WindowGetDimensions]] by the window's scale.
* Positions set by anchors are only up to date after the anchors have been processed. [[API:WindowForceProcessAnchors|WindowForceProcessAnchors]] processes them immediately.

== Errors ==
* <code>Error in function call 'WindowGetScreenPosition': Window %s does not exist</code>

== Example ==
Keeping a frame on screen, from <code>easystem_layouteditor/source/layoutcontrolframe.lua</code>:
<pre>
local screenWidth, screenHeight = GetScreenResolution()
local screenX, screenY = WindowGetScreenPosition( self:GetName() )
local width, height = WindowGetDimensions( self:GetName() )

width = width*uiScale
height = height*uiScale
</pre>

== See also ==
* [[API:WindowGetOffsetFromParent|WindowGetOffsetFromParent]]
* [[API:WindowGetDimensions|WindowGetDimensions]]
* [[API:WindowGetScale|WindowGetScale]]

API:WindowGetScreenPosition - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)