Frame:SetPropagateKeyboardInput

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

	Frame:GetPropagateKeyboardInput
	Frame:SetPropagateKeyboardInput

Sets whether keyboard input is consumed by this frame or propagates to further frames.

Frame:SetPropagateKeyboardInput(propagate)

Arguments

propagate

boolean - true to propagate keyboard input further, false to consume keyboard input immediately.

Details

• Keyboard events are dispatched to the OnKeyDown/OnKeyUp script handlers of frames based on their layering order, stopping upon encountering the first frame which consumes input rather than propagates it.
• Keyboard bindings are handled by the WorldFrame, so if any non-propagating keyboard-enabled frame is visible, no keyboard bindings can be triggered.
• You can call this function from OnKeyDown script handlers to consume only some keyboard events. If your frame propagates handling of the OnKeyDown event, it will not receive the OnKeyUp event.

Patch changes

Patch 10.1.5 (2023-07-11): Restricted. May no longer be called by insecure code while in combat.