API Documentation Github

Class

Cave

Cave(caveOptions, botGuild, guild)

Constructor

# new Cave(caveOptions, botGuild, guild)

Parameters:
Name Type Description
caveOptions CaveOptions
botGuild BotGuildModel
guild Guild

View Source classes/activities/cave.js, line 60

Members

CaveOptions

# caveOptions

View Source classes/activities/cave.js, line 71

CaveChannels

# channels

The channels needed for a cave.

View Source classes/activities/cave.js, line 89

Room

# publicRoom

The public room for this cave.

View Source classes/activities/cave.js, line 95

Console

# subRoleConsole

The console where cave members can get sub roles.

View Source classes/activities/cave.js, line 101

Map.<String, SubRole>

# subRoles

The cave sub roles, keys are the emoji name, holds the subRole

View Source classes/activities/cave.js, line 78

TicketManager

# ticketManager

View Source classes/activities/cave.js, line 83

Methods

# async addSubRoleCallback(channel, userId) → {Promise.<Role>}

Prompts a user for information to create a new sub role for this cave.
Parameters:
Name Type Description
channel TextChannel
userId String

View Source classes/activities/cave.js, line 226

Promise.<Role>

# archive(archiveCategory)

Removes private channels and archives the public channels. It also deletes the ticket rooms.
Parameters:
Name Type Description
archiveCategory CategoryChannel

View Source classes/activities/cave.js, line 399

# delete()

Deletes all the tickets rooms, public channels and private channels.

View Source classes/activities/cave.js, line 387

# async deleteTicketChannelsCallback(channel, userId)

Will prompt the user for more information to delete some, all, or a few tickets.
Parameters:
Name Type Description
channel TextChannel
userId String

View Source classes/activities/cave.js, line 271

# async includeExcludeCallback(channel, userId)

Will prompt the user for channel numbers to include or exclude from the garbage collector.
Parameters:
Name Type Description
channel TextChannel
userId String

View Source classes/activities/cave.js, line 321