API:VerticalScrollbarGetLineSize

UI Lua API · Scrollbar functions
Version: WAR 1.4.8

Returns the line size of a VerticalScrollbar.

lineSize = VerticalScrollbarGetLineSize(scrollbarName)

Arguments

scrollbarName

string – Name of the VerticalScrollbar.

Returns

lineSize

number – The stored line size.

Details

• VerticalScrollbarSetLineSize does not set this value; VerticalScrollbarSetPageSize does (see those pages).
• The stock UI never calls this function.

Errors

• Error in function call 'VerticalScrollbarGetLineSize': Window %s does not exist
• Error in function call 'VerticalScrollbarGetLineSize': Window %s is not a VerticalScrollbar

Example

A minimal example built from the signature:

local lineSize = VerticalScrollbarGetLineSize( "MyScrollbar" )

See also

• VerticalScrollbarSetLineSize
• VerticalScrollbarSetPageSize