Skip to main content

Class: ForgeEvent

Defined in: events/forge-event.ts:6

An event that can be raised and listened to.

Constructors​

Constructor​

new ForgeEvent(name): ForgeEvent

Defined in: events/forge-event.ts:28

Creates a new event.

Parameters​

name​

string

The name of the event.

Returns​

ForgeEvent

Properties​

name​

name: string

Defined in: events/forge-event.ts:10

The name of the event.

Accessors​

listeners​

Get Signature​

get listeners(): Listener[]

Defined in: events/forge-event.ts:20

Gets the list of listeners registered to this event.

Returns​

Listener[]

Methods​

clear()​

clear(): void

Defined in: events/forge-event.ts:52

Clears all listeners from the event.

Returns​

void

deregisterListener()​

deregisterListener(listener): void

Defined in: events/forge-event.ts:45

Deregisters a listener from the event.

Parameters​

listener​

Listener

The listener to deregister.

Returns​

void

raise()​

raise(): void

Defined in: events/forge-event.ts:59

Raises the event, calling all registered listeners.

Returns​

void

registerListener()​

registerListener(listener): void

Defined in: events/forge-event.ts:37

Registers a listener to the event.

Parameters​

listener​

Listener

The listener to register.

Returns​

void