Class FairPlayPlugin

Fair Play Plugin - Distributes tracks fairly among requesters Prevents one user from dominating the queue

Hierarchy (view full)

PlayerPlugin<FairPlayPluginEvents & Record<string, unknown[]>>
- FairPlayPlugin

Index

Constructors

Properties

Methods

init applyFairPlay

Constructors

constructor

new FairPlayPlugin(): FairPlayPlugin
Returns FairPlayPlugin
Inherited from PlayerPlugin.constructor

Properties

`Protected` _

_: FairPlayPluginEvents & Record<string, unknown[]>

Type helper for event map - not used at runtime

`Readonly` name

name: "fairplay" = ...

Unique name for the plugin - must be readonly Used to identify and access the plugin from player.plugins

config

config: FairPlayConfig = ...

Methods

init

init(player): void
Initialize the plugin with the player instance Called once when the player is initialized
Parameters
- player: Player<QueueContext, []>
  The player instance to attach to
Returns void
Overrides PlayerPlugin.init
- Defined in extensions/FairPlayExtension.ts:38

applyFairPlay

applyFairPlay(guildId): void
Apply fair play algorithm to a queue
Parameters
- guildId: string
Returns void
- Defined in extensions/FairPlayExtension.ts:68