Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:29Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Returns the alpha (opacity) a window uses for its text.

<pre>
alpha = WindowGetFontAlpha(windowName)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window.

== Returns ==
;alpha : <code>number</code> – The font alpha, from 0 (invisible) to 1 (opaque).

== Details ==
* This is the value set with [[API:WindowSetFontAlpha|WindowSetFontAlpha]]. Calling that function on a parent window also sets this value on all its children.
* Alpha animations change the font alpha together with the window alpha (see [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]]).
* The stock UI never calls <code>WindowGetFontAlpha</code>.

== Errors ==
* <code>Error in function call 'WindowGetFontAlpha': Window %s does not exist</code>

== Example ==
A minimal example built from the signature above:
<pre>
local textAlpha = WindowGetFontAlpha( "MyWindowLabel" )
</pre>

== See also ==
* [[API:WindowSetFontAlpha|WindowSetFontAlpha]]
* [[API:WindowGetAlpha|WindowGetAlpha]]

API:WindowGetFontAlpha - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)