1681-engine / ui / shouldShield

Function: shouldShield()

function shouldShield(
   type, 
   facts, 
   options?
): boolean;

Defined in: src/ui/dom/shieldDecision.ts:52

Whether an event on the DOM UI must be kept from the engine's input. Releases (keyup, pointerup, pointercancel) always go through, or a key or button held when the UI took over would stay down for good; moves go through so aiming follows the pointer over a panel. Presses, wheel and context menus on the UI stay in the UI, and so does every key typed into a field.

Parameters

Parameter	Type
type	string
facts	ShieldFacts
options	ShieldOptions

Returns

boolean