API / IEventDispatcher

Interface: IEventDispatcher

Defined in: event/IEventDispatcher.ts:43

The event dispatcher interface. Dragonbones event dispatch usually relies on docking engine to implement, which defines the event method to be implemented when docking the engine.

Extended by

• IArmatureProxy

Methods

addDBEventListener()

addDBEventListener(
   type: EventStringType, 
   listener: Function, 
   thisObject: any): void;

Defined in: event/IEventDispatcher.ts:84

Add an event listener object so that the listener receives notification of an event.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
listener	Function	Event listener.
thisObject	any	The listener function's "this".

Returns

void

---

dispatchDBEvent()

dispatchDBEvent(type: EventStringType, eventObject: EventObject): void;

Defined in: event/IEventDispatcher.ts:67

Dispatches an event into the event flow.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
eventObject	EventObject	Event object.

Returns

void

---

hasDBEventListener()

hasDBEventListener(type: EventStringType): boolean;

Defined in: event/IEventDispatcher.ts:52

Checks whether the object has any listeners registered for a specific type of event。

Parameters

Parameter	Type	Description
type	EventStringType	Event type.

Returns

boolean

---

removeDBEventListener()

removeDBEventListener(
   type: EventStringType, 
   listener: Function, 
   thisObject: any): void;

Defined in: event/IEventDispatcher.ts:101

Removes a listener from the object.

Parameters

Parameter	Type	Description
type	EventStringType	Event type.
listener	Function	Event listener.
thisObject	any	The listener function's "this".

Returns

void