Class Events

Hierarchy

EventEmitter<EventsEvents>
- Events

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Events(gp: CoreSDK, syncManager: SyncManager, events: Event[]): Events

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

Properties

Private #eventsList

#eventsList: Event[] = []

Private #playerEventsList

#playerEventsList: PlayerEvent[] = []

Private #syncManager

#syncManager: SyncManager

Private _events

_events: EventLite = ...

Accessors

activeList

get activeList(): PlayerEvent[]

- Defined in core/events/Events.ts:87
Returns PlayerEvent[]

list

get list(): Event[]

- Defined in core/events/Events.ts:83
Returns Event[]

Methods

Private #getEventInfo

#getEventInfo(eventId: string | number): PlayerEventInfo

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

getEvent

getEvent(idOrTag: string | number): EventInfo

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

has

has(eventId: string | number): boolean

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

isJoined

isJoined(eventId: string | number): boolean

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

join

join(input: { id?: number; tag?: string }): Promise<PlayerEventInfo>

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

off

off<ET>(type: ET, handler: ((event: EventsEvents[ET]) => void)): void

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

on

on<ET>(type: ET, handler: ((event: EventsEvents[ET]) => void)): void

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

once

once<ET>(type: ET, handler: ((event: EventsEvents[ET]) => void)): void

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

Generated using TypeDoc