Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:41Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Scrollbar}}
Moves a HorizontalScrollbar to a scroll position.

<pre>
HorizontalScrollbarSetScrollPosition(scrollbarName, position)
</pre>

== Arguments ==
;scrollbarName : <code>string</code> – Name of the HorizontalScrollbar.
;position : <code>number</code> – New scroll position.

== Returns ==
Nothing.

== Details ==
* The position is clamped to the range from 0 to the maximum scroll position minus the page size (see [[API:HorizontalScrollbarGetMaxScrollPosition|HorizontalScrollbarGetMaxScrollPosition]] and [[API:HorizontalScrollbarGetPageSize|HorizontalScrollbarGetPageSize]]).
* If the clamped position differs from the current one, the thumb is moved and the scrollbar's <code>OnScrollPosChanged</code> handler runs with the new position.
* If the position does not change, nothing happens and the handler does not run.
* The stock UI never calls this function.
* 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 'HorizontalScrollbarSetScrollPosition': Window %s does not exist</code>
* <code>Error in function call 'HorizontalScrollbarSetScrollPosition': Window %s is not a HorizontalScrollbar</code>

== Example ==
A minimal example built from the signature:
<pre>
HorizontalScrollbarSetScrollPosition( "MyScrollbar", 0 )
</pre>

== See also ==
* [[API:HorizontalScrollbarGetScrollPosition|HorizontalScrollbarGetScrollPosition]]
* [[API:HorizontalScrollbarSetMaxScrollPosition|HorizontalScrollbarSetMaxScrollPosition]]
* [[API:VerticalScrollbarSetScrollPosition|VerticalScrollbarSetScrollPosition]]

API:HorizontalScrollbarSetScrollPosition - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)