Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:47Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LogDisplay}}
Returns the line of text of a LogDisplay at a given position.

<pre>
text = LogDisplayGetStringFromCursorPos(logDisplayName, x, y)
</pre>

== Arguments ==
;logDisplayName : <code>string</code> – Name of a LogDisplay window.
;x, y : <code>number</code> – The position to test. The stock UI passes the <code>cursorX, cursorY</code> values handed to its spam-report handler (see the example).

== Returns ==
;text : <code>wstring</code> – The text at that position, or <code>L""</code> if there is none.

== Details ==
* The client finds the character at the position in the display's text, then returns everything from the line break before it to the line break after it. The result can start with that leading line break.
* If nothing is found at the position, an empty string is returned.
* If the window does not exist or is not a LogDisplay, the error is logged and nothing is returned.
* The function needs at least three arguments and only reads the last three.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'LogDisplayGetStringFromCursorPos': Window %s does not exist</code>
* <code>Error in function call 'LogDisplayGetStringFromCursorPos': Window %s is not a TextLogDisplay</code>

== Example ==
Grabbing the chat line to report as spam, from <code>ea_playermenu/source/playermenuwindow.lua</code>:
<pre>
function PlayerMenuWindow.OnReportSpam(wndGroupId, cursorX, cursorY)
...
local offendingMessage = LogDisplayGetStringFromCursorPos(activeTabName.."TextLog", cursorX, cursorY)
HelpUtils.AutoReportGoldSeller(PlayerMenuWindow.curPlayer.name, offendingMessage)
</pre>

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

API:LogDisplayGetStringFromCursorPos - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)