API:LogDisplayIsScrollbarActive

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Returns whether a LogDisplay window has more text than fits, so that its scroll bar can scroll.

active = LogDisplayIsScrollbarActive(displayName)

Arguments

displayName

string – Name of a LogDisplay window.

Returns

active

boolean – true if the display has a scroll bar and its content is larger than the visible area.

Details

• A display without a scroll bar always returns false.
• The error messages name TextLogGetTextFadeTime, not this function.
• The stock UI never calls this function.

Errors

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

Example

A minimal example built from the documented signature:

WindowSetShowing( "MyScrollButtons", LogDisplayIsScrollbarActive( "MyLogDisplay" ) )

See also

• LogDisplayIsScrolledToBottom
• LogDisplayIsScrolledToTop