Class UnsubscribeEvent<T>

Unsubscribe event thrown when handlers for events other than unsubscribe are removed. Meta event that is received by event dispatchers.

Type parameters

T

Hierarchy

Events.GameEvent<T>
- UnsubscribeEvent

Index

Constructors

constructor

Properties

Accessors

bubbles

Methods

stopPropagation

Constructors

constructor

new UnsubscribeEvent<T>(topic: string, handler: (event: Events.GameEvent<T, T>) => void): Events.UnsubscribeEvent<T>

Overrides GameEvent.constructor
- Defined in Events.ts:382
Type parameters
- T
Parameters
- topic: string
- handler: (event: Events.GameEvent<T, T>) => void
  - - (event: Events.GameEvent<T, T>): void
    - Parameters
      - event: Events.GameEvent<T, T>
      Returns void
Returns Events.UnsubscribeEvent<T>

Properties

handler

handler: (event: Events.GameEvent<T, T>) => void

Type declaration

- (event: Events.GameEvent<T, T>): void
- Parameters
  - event: Events.GameEvent<T, T>
  Returns void

other

other: T

Other target object for this event

target

target: T

Target object for this event.

topic

topic: string

Accessors

bubbles

get bubbles(): boolean
set bubbles(value: boolean): void

Inherited from GameEvent.bubbles
- Defined in Events.ts:181
If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

Returns boolean
Inherited from GameEvent.bubbles
- Defined in Events.ts:185
If set to false, prevents event from propagating to other actors. If true it will be propagated to all actors that apply.

Parameters
- value: boolean
Returns void

Methods

stopPropagation

stopPropagation(): void

Inherited from GameEvent.stopPropagation
- Defined in Events.ts:193
Prevents event from bubbling

Returns void