PlayerUtils

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export abstract class PlayerUtils {}

Properties

Property	Type	Description
manager	Manager	The Manager instance.

Constructor

new PlayerUtils(manager: Manager)

Parameter	Type	Description	Optional
manager	Manager	The Manager instance.

Methods

getGuildDir()

getGuildDir(guildId: string): string

Gets the directory for a given guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

Returns

Type	Description
string	The guild directory.

---

getPlayerCurrentPath()

getPlayerCurrentPath(guildId: string): string

Gets the current path for a given guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

Returns

Type	Description
string	The current.json path.

---

getPlayerPreviousPath()

getPlayerPreviousPath(guildId: string): string

Gets the previous path for a given guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

Returns

Type	Description
string	The previous.json path.

---

getPlayerQueuePath()

getPlayerQueuePath(guildId: string): string

Gets the queue path for a given guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

Returns

Type	Description
string	The queue.json path.

---

getPlayerStatePath()

getPlayerStatePath(guildId: string): string

Gets the state path for a given guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild id.

Returns

Type	Description
string	The state.json path.

---

getPlayersBaseDir()

getPlayersBaseDir(): string

Gets the base directory for players.

Returns

Type	Description
string	The base directory for players.

---

init()

init(manager: Manager): void

Initializes the TrackUtils instance.

Parameters

Parameter	Type	Description	Optional
manager	Manager	The Manager instance.

---

serializePlayer()

async serializePlayer(player: Player): Promise<Record<string, unknown>>

Serializes a player.

Parameters

Parameter	Type	Description	Optional
player	Player	The player to serialize.

Returns

Type	Description
Record<string, unknown>	The serialized player.