API:HorizontalScrollWindowGetOffset

UI Lua API · ScrollWindow functions
Version: WAR 1.4.8

Returns the horizontal scroll offset of a HorizontalScrollWindow.

offset = HorizontalScrollWindowGetOffset(scrollWindowName)

Arguments

scrollWindowName

string – Name of the HorizontalScrollWindow.

Returns

offset

number – Distance in pixels from the left edge of the content to the left edge of the visible area.

Details

• The stock UI never calls this function.

Errors

The error messages always use the name HorizontalScrollWindowSetOffset:

• Error in function call 'HorizontalScrollWindowSetOffset': Window %s does not exist
• Error in function call 'HorizontalScrollWindowSetOffset': Window %s is not a HorizontalScrollWindow

Example

A minimal example built from the signature:

local offset = HorizontalScrollWindowGetOffset( "MyHScrollWindow" )

See also

• HorizontalScrollWindowSetOffset
• ScrollWindowGetOffset