Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:37Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Scrollbar}}
Returns the page size of a HorizontalScrollbar.

<pre>
pageSize = HorizontalScrollbarGetPageSize(scrollbarName)
</pre>

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

== Returns ==
;pageSize : <code>number</code> – The page size: the part of the content that is visible at once.

== Details ==
* The page size sets the length of the thumb relative to the maximum scroll position, and the highest reachable position is the maximum scroll position minus the page size.
* [[API:HorizontalScrollbarSetPageSize|HorizontalScrollbarSetPageSize]] does not change this value; use [[API:HorizontalScrollbarSetLineSize|HorizontalScrollbarSetLineSize]] (see that page).
* The stock UI never calls this function.

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

== Example ==
A minimal example built from the signature:
<pre>
local pageSize = HorizontalScrollbarGetPageSize( "MyScrollbar" )
</pre>

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

API:HorizontalScrollbarGetPageSize - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)