Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:01Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LogDisplay}}
Shows or hides the scrollbar of a LogDisplay.

<pre>
TextLogDisplayShowScrollbar(logDisplayName, show)
</pre>

== Arguments ==
;logDisplayName : <code>string</code> – Name of a LogDisplay window.
;show : <code>boolean</code> – <code>true</code> to show the scrollbar, <code>false</code> to hide it.

== Returns ==
Nothing.

== Details ==
* The scrollbar's alpha is set to 1 (fully opaque) and its showing state to <code>show</code>.
* If the LogDisplay has no scrollbar, nothing happens.
* The error messages name <code>LuaShowScrollbar</code>, not this function.
* <code>show</code> must be a real boolean. Passing <code>nil</code> 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.
* <code>Error in function call 'LuaShowScrollbar': Window %s does not exist</code>
* <code>Error in function call 'LuaShowScrollbar': Window %s is not a TextLogDisplay</code>

== Example ==
From <code>ea_helpwindow/source/editappealwindow.lua</code>:
<pre>
LogDisplayAddLog("EditAppealWindowLogDisplay", "AppealLog", true)
LogDisplaySetShowTimestamp("EditAppealWindowLogDisplay", false)
LogDisplaySetShowLogName("EditAppealWindowLogDisplay", false)
TextLogDisplayShowScrollbar("EditAppealWindowLogDisplay", true)
</pre>

== See also ==
* [[API:LogDisplayIsScrollbarActive|LogDisplayIsScrollbarActive]]
* [[API:LogDisplayAddLog|LogDisplayAddLog]]

API:TextLogDisplayShowScrollbar - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)