Class ModEvent

Event class

* 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 ModEvent(name, description?): ModEvent
Internal
Parameters
- name: string
  Event name
- description: string = 'Event'
  Description
Returns ModEvent
- Defined in js/mod/modules/event/mod-event.js:17

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
- Defined in js/mod/modules/event/mod-event.js:67

invoke

invoke(e): void
Internal
Parameters
- e: any
  Event arg object
Returns void
- Defined in js/mod/modules/event/mod-event.js:50

removeHandler

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