API:LogDisplayScrollToTop

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Scrolls a LogDisplay window to its oldest line.

LogDisplayScrollToTop(displayName)

Arguments

displayName

string – Name of a LogDisplay window.

Returns

Nothing.

Errors

• Error in function call 'LogDisplayScrollToTop': Window %s does not exist
• Error in function call 'LogDiplayScrollToTop': Window %s is not a TextLogDisplay
  Note the misspelling LogDiplay in this message.

Example

Showing a long text from its start, from interfacecore/source/eularocwindow.lua:

for index = 0, #StringTables.EULAROC
do
    TextLogAddEntry( "EULAROCLog", 1, GetStringFromTable( "EULAROC", index ) )
end

LogDisplayScrollToTop( "EA_Window_EULAROCPopupLogDisplay" )

See also

• LogDisplayScrollToBottom
• LogDisplayIsScrolledToTop