Class Events

Hierarchy (view full)

EventEmitter<EventsEvents>
- Events

Index

Constructors

Properties

#eventsList #playerEventsList #syncManager _events gp

Accessors

activeList list

Methods

#getEventInfo getEvent has isJoined join off on once

Constructors

constructor

new Events(gp, syncManager, events): Events
Parameters
- gp: CoreSDK
- syncManager: SyncManager
- events: Event[]
Returns Events
Overrides EventEmitter.constructor
- Defined in core/events/Events.ts:47

Properties

`Private` #eventsList

#eventsList: Event[] = []

`Private` #playerEventsList

#playerEventsList: PlayerEvent[] = []

`Private` #syncManager

#syncManager: SyncManager

`Private` _events

_events: EventLite = ...

`Private` gp

Accessors

activeList

get activeList(): PlayerEvent[]
Returns PlayerEvent[]
- Defined in core/events/Events.ts:87

list

get list(): Event[]
Returns Event[]
- Defined in core/events/Events.ts:83

Methods

`Private` #getEventInfo

#getEventInfo(eventId): PlayerEventInfo
Parameters
- eventId: string | number
Returns PlayerEventInfo
- Defined in core/events/Events.ts:91

getEvent

getEvent(idOrTag): EventInfo
Parameters
- idOrTag: string | number
Returns EventInfo
- Defined in core/events/Events.ts:107

has

has(eventId): boolean
Parameters
- eventId: string | number
Returns boolean
- Defined in core/events/Events.ts:163

isJoined

isJoined(eventId): boolean
Parameters
- eventId: string | number
Returns boolean
- Defined in core/events/Events.ts:168

join

join(input): Promise<PlayerEventInfo>
Parameters
- input: {
  id?: number;
  tag?: string;
  }
  - Optional id?: number
  - Optional tag?: string
Returns Promise<PlayerEventInfo>
- Defined in core/events/Events.ts:173

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof EventsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: EventsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof EventsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: EventsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof EventsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: EventsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15