Class Wrapper

Hierarchy

TypedEmitter<Events>
- Wrapper

Index

Constructors

constructor

Constructors

constructor

new Wrapper(config?): Wrapper
Creates an instance of wrapper.
Parameters
- config: Config = ...
 Configuration
Returns Wrapper
Overrides TypedEmitter<Events>.constructor
- Defined in lib/wrapper.ts:157

Properties

activated

activated: boolean = false

Weather or not the wrapper is activated.

`Private` `Readonly` config

config: Config

Configuration for the wrapper.

pluginInfo

pluginInfo: undefined | PluginInfo

Latest PluginInfo from the wrapper.

kartEventInfo

kartEventInfo: undefined | KartEventInfo

Latest KartEventInfo from the wrapper.

kartSessionInfo

kartSessionInfo: undefined | KartSessionInfo

Latest KartSessionInfo from the wrapper.

kartLapsInfo

kartLapsInfo: undefined | KartLapsInfo

Latest KartLapsInfo from the wrapper.

kartSplitsInfo

kartSplitsInfo: undefined | KartSplitsInfo

Latest KartSplitsInfo from the wrapper.

kartTelemetryInfo

kartTelemetryInfo: undefined | KartTelemetryInfo

Latest KartTelemetryInfo from the wrapper.

trackSegmentsInfo

trackSegmentsInfo: undefined | TrackSegmentsInfo

Latest TrackSegmentsInfo from the wrapper.

raceEventInfo

raceEventInfo: undefined | RaceEventInfo

Latest RaceEventInfo from the wrapper.

raceEntriesInfo

raceEntriesInfo: undefined | RaceEntriesInfo

Latest RaceEntriesInfo from the wrapper.

raceSessionInfo

raceSessionInfo: undefined | RaceSessionInfo

Latest RaceSessionInfo from the wrapper.

raceLapsInfo

raceLapsInfo: undefined | RaceLapsInfo

Latest RaceLapsInfo from the wrapper.

raceSplitsInfo

raceSplitsInfo: undefined | RaceSplitsInfo

Latest RaceSplitsInfo from the wrapper.

raceSpeedsInfo

raceSpeedsInfo: undefined | RaceSpeedsInfo

Latest RaceSpeedsInfo from the wrapper.

raceCommunicationsInfo

raceCommunicationsInfo: undefined | RaceCommunicationsInfo

Latest RaceCommunicationsInfo from the wrapper.

raceClassificationInfo

raceClassificationInfo: undefined | RaceClassificationInfo

Latest RaceClassificationInfo from the wrapper.

raceTrackPositionsInfo

raceTrackPositionsInfo: undefined | RaceTrackPositionsInfo

Latest RaceTrackPositionsInfo from the wrapper.

raceVehiclesDataInfo

raceVehiclesDataInfo: undefined | RaceVehiclesDataInfo

Latest RaceVehiclesDataInfo from the wrapper.

camerasInfo

camerasInfo: undefined | CamerasInfo

Latest CamerasInfo from the wrapper.

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

activate

activate(): void
Activates the wrapper.

Returns void
- Defined in lib/wrapper.ts:174

deactivate

deactivate(): void
Deactivates the wrapper.

Returns void
- Defined in lib/wrapper.ts:184

isConnected

isConnected(): boolean
Returns if the wrapper is connected.

Returns boolean
- Defined in lib/wrapper.ts:214

`Private` connect

connect(): void
Private
Tries to connect the wrapper.

Returns void
- Defined in lib/wrapper.ts:223

`Private` disconnect

disconnect(reason?): void
Private
Disconnects the wrapper.
Parameters
- reason: string = ""
  Reason for disconnect
Returns void
- Defined in lib/wrapper.ts:262

`Private` keepAlive

keepAlive(): void
Private
Checks if plugin is still alive.

Returns void
- Defined in lib/wrapper.ts:275

`Private` updateKartEventInfo

updateKartEventInfo(): void
Private
Updates the KartEventInfo Event.

Returns void
- Defined in lib/wrapper.ts:308

`Private` updateKartSessionInfo

updateKartSessionInfo(): void
Private
Updates the KartSessionInfo Event.

Returns void
- Defined in lib/wrapper.ts:322

`Private` updateKartLapsInfo

updateKartLapsInfo(): void
Private
Updates the KartLapsInfo Event.

Returns void
- Defined in lib/wrapper.ts:336

`Private` updateKartSplitsInfo

updateKartSplitsInfo(): void
Private
Updates the KartSplitsInfo Event.

Returns void
- Defined in lib/wrapper.ts:350

`Private` updateKartTelemetryInfo

updateKartTelemetryInfo(): void
Private
Updates the KartTelemetryInfo Event.

Returns void
- Defined in lib/wrapper.ts:364

`Private` updateTrackSegmentsInfo

updateTrackSegmentsInfo(): void
Private
Updates the TrackSegmentsInfo Event.

Returns void
- Defined in lib/wrapper.ts:378

`Private` updateRaceEventInfo

updateRaceEventInfo(): void
Private
Updates the RaceEventInfo Event.

Returns void
- Defined in lib/wrapper.ts:392

`Private` updateRaceEntriesInfo

updateRaceEntriesInfo(): void
Private
Updates the RaceEntriesInfo Event.

Returns void
- Defined in lib/wrapper.ts:406

`Private` updateRaceSessionInfo

updateRaceSessionInfo(): void
Private
Updates the RaceSessionInfo Event.

Returns void
- Defined in lib/wrapper.ts:420

`Private` updateRaceLapsInfo

updateRaceLapsInfo(): void
Private
Updates the RaceLapsInfo Event.

Returns void
- Defined in lib/wrapper.ts:434

`Private` updateRaceSplitsInfo

updateRaceSplitsInfo(): void
Private
Updates the RaceSplitsInfo Event.

Returns void
- Defined in lib/wrapper.ts:448

`Private` updateRaceSpeedsInfo

updateRaceSpeedsInfo(): void
Private
Updates the RaceSpeedsInfo Event.

Returns void
- Defined in lib/wrapper.ts:462

`Private` updateRaceClassificationInfo

updateRaceClassificationInfo(): void
Private
Updates the RaceClassificationInfo Event.

Returns void
- Defined in lib/wrapper.ts:476

`Private` updateRaceTrackPositionsInfo

updateRaceTrackPositionsInfo(): void
Private
Updates the RaceTrackPositionsInfo Event.

Returns void
- Defined in lib/wrapper.ts:493

`Private` updateRaceVehiclesDataInfo

updateRaceVehiclesDataInfo(): void
Private
Updates the RaceVehiclesDataInfo Event.

Returns void
- Defined in lib/wrapper.ts:510

`Private` updateCamerasInfo

updateCamerasInfo(): void
Private
Updates the CamerasInfo Event.

Returns void
- Defined in lib/wrapper.ts:527

spectateVehicle

spectateVehicle(vehicle): void
Set the vehicle to spectate.
Parameters
- vehicle: number
  The vehicle id to spectate.
Returns void
- Defined in lib/wrapper.ts:541

spectateCamera

spectateCamera(camera): void
Set the camera to spectate.
Parameters
- camera: number
  The camera id to spectate.
Returns void
- Defined in lib/wrapper.ts:551

addListener

addListener(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

prependListener

prependListener(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

removeListener

removeListener(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: keyof Events
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

once

once(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

on

on(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

off

off(event, listener): this
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

emit

emit(event, ...args): boolean
Type Parameters
- U extends keyof Events
Parameters
- event: U
- Rest ...args: Parameters<Events[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof Events
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

listenerCount

listenerCount(type): number
Parameters
- type: keyof Events
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type): Events[U][]
Type Parameters
- U extends keyof Events
Parameters
- type: U
Returns Events[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

rawListeners

rawListeners(type): Events[U][]
Type Parameters
- U extends keyof Events
Parameters
- type: U
Returns Events[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25

Class Wrapper

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Wrapper

Properties

activated

Private Readonly config

pluginInfo

kartEventInfo

kartSessionInfo

kartLapsInfo

kartSplitsInfo

kartTelemetryInfo

trackSegmentsInfo

raceEventInfo

raceEntriesInfo

raceSessionInfo

raceLapsInfo

raceSplitsInfo

raceSpeedsInfo

raceCommunicationsInfo

raceClassificationInfo

raceTrackPositionsInfo

raceVehiclesDataInfo

camerasInfo

Static defaultMaxListeners

Methods

activate

Returns void

deactivate

Returns void

isConnected

Returns boolean

Private connect

Returns void

Private disconnect

Parameters

Returns void

Private keepAlive

Returns void

Private updateKartEventInfo

Returns void

Private updateKartSessionInfo

Returns void

Private updateKartLapsInfo

Returns void

Private updateKartSplitsInfo

Returns void

Private updateKartTelemetryInfo

Returns void

Private updateTrackSegmentsInfo

Returns void

Private updateRaceEventInfo

Returns void

Private updateRaceEntriesInfo

Returns void

Private updateRaceSessionInfo

Returns void

Private updateRaceLapsInfo

Returns void

Private updateRaceSplitsInfo

Returns void

Private updateRaceSpeedsInfo

Returns void

Private updateRaceClassificationInfo

Returns void

Private updateRaceTrackPositionsInfo

Returns void

Private updateRaceVehiclesDataInfo

Returns void

Private updateCamerasInfo

Returns void

spectateVehicle

Parameters

`Private` `Readonly` config

`Static` defaultMaxListeners

`Private` connect

`Private` disconnect

`Private` keepAlive

`Private` updateKartEventInfo

`Private` updateKartSessionInfo

`Private` updateKartLapsInfo

`Private` updateKartSplitsInfo

`Private` updateKartTelemetryInfo

`Private` updateTrackSegmentsInfo

`Private` updateRaceEventInfo

`Private` updateRaceEntriesInfo

`Private` updateRaceSessionInfo

`Private` updateRaceLapsInfo

`Private` updateRaceSplitsInfo

`Private` updateRaceSpeedsInfo

`Private` updateRaceClassificationInfo

`Private` updateRaceTrackPositionsInfo

`Private` updateRaceVehiclesDataInfo

`Private` updateCamerasInfo