API:WindowGetHandleInput

UI Lua API · Window functions
Version: WAR 1.4.8

Returns whether a window receives mouse input.

handleInput = WindowGetHandleInput(windowName)

Arguments

windowName

string – Name of the window.

Returns

handleInput

boolean – true if the window's handle-input flag is set.

Details

• This reads the flag set with WindowSetHandleInput. See that page for what the flag does.
• The error message names the function WindowGetHandlingInput, not WindowGetHandleInput.
• The stock UI never calls WindowGetHandleInput.

Errors

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

Example

A minimal example built from the signature above:

if WindowGetHandleInput( "MyOverlay" ) then
    WindowSetHandleInput( "MyOverlay", false )
end

See also

• WindowSetHandleInput