API:TextEditBoxGetTextColor

UI Lua API · TextEditBox functions
Version: WAR 1.4.8

Returns the text colour of a TextEditBox.

r, g, b = TextEditBoxGetTextColor(editBoxName)

Arguments

editBoxName

string – Name of a TextEditBox window.

Returns

r, g, b

number – Colour components on a 0–255 scale. These may not be whole numbers.

Details

• The colour is stored as fractions and multiplied by 255 on the way out. Alpha is not returned.
• The stock UI never calls this function.

Errors

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

Example

A minimal example built from the documented signature:

local r, g, b = TextEditBoxGetTextColor( "MyEditBox" )

See also

• TextEditBoxSetTextColor