API:TextLogDisplayShowScrollbar

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Shows or hides the scrollbar of a LogDisplay.

TextLogDisplayShowScrollbar(logDisplayName, show)

Arguments

logDisplayName

string – Name of a LogDisplay window.

show

boolean – true to show the scrollbar, false to hide it.

Returns

Nothing.

Details

• The scrollbar's alpha is set to 1 (fully opaque) and its showing state to show.
• If the LogDisplay has no scrollbar, nothing happens.
• The error messages name LuaShowScrollbar, not this function.
• show must be a real boolean. Passing nil or a number raises an Invalid Parameters error.
• The function needs at least two arguments and only reads the last two.

Errors

These are written to the UI log; the call returns normally.

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

Example

From ea_helpwindow/source/editappealwindow.lua:

LogDisplayAddLog("EditAppealWindowLogDisplay", "AppealLog", true)
LogDisplaySetShowTimestamp("EditAppealWindowLogDisplay", false)
LogDisplaySetShowLogName("EditAppealWindowLogDisplay", false)
TextLogDisplayShowScrollbar("EditAppealWindowLogDisplay", true)

See also

• LogDisplayIsScrollbarActive
• LogDisplayAddLog