Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:25Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Label}}
Changes the font of a Label.

<pre>
LabelSetFont(labelName, fontName, lineSpacing)
</pre>

== Arguments ==
;labelName : <code>string</code> – Name of a Label window.
;fontName : <code>string</code> – Name of the font, for example <code>"font_default_text_large"</code>. These are the names used with the <code>font</code> attribute in XML.
;lineSpacing : <code>number</code> – Required, but not used by the client. The stock UI passes <code>WindowUtils.FONT_DEFAULT_TEXT_LINESPACING</code> (20).

== Returns ==
Nothing.

== Details ==
* All three arguments must be given. <code>lineSpacing</code> is checked to be a number and then ignored.
* If the font is the one the label already uses, nothing happens. Otherwise the label's text is laid out again with the new font.
* If no font has the given name, the label is left unchanged and the client reports <code>ERROR: Invalid font definition for Label %s (%s)</code> (label name, font name).

== Errors ==
* <code>Error in function call 'LabelSetFont': Window %s does not exist</code>
* <code>Error in function call 'LabelSetFont': Window %s is not a Label</code>
* <code>ERROR: Invalid font definition for Label %s (%s)</code>

== Example ==
From <code>easystem_eventtext/source/system_eventtext.lua</code>:
<pre>
LabelSetFont( self:GetName(), "font_default_text_huge", WindowUtils.FONT_DEFAULT_TEXT_LINESPACING )
</pre>

== See also ==
* [[API:LabelGetFont|LabelGetFont]]
* [[API:LabelSetText|LabelSetText]]

API:LabelSetFont - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)