Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:25Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ScrollWindow}}
Returns the vertical scroll offset of a ScrollWindow.

<pre>
offset = ScrollWindowGetOffset(scrollWindowName)
</pre>

== Arguments ==
;scrollWindowName : <code>string</code> – Name of the ScrollWindow.

== Returns ==
;offset : <code>number</code> – Distance in pixels from the top of the content to the top of the visible area.

== Details ==
* The stock UI never calls this function.

== Errors ==
* <code>Error in function call 'ScrollWindowGetOffset': Window %s does not exist</code>
* <code>Error in function call 'ScrollWindowGetOffset': Window %s is not a ScrollWindow</code>

== Example ==
Keeping the scroll position while the content is rebuilt, built from the documented signatures:
<pre>
local offset = ScrollWindowGetOffset( "MyScrollWindow" )
-- ... rebuild the content ...
ScrollWindowUpdateScrollRect( "MyScrollWindow" )
ScrollWindowSetOffset( "MyScrollWindow", offset )
</pre>

== See also ==
* [[API:ScrollWindowSetOffset|ScrollWindowSetOffset]]
* [[API:HorizontalScrollWindowGetOffset|HorizontalScrollWindowGetOffset]]

API:ScrollWindowGetOffset - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)