Skip to main content

Interface: PluginEvent

Base interface for all Plugin events.

Extends​

Properties​

handled?​

optional handled: boolean

Has the event been taken care of by the listener and not be dispatched to other targets?

Inherited from​

M2Event.handled

Defined in​

M2Event.ts:26

iso8601Timestamp​

iso8601Timestamp: string

Timestamp of th event, from new Date().toISOString()

Inherited from​

M2Event.iso8601Timestamp

Defined in​

M2Event.ts:30

sequence?​

optional sequence: number

Sequence number of event.

Remarks​

Sequence number is guaranteed to reflect order of events, but not necessarily contiguous, e.g., could be 1, 2, 5, 10, 11, 24.

Inherited from​

M2Event.sequence

Defined in​

M2Event.ts:35

target​

target: Plugin

The object on which the event occurred. If the event has gone through serialization, the string will be the object's UUID (if an M2Node) or class name.

Overrides​

M2Event.target

Defined in​

PluginEvent.ts:6

timestamp​

timestamp: number

Timestamp of the event, from performance.now()

Inherited from​

M2Event.timestamp

Defined in​

M2Event.ts:28

type​

type: string

Type of event.

Inherited from​

M2Event.type

Defined in​

M2Event.ts:22