API:TextEditBoxGetFont

UI Lua API · TextEditBox functions
Version: WAR 1.4.8

Returns the font name of a TextEditBox.

fontName = TextEditBoxGetFont(editBoxName)

Arguments

editBoxName

string – Name of a TextEditBox window.

Returns

fontName

string – Name of the font the box uses, or "" if it has none.

Details

• The name comes from the font itself, not from the last string passed to TextEditBoxSetFont. After setting an unknown font name the result is "".
• The stock UI never calls this function.

Errors

• Error in function call 'TextEditBoxGetFont': Window %s does not exist
• Error in function call 'TextEditBoxGetFont': Window %s is not a TextEditBox

Example

A minimal example built from the documented signature:

local fontName = TextEditBoxGetFont( "MyEditBox" )

See also

• TextEditBoxSetFont