Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:WindowGetFontAlpha

From RoR Wiki

UI Lua API · Window functions
Version: WAR 1.4.8

Returns the alpha (opacity) a window uses for its text.

alpha = WindowGetFontAlpha(windowName)

Arguments

windowName
string – Name of the window.

Returns

alpha
number – The font alpha, from 0 (invisible) to 1 (opaque).

Details

  • This is the value set with 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 WindowStartAlphaAnimation).
  • The stock UI never calls WindowGetFontAlpha.

Errors

  • Error in function call 'WindowGetFontAlpha': Window %s does not exist

Example

A minimal example built from the signature above:

local textAlpha = WindowGetFontAlpha( "MyWindowLabel" )

See also