Class RainlinkPlayerManager

The node manager class for managing all active players

Hierarchy (view full)

RainlinkDatabase<RainlinkPlayer>
- RainlinkPlayerManager

Index

Constructors

Properties

Accessors

size values full

Methods

create destroy get delete clear set forEach

Constructors

constructor

new RainlinkPlayerManager(manager): RainlinkPlayerManager
The main class for handling lavalink players
Parameters
- manager: Rainlink
  The rainlink manager
Returns RainlinkPlayerManager
Overrides RainlinkDatabase.constructor
- Defined in src/Manager/RainlinkPlayerManager.ts:17

Properties

manager

manager: Rainlink

The rainlink manager

Accessors

size

get size(): number
Get how many elements of current database

Returns number
number
Inherited from RainlinkDatabase.size
- Defined in src/Utilities/RainlinkDatabase.ts:60

values

get values(): G[]
Get all current values of current database

Returns G[]
unknown[]
Inherited from RainlinkDatabase.values
- Defined in src/Utilities/RainlinkDatabase.ts:68

full

get full(): [string, G][]
Get all current values of current database

Returns [string, G][]
unknown[]
Inherited from RainlinkDatabase.full
- Defined in src/Utilities/RainlinkDatabase.ts:76

Methods

create

create(options): Promise<RainlinkPlayer>
Internal
Create a player
Parameters
- options: VoiceChannelOptions
Returns Promise<RainlinkPlayer>
RainlinkPlayer
- Defined in src/Manager/RainlinkPlayerManager.ts:27

destroy

destroy(guildId?): Promise<void>
Internal
Destroy a player
Parameters
- guildId: string = ''
Returns Promise<void>
The destroyed / disconnected player or undefined if none
- Defined in src/Manager/RainlinkPlayerManager.ts:90

get

get<D>(key): undefined | D
Get data from database
Type Parameters
- D = RainlinkPlayer
Parameters
- key: string
  key of that data
Returns undefined | D
D
Inherited from RainlinkDatabase.get
- Defined in src/Utilities/RainlinkDatabase.ts:13

delete

delete<D>(key): undefined | D
detete data from database and returns the deleted data
Type Parameters
- D = RainlinkPlayer
Parameters
- key: string
  key of that data
Returns undefined | D
D
Inherited from RainlinkDatabase.delete
- Defined in src/Utilities/RainlinkDatabase.ts:22

clear

clear(): void
detete all data from database

Returns void
Inherited from RainlinkDatabase.clear
- Defined in src/Utilities/RainlinkDatabase.ts:31

set

set<D>(key, data): undefined | D
Set data from database
Type Parameters
- D = RainlinkPlayer
Parameters
- key: string
  the key you want to set
- data: D
  data of that key
Returns undefined | D
D
Inherited from RainlinkDatabase.set
- Defined in src/Utilities/RainlinkDatabase.ts:41

forEach

forEach(callback): void
executes a provided function once for each array element.
Parameters
- callback: ((value: RainlinkPlayer, key: string) => unknown)
  Callback function
  - - (value, key): unknown
    - Parameters
      value: RainlinkPlayer
      key: string
      Returns unknown
Returns void
Inherited from RainlinkDatabase.forEach
- Defined in src/Utilities/RainlinkDatabase.ts:50