Hierarchy

  • IBindHandlerApi

Properties

bindable: default | "anything"

The bindable this handler is called for.

cancelled: boolean

Whether this event is cancelled. If true, no other bind handlers will be processed.

catalyst: InputInfo

Details on the catalyst of this event.

caught: Set<default>

A set containing all Bindables that:

  1. Matched the currently pressed keys.
  2. Were handled with a @Binding event handler that returned true. Note: Only contains Bindables of which the handlers have already been processed.
event: "up" | "down" | "holding"

The type of input event.

  • "down" — When the bindable is pressed.
  • "up" — When the bindable is released.
  • "holding" — Every frame while the bindable is held.

Details on the status of all input.

Details on where the mouse is.

preventDefault?: true

You should never need this unless you expect the user to be trying to use a scroll binding for your bind handler.

Generated using TypeDoc