API:WindowSetHandleInput

UI Lua API · Window functions
Version: WAR 1.4.8

Sets whether a window receives mouse input.

WindowSetHandleInput(windowName, handleInput)

Arguments

windowName

string – Name of the window.

handleInput

boolean – true to let the window receive mouse input, false to let the mouse pass through it.

Returns

Nothing.

Details

• When the client looks for the window under the mouse, it skips windows with this flag cleared. It does not look inside them either, so their child windows are skipped too, whatever their own flag says.
• handleInput must be a real boolean. Passing nil or a number raises an Invalid Parameters error.
• The function needs at least two arguments and only reads the last two.

Errors

• Error in function call 'WindowSetHandleInput': Window %s does not exist
• Error in function call 'WindowSetHandleInput': Window %s is currently locked and may not be modified from lua. ...
  This check never triggers in the current client. See WindowSetShowing.

Example

From easystem_glyphdisplay/source/glyphdisplay.lua:

WindowSetHandleInput("EA_Window_GlyphTracker", false)

See also

• WindowGetHandleInput
• WindowSetShowing