https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALogDisplayIsScrolledToBottom 2026-10-17T20:17:10Z Revision history for this page on the wiki MediaWiki 1.43.11 https://wiki.returnofreckoning.com/index.php?title=API:LogDisplayIsScrolledToBottom&diff=30580&oldid=prev 2026-10-16T19:46:51Z

<p>UI Lua API import (WAR 1.4.8)</p> <p><b>New page</b></p><div>{{LuaApi|group=LogDisplay}}<br /> Returns whether a LogDisplay window is scrolled all the way down.<br /> <br /> &lt;pre&gt;<br /> atBottom = LogDisplayIsScrolledToBottom(displayName)<br /> &lt;/pre&gt;<br /> <br /> == Arguments ==<br /> ;displayName : &lt;code&gt;string&lt;/code&gt; – Name of a LogDisplay window.<br /> <br /> == Returns ==<br /> ;atBottom : &lt;code&gt;boolean&lt;/code&gt; – &lt;code&gt;true&lt;/code&gt; if the scroll position is at the end of the content.<br /> <br /> == Details ==<br /> * A display without a scroll bar always returns &lt;code&gt;false&lt;/code&gt;.<br /> <br /> == Errors ==<br /> * &lt;code&gt;Error in function call &#039;TextLogDisplayIsScrolledToBottom&#039;: Window %s does not exist&lt;/code&gt;<br /> * &lt;code&gt;Error in function call &#039;TextLogDisplayIsScrolledToBottom&#039;: Window %s is not a TextLogDisplay&lt;/code&gt;<br /> <br /> == Example ==<br /> Blinking a &quot;new text&quot; alert while the player has scrolled up, from &lt;code&gt;ea_chatwindow/source/chatwindow.lua&lt;/code&gt;:<br /> &lt;pre&gt;<br /> local scrolledDown = LogDisplayIsScrolledToBottom( activeTabName..&quot;TextLog&quot; )<br /> local alertWindowName = activeTabName..&quot;TextLogToBottomButtonAlert&quot;<br /> if( scrolledDown == false ) then<br /> WindowSetShowing( alertWindowName, true )<br /> ...<br /> end<br /> &lt;/pre&gt;<br /> <br /> == See also ==<br /> * [[API:LogDisplayIsScrolledToTop|LogDisplayIsScrolledToTop]]<br /> * [[API:LogDisplayScrollToBottom|LogDisplayScrollToBottom]]<br /> * [[API:LogDisplayIsScrollbarActive|LogDisplayIsScrollbarActive]]</div>

Maintenance script