Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:26Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=ScrollWindow}}
Scrolls a ScrollWindow to a vertical offset.

<pre>
ScrollWindowSetOffset(scrollWindowName, offset)
</pre>

== Arguments ==
;scrollWindowName : <code>string</code> – Name of the ScrollWindow.
;offset : <code>number</code> – Distance in pixels from the top of the content to the top of the visible area.

== Returns ==
Nothing.

== Details ==
* The offset is clamped to the range from 0 to the content height minus the window height. If the content is not taller than the window, the offset is always 0.
* The content height is the one the ScrollWindow last measured; [[API:ScrollWindowUpdateScrollRect|ScrollWindowUpdateScrollRect]] measures it again. Call that first if the content has changed.
* If the clamped offset is the same as the current one, nothing happens.
* Otherwise the scroll child is moved and the ScrollWindow's scroll bar, if it has one, is moved to the same position.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

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

== Example ==
From <code>default/ea_chatwindow/source/chathyperlinking.lua</code>:
<pre>
-- Update the scroll window
ScrollWindowSetOffset( windowName.."Info", 0 )
ScrollWindowUpdateScrollRect( windowName.."Info" )
</pre>

== See also ==
* [[API:ScrollWindowGetOffset|ScrollWindowGetOffset]]
* [[API:ScrollWindowUpdateScrollRect|ScrollWindowUpdateScrollRect]]
* [[API:HorizontalScrollWindowSetOffset|HorizontalScrollWindowSetOffset]]

API:ScrollWindowSetOffset - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)