Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:51:25Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Window}}
Returns a window's own alpha (opacity).

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

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

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

== Details ==
* This is the value set with [[API:WindowSetAlpha|WindowSetAlpha]] (or by an alpha animation). It does not include the alpha of the parent windows, which the client multiplies in when drawing.
* While an alpha animation runs (see [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]]), the value changes every frame.

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

== Example ==
Saving a window's settings before editing it, from <code>easystem_layouteditor/source/layoutframe.lua</code>:
<pre>
-- Alpha
frame.m_originalAlpha = WindowGetAlpha( frame.m_sourceWindowName )

-- Scale
frame.m_originalScale = WindowGetScale( frame.m_sourceWindowName )
</pre>

== See also ==
* [[API:WindowSetAlpha|WindowSetAlpha]]
* [[API:WindowGetFontAlpha|WindowGetFontAlpha]]
* [[API:WindowStartAlphaAnimation|WindowStartAlphaAnimation]]

API:WindowGetAlpha - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)