API:LogDisplayIsScrolledToTop

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Returns whether a LogDisplay window is scrolled all the way up.

atTop = LogDisplayIsScrolledToTop(displayName)

Arguments

displayName

string – Name of a LogDisplay window.

Returns

atTop

boolean – true if the scroll position is 0.

Details

• A display without a scroll bar always returns false.
• The stock UI never calls this function.

Errors

• Error in function call 'TextLogDisplayIsScrolledToTop': Window %s does not exist
• Error in function call 'TextLogDisplayIsScrolledToTop': Window %s is not a TextLogDisplay

Example

A minimal example built from the documented signature:

WindowSetShowing( "MyScrollUpButton", not LogDisplayIsScrolledToTop( "MyLogDisplay" ) )

See also

• LogDisplayIsScrolledToBottom
• LogDisplayScrollToTop