API:HorizontalScrollbarGetScrollPosition

UI Lua API · Scrollbar functions
Version: WAR 1.4.8

Returns the scroll position of a HorizontalScrollbar.

position = HorizontalScrollbarGetScrollPosition(scrollbarName)

Arguments

scrollbarName

string – Name of the HorizontalScrollbar.

Returns

position

number – The current scroll position, between 0 and the maximum scroll position minus the page size.

Details

• The stock UI never calls this function.

Errors

• Error in function call 'HorizontalScrollbarGetScrollPosition': Window %s does not exist
• Error in function call 'HorizontalScrollbarGetScrollPosition': Window %s is not a HorizontalScrollbar

Example

A minimal example built from the signature:

local pos = HorizontalScrollbarGetScrollPosition( "MyScrollbar" )

See also

• HorizontalScrollbarSetScrollPosition
• HorizontalScrollbarGetMaxScrollPosition