Class MKBrandbrigadeController

Index

Constructors

Methods

clear getVersion isActive toggleAugmentation

Constructors

constructor

new MKBrandbrigadeController(
    player: MKPlayerAPI,
    devBBConfig?: any,
    additionalDetails?: Record<string, string>,
): MKBrandbrigadeController
MKPlayer Brandbrigade controller.
Parameters
- player: MKPlayerAPI
  MKPlayer instance
- OptionaldevBBConfig: any
  optional Brandbrigade SDK config
- OptionaladditionalDetails: Record<string, string>
  optional additional details for Brandbrigade SDK
Returns MKBrandbrigadeController

Methods

clear

clear(clearPlayer?: boolean): void
Clear when Source is unloaded or Player is destroyed or not used anymore.
Parameters
- clearPlayer: boolean = false
  if true, drops player instance passed in initialization. Defaults to false
Returns void

getVersion

getVersion(): string
Get plugin version string.

Returns string
plugin version string.

isActive

isActive(): boolean
Returns whether plugin is currently active.

Returns boolean
true if the plugin is active, otherwise false.

toggleAugmentation

toggleAugmentation(enabled: boolean): void
Toggle to Enable or Disable the BrandBrigade Augmentation. Enabled internally when source is loaded.
Parameters
- enabled: boolean
  true to enable, false to disable
Returns void