https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ALabelGetTextAPI:LabelGetText - Revision history2026-10-17T18:28:03ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:LabelGetText&diff=30549&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:46:22Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Label|wrapper=interfacecore/source/windowstate.lua}}<br />
Returns the text shown by a Label.<br />
<br />
<pre><br />
text = LabelGetText(labelName)<br />
</pre><br />
<br />
== Arguments ==<br />
;labelName : <code>string</code> – Name of a Label window.<br />
<br />
== Returns ==<br />
;text : <code>wstring</code> – The label's text.<br />
<br />
== Details ==<br />
* The client registers the C function as <code>_LabelGetText</code>. The <code>LabelGetText</code> that addons call is a Lua function defined in <code>interfacecore/source/windowstate.lua</code>:<br />
** If the global table named after the window (<code>_G[labelName]</code>) has a <code>STATE</code> table, it returns <code>STATE.LABEL_TEXT</code> without calling into the client.<br />
** Otherwise it calls <code>_LabelGetText(labelName)</code>.<br />
* For windows with state tracking enabled, the client writes the new text to <code>''labelName''.STATE.LABEL_TEXT</code> each time the text changes, for example through [[API:LabelSetText|LabelSetText]].<br />
* <code>_LabelGetText</code> returns the text as it is displayed, not necessarily the exact string that was passed to [[API:LabelSetText|LabelSetText]]: the client processes the displayed copy and shortens it if it is longer than the label's maximum length.<br />
* If an addon creates a global table with the same name as a label and gives it a <code>STATE</code> field, <code>LabelGetText</code> returns whatever that field's <code>LABEL_TEXT</code> holds. Avoid using <code>STATE</code> as a field name on window tables.<br />
<br />
== Errors ==<br />
Raised by <code>_LabelGetText</code>:<br />
* <code>Error in function call 'LabelGetText': Window %s does not exist</code><br />
* <code>Error in function call 'LabelGetText': Window %s is not a Label</code><br />
<br />
== Example ==<br />
Checking whether a tooltip line has text, from <code>easystem_tooltips/source/itemtooltips.lua</code>:<br />
<pre><br />
local hasExtraText = LabelGetText( tooltipWindow.."ActionText" ) ~= L""<br />
</pre><br />
<br />
== See also ==<br />
* [[API:LabelSetText|LabelSetText]]<br />
* [[API:LabelGetTextDimensions|LabelGetTextDimensions]]<br />
* [[API:ButtonGetText|ButtonGetText]]</div>Maintenance script