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}}
Meant to set the page size of a HorizontalScrollbar. In the current client it sets the '''line size''' instead. See [[#Details|Details]].

<pre>
HorizontalScrollbarSetPageSize(scrollbarName, size)
</pre>

== Arguments ==
;scrollbarName : <code>string</code> – Name of the HorizontalScrollbar.
;size : <code>number</code> – The value to store.

== Returns ==
Nothing.

== Details ==
* The client passes the arguments to the scrollbar in the wrong order: <code>size</code> becomes the line size (returned by [[API:HorizontalScrollbarGetLineSize|HorizontalScrollbarGetLineSize]]). The page size and the maximum scroll position are not changed.
* To set the page size, use [[API:HorizontalScrollbarSetLineSize|HorizontalScrollbarSetLineSize]], which has the opposite mix-up. To set both values, call:
<pre>
HorizontalScrollbarSetLineSize( name, pageSize ) -- sets the page size (line size becomes the old page size)
HorizontalScrollbarSetPageSize( name, lineSize ) -- sets the line size
</pre>
* The thumb is recalculated 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 ==
* <code>Error in function call 'HorizontalScrollbarSetPageSize': Window %s does not exist</code>
* <code>Error in function call 'HorizontalScrollbarSetPageSize': Window %s is not a HorizontalScrollbar</code>

== Example ==
See the call order in [[#Details|Details]].

== See also ==
* [[API:HorizontalScrollbarGetPageSize|HorizontalScrollbarGetPageSize]]
* [[API:HorizontalScrollbarSetLineSize|HorizontalScrollbarSetLineSize]]
* [[API:HorizontalScrollbarGetLineSize|HorizontalScrollbarGetLineSize]]

API:HorizontalScrollbarSetPageSize - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)