API:TextEditBoxGetAllowEditing

UI Lua API · TextEditBox functions
Version: WAR 1.4.8

Returns whether the player may edit the text of a TextEditBox.

allowEditing = TextEditBoxGetAllowEditing(editBoxName)

Arguments

editBoxName

string – Name of a TextEditBox window.

Returns

allowEditing

boolean – The box's allow-editing flag, as set by TextEditBoxSetAllowEditing.

Details

• If the window does not exist or is not a TextEditBox, the error is logged and nothing is returned.
• The function needs at least one argument and only reads the last one.
• The stock UI never calls TextEditBoxGetAllowEditing.

Errors

These are written to the UI log; the call returns normally.

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

Example

A minimal example built from the signature above:

if( TextEditBoxGetAllowEditing( "MyEditBox" ) ) then
    TextEditBoxSetText( "MyEditBox", L"" )
end

See also

• TextEditBoxSetAllowEditing