Class CancelableModEvent

Cancelable mod event class

If one of the event handlers returned true, the subsequent handlers will not be called.

* See MaginaiEvents class for all events provided by maginai

Hierarchy (view full)

ModEvent
- CancelableModEvent

Index

Constructors

Properties

description handlers hasHandler name

Methods

addHandler invoke removeHandler

Constructors

constructor

new CancelableModEvent(name, description?): CancelableModEvent
Internal
Parameters
- name: string
  Event name
- description: string = 'KeyEvent'
  Description
Returns CancelableModEvent
Overrides ModEvent.constructor
- Defined in js/mod/modules/event/cancelable-mod-event.js:19

Properties

`Internal` description

description: string

`Internal` handlers

handlers: any[]

`Internal` hasHandler

hasHandler: boolean

`Internal` name

name: string

Methods

addHandler

addHandler(handler): void
Add an event handler
Parameters
- handler: Function
Returns void
Inherited from ModEvent.addHandler
- Defined in js/mod/modules/event/mod-event.js:67

invoke

invoke(e): boolean
Internal
Parameters
- e: any
  Event arg object
Returns boolean
handled - Whether the event has been handled by a handler
Overrides ModEvent.invoke
- Defined in js/mod/modules/event/cancelable-mod-event.js:28

removeHandler

removeHandler(handler): void
Remove handler from the event
Parameters
- handler: Function
Returns void
Inherited from ModEvent.removeHandler
- Defined in js/mod/modules/event/mod-event.js:83