Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:40Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Scrollbar}}
Sets the maximum scroll position (the total length of the scrolled content) of a HorizontalScrollbar.

<pre>
HorizontalScrollbarSetMaxScrollPosition(scrollbarName, maxPosition)
</pre>

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

== Returns ==
Nothing.

== Details ==
* If <code>maxPosition</code> is smaller than the page size, the page size is used instead.
* The page size and the line size are not changed.
* The thumb is resized for the new range and the current position is clamped again. If that moves the position, the <code>OnScrollPosChanged</code> handler runs.
* 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 ==
The error messages use the name of [[API:HorizontalScrollbarSetScrollPosition|HorizontalScrollbarSetScrollPosition]]:
* <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>
HorizontalScrollbarSetMaxScrollPosition( "MyScrollbar", 500 )
</pre>

== See also ==
* [[API:HorizontalScrollbarGetMaxScrollPosition|HorizontalScrollbarGetMaxScrollPosition]]
* [[API:HorizontalScrollbarSetPageSize|HorizontalScrollbarSetPageSize]]

API:HorizontalScrollbarSetMaxScrollPosition - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)