Class MKBrandbrigadeController

Hierarchy

MKBrandbrigadeController

Index

Constructors

Methods

clear getVersion isActive toggleAugmentation

Constructors

constructor

new MKBrandbrigadeController(player, devBBConfig?, additionalDetails?): MKBrandbrigadeController
Parameters
- player: MKPlayerAPI
- Optional devBBConfig: any
- Optional additionalDetails: Record<string, string>
Returns MKBrandbrigadeController

Methods

clear

clear(): void
Clear when Source is unloaded or Player is destroyed or not used anymore.

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): void
Toggle to Enable or Disable the BrandBrigade Augmentation.

Default is true.
Parameters
- enabled: boolean
Returns void