diff --git a/.jsdoc.json b/.jsdoc.json index fe8f535d..0eec8c07 100644 --- a/.jsdoc.json +++ b/.jsdoc.json @@ -9,7 +9,7 @@ } }, "opts": { - "destination": "./docs/", + "destination": "../yamdbf-docs/", "recurse": true, "template": "./node_modules/minami" } diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/Bot.html b/docs/Bot.html deleted file mode 100644 index 3160193d..00000000 --- a/docs/Bot.html +++ /dev/null @@ -1,2295 +0,0 @@ - - - - - Bot - Documentation - - - - - - - - - - - - - - - - - -
- -

Bot

- - - - - - - -
- -
- -

- Bot -

- - -
- -
-
- - - - - -

- new Bot(botOptions, clientOptionsopt) -

- - - - -
- -
- The Discord.js Client instance. Contains bot-specific storage, -guild specific storages, and contains important -fields for access within commands -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
botOptions - - -
BotOptions
 - - - - - 		- - - - - - Object containing required bot properties
clientOptions - - -
ClientOptions
 - - - - - 		- - <optional>
- - - - - - 		Discord.js ClientOptions
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - -

Extends

- - - - - - - - - - -

Events

- - - - - - -

- command -

- - - - -
- -
- Emitted whenever a command is successfully called -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
name - - -
string
 - - - - - 		Name of the called command
args - - -
Array<args>
 - - - - - 		Args passed to the called command
original - - -
string
 - - - - - 		Original content of the message that called the command
execTime - - -
number
 - - - - - 		Time command took to execute
message - - -
Message
 - - - - - 		Message that triggered the command
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -

Properties

- - - -

.commands :CommandRegistry<string, Command>

- -
- - - -
- Collection containing all loaded commands -
- - - - Type: -
CommandRegistry<string, Command>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.commandsDir :string

- -
- - - -
- Directory to find command class files. Optional -if bot is passive. See: Bot#passive -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.config :Object

- -
- - - -
- Object containing token and owner ids -
- - - - Type: -
Object
 - - - - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
token - - -
string
 - - - - - 		Discord login token for the bot
owner - - -
Array<string>
 - - - - - 		Array of owner id strings
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.disableBase :Array<string>

- -
- - - -
- Array of base command names to skip when loading commands. Base commands -may only be disabled by name, not by alias -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.guildStorages :GuildStorageRegistry<string, GuildStorage>

- -
- - - -
- Collection containing all GuildStorage instances -
- - - - Type: -
GuildStorageRegistry<string, GuildStorage>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.name :string

- -
- - - -
- The name of the Bot -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.noCommandErr :string

- -
- - - -
- Whether or not a generic 'command not found' message -should be given in DMs to instruct the user to -use the `help` command. Set to false to disable -this message -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.passive :boolean

- -
- - - -
- Whether or not this bot is passive. Passive bots -will not register a command dispatcher or a message -listener. This allows passive bots to be created that -do not respond to any commands but are able to perform -actions based on whatever the framework user wants -
- - - - Type: -
boolean
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.readyText :string

- -
- - - -
- Text to output when the bot is ready -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.selfbot :boolean

- -
- - - -
- Whether or not the bot is a selfbot -
- - - - Type: -
boolean
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

(nullable) .statusText :string

- -
- - - -
- Status text for the bot -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.storage :LocalStorage

- -
- - - -
- Bot-specific storage -
- - - - Type: -
LocalStorage
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.version :string

- -
- - - -
- Bot version, best taken from package.json -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - - - -

Methods

- - - - - - -

- .defaultSettingExists(key) → {boolean} -

- - - - -
- -
- See if a guild default setting exists -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key in storage to check
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - - -

- .getPrefix(guild) → {string|null} -

- - - - -
- -
- Shortcut to return the command prefix for the provided guild -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
guild - - -
Guild
 -| - -
string
 - - - - - 		The guild or guild id to get the prefix of
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 -| - -
null
 - - - - - - - - - -
- - - - - - -

- .loadCommand(command) -

- - - - -
- -
- Loads/reloads all/specific commands -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
command - - -
string
 - - - - - 		The name of a command to reload, or 'all' to load all commands
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .removeDefaultSetting(key) → {Bot} -

- - - - -
- -
- Remove a defaultGuildSettings item. Will not remove from ALL guild -settings, but will prevent the item from being added to new guild -settings storage upon creation -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key to use in settings storage
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Bot
 - - - - - - - - - -
- - - - - - -

- .setDefaultSetting(key, value) → {Bot} -

- - - - -
- -
- Set the value of a default setting key and push it to all guild -setting storages. Will not overwrite a setting in guild settings -storage if there is already an existing key with the given value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key to use in settings storage
value - - -
string
 - - - - - 		The value to use in settings storage
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Bot
 - - - - - - - - - -
- - - - - - -

- .start() → {Bot} -

- - - - -
- -
- Logs the Bot in and registers some event handlers -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Bot
 - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 255f1dff..00000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -yamdbf.js.org \ No newline at end of file diff --git a/docs/Command.html b/docs/Command.html deleted file mode 100644 index 51261fd3..00000000 --- a/docs/Command.html +++ /dev/null @@ -1,1407 +0,0 @@ - - - - - Command - Documentation - - - - - - - - - - - - - - - - - -
- -

Command

- - - - - - - -
- -
- -

- Command -

- - -
- -
-
- - - - - -

- new Command(bot, info) -

- - - - -
- -
- Command class to extend to create commands users can execute -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
info - - -
CommandInfo
 - - - - - 		Object containing required command properties
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Properties

- - - -

.aliases :Array<string>

- -
- - - -
- Aliases the command can be called by other than its name -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.argOpts :ArgOpts

- -
- - - -
- Options for how arguments should be parsed. See: ArgOpts -
- - - - Type: -
ArgOpts
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.bot :Bot

- -
- - - -
- Bot instance -
- - - - Type: -
Bot
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.description :string

- -
- - - -
- A brief description of the command, displayed -in the commands list via the Help command -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.extraHelp :string

- -
- - - -
- Extra information about the command to be displayed -by the Help command when 'help <command>' is called -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.group :string

- -
- - - -
- The command group that the command belongs to. Allows commands to be -grouped for disabling. The group 'base' cannot be disabled. -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.guildOnly :boolean

- -
- - - -
- Whether or not a command can only be used within a -guild text channel -
- - - - Type: -
boolean
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.name :string

- -
- - - -
- The name of the command, used by the dispatcher -to determine the command being executed -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.overloads :string

- -
- - - -
- The name of a base command to overload. Commands may only overload -base commands so the Command#group must be set to 'base' in -order to overload. Commands may only be overloaded by name, not by alias -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.ownerOnly :boolean

- -
- - - -
- Whether or not the command can be used by the bot owner(s). -
- - - - Type: -
boolean
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
See: Bot#config.owner
-
​
- - - -
- - - - - -
- - - -

.permissions :Array<PermissionResolvable>

- -
- - - -
- Array of permissions required by the command -caller to be able to execute the command in the guild the command is called in. -

-If any permissions are provided the command's `guildOnly` property will be automatically set to true -
- - - - Type: -
Array<PermissionResolvable>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.roles :Array<string>

- -
- - - -
- Array of roles required to use the command. If the command caller -has any of the roles in the array, they will be able to use the command -

-If any roles are provided the command's `guildOnly` property will be automatically set to true -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.usage :string

- -
- - - -
- An example of command usage. The token '<prefix>' will -be replaced by the guild-specific command prefix in the Help command when -'help <command>' is called -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - - - -

Methods

- - - - - - -

- .action(message, args, mentions, original) -

- - - - -
- -
- Action to be executed when the command is called. The following parameters -are what command actions will be passed by the CommandDispatcher whenever -a command is called. Be sure to receive these in proper order when writing -new commands -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
args - - -
Array<args>
 - - - - - 		An array containing the args parsed from the command calling message
mentions - - -
Array<User>
 - - - - - 		An array containing the Discord.js User -objects parsed from the mentions contained in a message
original - - -
string
 - - - - - 		The original raw content of the message that called the command
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .register() -

- - - - -
- -
- Assert Command#action is typeof Function, finishing the -command creation process.
Called by CommandRegistry#register -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/CommandDispatcher.html b/docs/CommandDispatcher.html deleted file mode 100644 index ecff8526..00000000 --- a/docs/CommandDispatcher.html +++ /dev/null @@ -1,2152 +0,0 @@ - - - - - CommandDispatcher - Documentation - - - - - - - - - - - - - - - - - -
- -

CommandDispatcher

- - - - - - - -
- -
- -

- CommandDispatcher -

- - -
- -
-
- - - - - -

- new CommandDispatcher(bot) -

- - - - -
- -
- Handles dispatching commands -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - -

- .checkLimiter(dm, message, command) → {boolean} -

- - - - -
- -
- Check of the command caller has roles that pass the command -limiter set by the guild admins if the command is called -within a guild -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
dm - - -
boolean
 - - - - - 		Whether the message is a DM
message - - -
Message
 - - - - - 		Discord.js message object
command - - -
Command
 - - - - - 		Command found by the dispatcher
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - - -

- .checkPermissions(dm, message, command) → {Array<PermissionResolvable>} -

- - - - -
- -
- Get a list of missing permissions for the command caller for the -given command, if any -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
dm - - -
boolean
 - - - - - 		Whether the message is a DM
message - - -
Message
 - - - - - 		Discord.js message object
command - - -
Command
 - - - - - 		Command found by the dispatcher
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Array<PermissionResolvable>
 - - - - - - - - - -
- - - - - - -

- .commandNotFoundError(message) → {Promise<Message>} -

- - - - -
- -
- Send a 'command not found' error message to the channel -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise<Message>
 - - - - - - - - - -
- - - - - - -

- .dispatch(command, message, args, mentions, original) → {Promise<*>} -

- - - - -
- -
- Pass the necessary items to the found Command's Command#action method -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
command - - -
Command
 - - - - - 		The command found by the dispatcher
message - - -
Message
 - - - - - 		Discord.js message object
args - - -
Array<args>
 - - - - - 		An array containing the args parsed from the command calling message
mentions - - -
Array<User>
 - - - - - 		An array containing the Discord.js User -objects parsed from the mentions contained in a message
original - - -
string
 - - - - - 		The original raw content of the message that called the command
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise<*>
 - - - - - - - - - -
- - - - - - -

- .failedLimiterError(message, command) → {Promise<Message>} -

- - - - -
- -
- Send a 'missing roles for role-limited command' error -message to the channel -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
command - - -
Command
 - - - - - 		Command found by the dispatcher
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise<Message>
 - - - - - - - - - -
- - - - - - -

- .guildOnlyError(message) → {Promise<Message>} -

- - - - -
- -
- Send a 'guild only' error message to the channel -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise<Message>
 - - - - - - - - - -
- - - - - - -

- .handleMessage(message) → {*} -

- - - - -
- -
- Determine if message is a valid command call and send to CommandDispatcher#dispatch -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
*
 - - - - - - - - - -
- - - - - - -

- .hasRoles(dm, message, command) → {boolean} -

- - - - -
- -
- Checks if the command caller has roles for the given command -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
dm - - -
boolean
 - - - - - 		Whether the message is a DM
message - - -
Message
 - - - - - 		Discord.js message object
command - - -
Command
 - - - - - 		Command found by the dispatcher
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - - -

- .missingPermissionsError(missing, message) → {Promise<Message>} -

- - - - -
- -
- Send a 'missing permissions' error message to the channel -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
missing - - -
Array<PermissionResolvable>
 - - - - - 		Array of missing permissions
message - - -
Message
 - - - - - 		Discord.js message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise<Message>
 - - - - - - - - - -
- - - - - - -

- .missingRolesError(message, command) → {Promise<Message>} -

- - - - -
- -
- Send a 'missing roles' error message to the channel -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
command - - -
Command
 - - - - - 		Command found by the dispatcher
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise<Message>
 - - - - - - - - - -
- - - - - - -

- .processContent(message) → {Object} -

- - - - -
- -
- Processes message content, finding the command to execute and creating an -object containing the found command, mentions, args, processed content, and -if the message is a DM -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
message - - -
Message
 - - - - - 		Discord.js message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Object
 - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/CommandLoader.html b/docs/CommandLoader.html deleted file mode 100644 index d9629235..00000000 --- a/docs/CommandLoader.html +++ /dev/null @@ -1,456 +0,0 @@ - - - - - CommandLoader - Documentation - - - - - - - - - - - - - - - - - -
- -

CommandLoader

- - - - - - - -
- -
- -

- CommandLoader -

- - -
- -
-
- - - - - -

- new CommandLoader(bot) -

- - - - -
- -
- Handles loading all commands from the given Bot's commandsDir -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - -

- .loadCommands() -

- - - - -
- -
- Load or reload all commands from the base commands directory and the -user-specified Bot#commandsDir directory and stores them in -the Bot's CommandRegistry instance (Bot#commands) -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .reloadCommand(nameOrAlias) → {boolean} -

- - - - -
- -
- Reload the given command in the Bot's CommandRegistry (Bot#commands) -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
nameOrAlias - - -
string
 - - - - - 		Command#name or Command#aliases alias
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/CommandRegistry.html b/docs/CommandRegistry.html deleted file mode 100644 index 61221187..00000000 --- a/docs/CommandRegistry.html +++ /dev/null @@ -1,1097 +0,0 @@ - - - - - CommandRegistry - Documentation - - - - - - - - - - - - - - - - - -
- -

CommandRegistry

- - - - - - - -
- -
- -

- CommandRegistry -

- - -
- -
-
- - - - - -

- new CommandRegistry() -

- - - - -
- -
- Stores loaded Commands as <name, Command> pairs -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - -

Extends

- - - - - - - - - - - - - - - - - - - - -

Properties

- - - -

.groups :Array<string>

- -
- - - -
- Contains all Command groups -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - - - -

Methods

- - - - - - -

- .filterDMHelp(bot, message) → {Collection<string, Command>} -

- - - - -
- -
- Returns all commands that can have their help looked up by the user -in the DM channel the message is in -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
message - - -
Message
 - - - - - 		Discord.js Message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Collection<string, Command>
 - - - - - - - - - -
- - - - - - -

- .filterDMUsable(bot, message) → {Collection<string, Command>} -

- - - - -
- -
- Returns all commands usable by the user within the DM channel the provided -message is in -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
message - - -
Message
 - - - - - 		Discord.js Message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Collection<string, Command>
 - - - - - - - - - -
- - - - - - -

- .filterGuildUsable(bot, message) → {Collection<string, Command>} -

- - - - -
- -
- Returns all commands usable by the user in the guild text channel -the provided message is in -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
message - - -
Message
 - - - - - 		Discord.js Message object
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Collection<string, Command>
 - - - - - - - - - -
- - - - - - -

- .findByNameOrAlias(text) → {Command} -

- - - - -
- -
- Finds a command by name or alias -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
text - - -
string
 - - - - - 		The name or alias of the Command
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Command
 - - - - - - - - - -
- - - - - - -

- .register(command, key, reload) -

- - - - -
- -
- Complete registration of a command and add to the parent Collection, -erroring on duplicate names and aliases -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
command - - -
Command
 - - - - - 		The Command to be registered
key - - -
string
 - - - - - 		The key to store the Command at. Will be Command#name
reload - - -
boolean
 - - - - - 		Whether or not the command is being reloaded and -replaced in the collection
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/GuildStorage.html b/docs/GuildStorage.html deleted file mode 100644 index ce2fffbe..00000000 --- a/docs/GuildStorage.html +++ /dev/null @@ -1,2996 +0,0 @@ - - - - - GuildStorage - Documentation - - - - - - - - - - - - - - - - - -
- -

GuildStorage

- - - - - - - -
- -
- -

- GuildStorage -

- - -
- -
-
- - - - - -

- new GuildStorage(bot, guild, dataStorage, settingsStorage) -

- - - - -
- -
- Handle loading, saving, and storing Guild data and settings -via persistent storage. Created automatically per-guild -by GuildStorageLoader -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
bot - - -
Bot
 - - - - - 		Bot instance
guild - - -
Guild
 -| - -
string
 - - - - - 		Discord.js Guild object or guild ID string
dataStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific data
settingsStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific settings
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Properties

- - - -

.id :string

- -
- - - -
- Discord.js Guild ID string -
- - - - Type: -
string
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.keys :Array<string>

- -
- - - -
- The names of all keys in this guild's storage -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.length :number

- -
- - - -
- The number of keys in this guild's storage -
- - - - Type: -
number
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.settingsKeys :Array<string>

- -
- - - -
- The names of all keys in this guild's settings -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.settingsLength :number

- -
- - - -
- The number of keys in this Guild's settings -
- - - - Type: -
number
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - - - -

Methods

- - - - - - -

- .clear() -

- - - - -
- -
- Delete all data from this guild's storage -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .deincr(key) -

- - - - -
- -
- Deincrement a stored integer value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to increment
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .deincrSetting(key) -

- - - - -
- -
- Deincrement a stored integer settings value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to increment
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .exists(key) → {boolean} -

- - - - -
- -
- Check if key/value pair exists in this guild's storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to check for
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - - -

- .getItem(key) → {*} -

- - - - -
- -
- Get the value of the given key in this guild's storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to get
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
*
 - - - - - - - - - -
- - - - - - -

- .getSetting(key) → {*} -

- - - - -
- -
- Get the value of the given key in this guild's settings -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the setting to get
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
*
 - - - - - - - - - -
- - - - - - -

- .incr(key) -

- - - - -
- -
- Increment a stored integer value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to increment
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .incrSetting(key) -

- - - - -
- -
- Increment a stored integer settings value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to increment
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .key(index) → {string} -

- - - - -
- -
- Get the name of the key at the given index in this guild's storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
index - - -
number
 - - - - - 		The index of the key to find
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - - -

- .queue(key, callback) → {Promise} -

- - - - -
- -
- Allow access to a storage/settings item only when it is not currently being -accessed. Waits for other nonConcurrentAccess operations to finish -before proceeding with callback -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		the storage key you will be accessing
callback - - -
function
 - - - - - 		callback to execute that will be accessing the key
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise
 - - - - - - - - - -
- - - - - - -

- .removeItem(key) -

- - - - -
- -
- Delete an item in this guild's storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to delete
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .removeSetting(key) -

- - - - -
- -
- Delete a setting in this guild's settings -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the setting to delete
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .resetSettings(defaults) -

- - - - -
- -
- Reset the settings for this guild to default, deleting any -extra settings that are not part of the provided defaults -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
defaults - - -
Object
 - - - - - 		Should always use defaultGuildSettings
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Example
- - 
<GuildStorage>.resetSettings(<Bot>.storage.getItem('defaultGuildSettings'));
- - - -
- - - - - - -

- .setItem(key, value) -

- - - - -
- -
- Set the value of a given key in this guild's storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to set
value - - -
*
 - - - - - 		The value to set
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .setSetting(key, value) -

- - - - -
- -
- Set the value of a setting in this guild's settings -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the setting to set
value - - -
*
 - - - - - 		The value to set
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .settingExists(key) → {boolean} -

- - - - -
- -
- Check if a setting exists -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the setting to check for
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - - -

- .settingKey(index) → {string} -

- - - - -
- -
- Get the name of the key at the given index in this guild's settings -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
index - - -
number
 - - - - - 		The index of the key to find
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/GuildStorageLoader.html b/docs/GuildStorageLoader.html deleted file mode 100644 index 87c58ded..00000000 --- a/docs/GuildStorageLoader.html +++ /dev/null @@ -1,647 +0,0 @@ - - - - - GuildStorageLoader - Documentation - - - - - - - - - - - - - - - - - -
- -

GuildStorageLoader

- - - - - - - -
- -
- -

- GuildStorageLoader -

- - -
- -
-
- - - - - -

- new GuildStorageLoader() -

- - - - -
- -
- Handles loading all guild-specific data from persistent storage into -GuildStorage objects -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - -

- .cleanGuilds(dataStorage, settingsStorage) -

- - - - -
- -
- Clean out any storages/settings storages for guilds the -bot is no longer a part of -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
dataStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific data
settingsStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific settings
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .initNewGuilds(dataStorage, settingsStorage) -

- - - - -
- -
- Assign a GuildStorage to guilds that lack one due to the bot being -in the guild before adopting this storage spec or the bot being -added to a new guild -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
dataStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific data
settingsStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific settings
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .loadStorages(dataStorage, settingsStorage) -

- - - - -
- -
- Load data for each guild from persistent storage and store it in a -GuildStorage object -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
dataStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific data
settingsStorage - - -
LocalStorage
 - - - - - 		LocalStorage instance containing all guild-specific settings
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/GuildStorageRegistry.html b/docs/GuildStorageRegistry.html deleted file mode 100644 index 22c3636d..00000000 --- a/docs/GuildStorageRegistry.html +++ /dev/null @@ -1,812 +0,0 @@ - - - - - GuildStorageRegistry - Documentation - - - - - - - - - - - - - - - - - -
- -

GuildStorageRegistry

- - - - - - - -
- -
- -

- GuildStorageRegistry -

- - -
- -
-
- - - - - -

- new GuildStorageRegistry() -

- - - - -
- -
- Stores all guild-specific storages as <string, GuildStorage> pairs, -where string is the guild's ID string -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - -

Extends

- - - - - - - - - - - - - - - - - - - - - - -

Methods

- - - - - - -

- .findAll(key, value) → {Collection<string, GuildStorage>} -

- - - - -
- -
- Return a Collection of GuildStorage items that -have the provided key and value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		Setting key to match
value - - -
*
 - - - - - 		Value to match
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Collection<string, GuildStorage>
 - - - - - - - - - -
- - - - - - -

- .findAllBySetting(key, value) → {Collection<string, GuildStorage>} -

- - - - -
- -
- Return a Collection of GuildStorage items that -have the provided setting key and value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		Setting key to match
value - - -
*
 - - - - - 		Value to match
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Collection<string, GuildStorage>
 - - - - - - - - - -
- - - - - - -

- .get(guild) → {GuildStorage} -

- - - - -
- -
- Get the GuildStorage by Guild or guild id string -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
guild - - -
Guild
 -| - -
string
 - - - - - 		Guild object or guild id string
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
GuildStorage
 - - - - - - - - - -
- - - - - - -

- .resetAllGuildSettings(defaults) -

- - - - -
- -
- Reset all guild settings to default, deleting any extra settings that are -not part of the DefaultGuildSettings -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
defaults - - -
DefaultGuildSettings
 - - - - - 		Should always use DefaultGuildSettings
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/LocalStorage.html b/docs/LocalStorage.html deleted file mode 100644 index 008e467d..00000000 --- a/docs/LocalStorage.html +++ /dev/null @@ -1,1601 +0,0 @@ - - - - - LocalStorage - Documentation - - - - - - - - - - - - - - - - - -
- -

LocalStorage

- - - - - - - -
- -
- -

- LocalStorage -

- - -
- -
-
- - - - - -

- new LocalStorage(fileName) -

- - - - -
- -
- Creates a persistent storage file and handles interacting with the persistent -storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
fileName - - -
string
 - - - - - 		The name of the persistent storage file. Will be json format
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Properties

- - - -

.keys :Array<string>

- -
- - - -
- The names of all keys in this storage -
- - - - Type: -
Array<string>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.length :number

- -
- - - -
- The number of keys in this storage -
- - - - Type: -
number
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - - - -

Methods

- - - - - - -

- .clear() -

- - - - -
- -
- Delete all items from this storage -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .deincr(key) -

- - - - -
- -
- Deincrement a stored integer value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to increment
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .exists(key) → {boolean} -

- - - - -
- -
- Check if key/value pair exists in this storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to check for
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
boolean
 - - - - - - - - - -
- - - - - - -

- .getItem(key) → {*} -

- - - - -
- -
- Get the value of the given key in this storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to get
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
*
 - - - - - - - - - -
- - - - - - -

- .incr(key) -

- - - - -
- -
- Increment a stored integer value -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to increment
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .key(index) → {string} -

- - - - -
- -
- Get the name of the key at the given index in this storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
index - - -
number
 - - - - - 		The index of the key to find
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - - -

- .queue(key, callback) → {Promise} -

- - - - -
- -
- Allow access to a storage item only when it is not currently being -accessed. Waits for other nonConcurrentAccess operations to finish -before proceeding with callback -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		the storage key you will be accessing
callback - - -
function
 - - - - - 		callback to execute that will be accessing the key
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
Promise
 - - - - - - - - - -
- - - - - - -

- .removeItem(key) -

- - - - -
- -
- Delete an item in this storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to delete
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - - -

- .setItem(key, value) -

- - - - -
- -
- Set the value of a given key in this storage -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -
string
 - - - - - 		The key of the item to set
value - - -
*
 - - - - - 		The value to set
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json deleted file mode 100644 index e14b0ce5..00000000 --- a/docs/docs.json +++ /dev/null @@ -1,2306 +0,0 @@ -{ - "classes": [ - { - "name": "Bot", - "description": "", - "extends": [ - "external:Client" - ], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "Bot", - "description": "The Discord.js Client instance. Contains bot-specific [storage]{@link Bot#storage},\nguild specific [storages]{@link Bot#guildStorages}, and contains important\nfields for access within commands", - "parameters": [ - { - "name": "botOptions", - "type": "BotOptions", - "description": "Object containing required bot properties", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "clientOptions", - "type": "external:ClientOptions", - "description": "Discord.js ClientOptions", - "default": "", - "optional": true, - "nullable": "" - } - ], - "examples": [] - }, - "properties": [ - { - "name": "name", - "access": "", - "virtual": false, - "description": "The name of the Bot", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "commandsDir", - "access": "", - "virtual": false, - "description": "Directory to find command class files. Optional\nif bot is passive. See: {@link Bot#passive}", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "statusText", - "access": "", - "virtual": false, - "description": "Status text for the bot", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "readyText", - "access": "", - "virtual": false, - "description": "Text to output when the bot is ready", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "noCommandErr", - "access": "", - "virtual": false, - "description": "Whether or not a generic 'command not found' message\nshould be given in DMs to instruct the user to\nuse the `help` command. Set to false to disable\nthis message", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "selfbot", - "access": "", - "virtual": false, - "description": "Whether or not the bot is a selfbot", - "type": { - "names": [ - "boolean" - ] - } - }, - { - "name": "passive", - "access": "", - "virtual": false, - "description": "Whether or not this bot is passive. Passive bots\nwill not register a command dispatcher or a message\nlistener. This allows passive bots to be created that\ndo not respond to any commands but are able to perform\nactions based on whatever the framework user wants", - "type": { - "names": [ - "boolean" - ] - } - }, - { - "name": "version", - "access": "", - "virtual": false, - "description": "Bot version, best taken from package.json", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "config", - "access": "", - "virtual": false, - "description": "Object containing token and owner ids", - "type": { - "names": [ - "Object" - ] - } - }, - { - "name": "disableBase", - "access": "", - "virtual": false, - "description": "Array of base command names to skip when loading commands. Base commands\nmay only be disabled by name, not by alias", - "type": { - "names": [ - "Array." - ] - } - }, - { - "name": "storage", - "access": "", - "virtual": false, - "description": "Bot-specific storage", - "type": { - "names": [ - "LocalStorage" - ] - } - }, - { - "name": "guildStorages", - "access": "", - "virtual": false, - "description": "[Collection]{@link external:Collection} containing all GuildStorage instances", - "type": { - "names": [ - "GuildStorageRegistry." - ] - } - }, - { - "name": "commands", - "access": "", - "virtual": false, - "description": "[Collection]{@link external:Collection} containing all loaded commands", - "type": { - "names": [ - "CommandRegistry." - ] - } - } - ], - "functions": [ - { - "name": "loadCommand", - "access": "", - "virtual": false, - "description": "Loads/reloads all/specific commands", - "parameters": [ - { - "name": "command", - "type": "string", - "description": "The name of a command to reload, or 'all' to load all commands", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "start", - "access": "", - "virtual": false, - "description": "Logs the Bot in and registers some event handlers", - "parameters": [], - "examples": [], - "returns": { - "type": "Bot", - "description": "" - } - }, - { - "name": "setDefaultSetting", - "access": "", - "virtual": false, - "description": "Set the value of a default setting key and push it to all guild\nsetting storages. Will not overwrite a setting in guild settings\nstorage if there is already an existing key with the given value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key to use in settings storage", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "value", - "type": "string", - "description": "The value to use in settings storage", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Bot", - "description": "" - } - }, - { - "name": "removeDefaultSetting", - "access": "", - "virtual": false, - "description": "Remove a defaultGuildSettings item. Will not remove from ALL guild\nsettings, but will prevent the item from being added to new guild\nsettings storage upon creation", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key to use in settings storage", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Bot", - "description": "" - } - }, - { - "name": "defaultSettingExists", - "access": "", - "virtual": false, - "description": "See if a guild default setting exists", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key in storage to check", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - }, - { - "name": "getPrefix", - "access": "", - "virtual": false, - "description": "Shortcut to return the command prefix for the provided guild", - "parameters": [ - { - "name": "guild", - "type": [ - "external:Guild", - "string" - ], - "description": "The guild or guild id to get the prefix of", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": [ - "string", - "null" - ], - "description": "" - } - } - ], - "events": [ - { - "name": "event:command", - "access": "", - "virtual": false, - "description": "Emitted whenever a command is successfully called", - "parameters": [ - { - "name": "name", - "type": "string", - "description": "Name of the called command", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "args", - "type": "Array.", - "description": "Args passed to the called command", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "original", - "type": "string", - "description": "Original content of the message that called the command", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "execTime", - "type": "number", - "description": "Time command took to execute", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Message that triggered the command", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - } - ] - }, - { - "name": "Command", - "description": "", - "extends": [], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "Command", - "description": "Command class to extend to create commands users can execute", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "info", - "type": "CommandInfo", - "description": "Object containing required command properties", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - "properties": [ - { - "name": "bot", - "access": "", - "virtual": false, - "description": "Bot instance", - "type": { - "names": [ - "Bot" - ] - } - }, - { - "name": "name", - "access": "", - "virtual": false, - "description": "The name of the command, used by the dispatcher\nto determine the command being executed", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "description", - "access": "", - "virtual": false, - "description": "A brief description of the command, displayed\nin the commands list via the Help command", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "usage", - "access": "", - "virtual": false, - "description": "An example of command usage. The token '<prefix>' will\nbe replaced by the guild-specific command prefix in the Help command when\n'help <command>' is called", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "extraHelp", - "access": "", - "virtual": false, - "description": "Extra information about the command to be displayed\nby the Help command when 'help <command>' is called", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "group", - "access": "", - "virtual": false, - "description": "The command group that the command belongs to. Allows commands to be\ngrouped for disabling. The group 'base' cannot be disabled.", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "aliases", - "access": "", - "virtual": false, - "description": "Aliases the command can be called by other than its name", - "type": { - "names": [ - "Array." - ] - } - }, - { - "name": "guildOnly", - "access": "", - "virtual": false, - "description": "Whether or not a command can only be used within a\nguild text channel", - "type": { - "names": [ - "boolean" - ] - } - }, - { - "name": "argOpts", - "access": "", - "virtual": false, - "description": "Options for how arguments should be parsed. See: {@link ArgOpts}", - "type": { - "names": [ - "ArgOpts" - ] - } - }, - { - "name": "permissions", - "access": "", - "virtual": false, - "description": "Array of permissions required by the command\ncaller to be able to execute the command in the guild the command is called in.\n

\nIf any permissions are provided the command's `guildOnly` property will be automatically set to true", - "type": { - "names": [ - "Array." - ] - } - }, - { - "name": "roles", - "access": "", - "virtual": false, - "description": "Array of roles required to use the command. If the command caller\nhas any of the roles in the array, they will be able to use the command\n

\nIf any roles are provided the command's `guildOnly` property will be automatically set to true", - "type": { - "names": [ - "Array." - ] - } - }, - { - "name": "ownerOnly", - "access": "", - "virtual": false, - "description": "Whether or not the command can be used by the bot owner(s).", - "type": { - "names": [ - "boolean" - ] - } - }, - { - "name": "overloads", - "access": "", - "virtual": false, - "description": "The name of a base command to overload. Commands may only overload\nbase commands so the {@link Command#group} must be set to 'base' in\norder to overload. Commands may only be overloaded by name, not by alias", - "type": { - "names": [ - "string" - ] - } - } - ], - "functions": [ - { - "name": "action", - "access": "", - "virtual": false, - "description": "Action to be executed when the command is called. The following parameters\nare what command actions will be passed by the {@link CommandDispatcher} whenever\na command is called. Be sure to receive these in proper order when writing\nnew commands", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "args", - "type": "Array.", - "description": "An array containing the args parsed from the command calling message", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "mentions", - "type": "Array.", - "description": "An array containing the Discord.js User\nobjects parsed from the mentions contained in a message", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "original", - "type": "string", - "description": "The original raw content of the message that called the command", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "register", - "access": "", - "virtual": false, - "description": "Assert {@link Command#action} is typeof Function, finishing the\ncommand creation process.
Called by {@link CommandRegistry#register}", - "parameters": [], - "examples": [] - } - ] - }, - { - "name": "CommandDispatcher", - "description": "", - "extends": [], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "CommandDispatcher", - "description": "Handles dispatching commands", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - "functions": [ - { - "name": "handleMessage", - "access": "", - "virtual": false, - "description": "Determine if message is a valid command call and send to {@link CommandDispatcher#dispatch}", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "*", - "description": "" - } - }, - { - "name": "processContent", - "access": "", - "virtual": false, - "description": "Processes message content, finding the command to execute and creating an\nobject containing the found command, mentions, args, processed content, and\nif the message is a DM", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Object", - "description": "" - } - }, - { - "name": "checkPermissions", - "access": "", - "virtual": false, - "description": "Get a list of missing permissions for the command caller for the\ngiven command, if any", - "parameters": [ - { - "name": "dm", - "type": "boolean", - "description": "Whether the message is a DM", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "command", - "type": "Command", - "description": "Command found by the dispatcher", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Array.", - "description": "" - } - }, - { - "name": "checkLimiter", - "access": "", - "virtual": false, - "description": "Check of the command caller has roles that pass the command\nlimiter set by the guild admins if the command is called\nwithin a guild", - "parameters": [ - { - "name": "dm", - "type": "boolean", - "description": "Whether the message is a DM", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "command", - "type": "Command", - "description": "Command found by the dispatcher", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - }, - { - "name": "hasRoles", - "access": "", - "virtual": false, - "description": "Checks if the command caller has roles for the given command", - "parameters": [ - { - "name": "dm", - "type": "boolean", - "description": "Whether the message is a DM", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "command", - "type": "Command", - "description": "Command found by the dispatcher", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - }, - { - "name": "commandNotFoundError", - "access": "", - "virtual": false, - "description": "Send a 'command not found' error message to the channel", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise.", - "description": "" - } - }, - { - "name": "guildOnlyError", - "access": "", - "virtual": false, - "description": "Send a 'guild only' error message to the channel", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise.", - "description": "" - } - }, - { - "name": "missingPermissionsError", - "access": "", - "virtual": false, - "description": "Send a 'missing permissions' error message to the channel", - "parameters": [ - { - "name": "missing", - "type": "Array.", - "description": "Array of missing permissions", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise.", - "description": "" - } - }, - { - "name": "missingRolesError", - "access": "", - "virtual": false, - "description": "Send a 'missing roles' error message to the channel", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "command", - "type": "Command", - "description": "Command found by the dispatcher", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise.", - "description": "" - } - }, - { - "name": "failedLimiterError", - "access": "", - "virtual": false, - "description": "Send a 'missing roles for role-limited command' error\nmessage to the channel", - "parameters": [ - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "command", - "type": "Command", - "description": "Command found by the dispatcher", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise.", - "description": "" - } - }, - { - "name": "dispatch", - "access": "", - "virtual": false, - "description": "Pass the necessary items to the found Command's {@link Command#action} method", - "parameters": [ - { - "name": "command", - "type": "Command", - "description": "The command found by the dispatcher", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js message object", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "args", - "type": "Array.", - "description": "An array containing the args parsed from the command calling message", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "mentions", - "type": "Array.", - "description": "An array containing the Discord.js User\nobjects parsed from the mentions contained in a message", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "original", - "type": "string", - "description": "The original raw content of the message that called the command", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise.<*>", - "description": "" - } - } - ] - }, - { - "name": "CommandLoader", - "description": "", - "extends": [], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "CommandLoader", - "description": "Handles loading all commands from the given Bot's commandsDir", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - "functions": [ - { - "name": "loadCommands", - "access": "", - "virtual": false, - "description": "Load or reload all commands from the base commands directory and the\nuser-specified {@link Bot#commandsDir} directory and stores them in\nthe Bot's {@link CommandRegistry} instance ({@link Bot#commands})", - "parameters": [], - "examples": [] - }, - { - "name": "reloadCommand", - "access": "", - "virtual": false, - "description": "Reload the given command in the Bot's {@link CommandRegistry} ({@link Bot#commands})", - "parameters": [ - { - "name": "nameOrAlias", - "type": "string", - "description": "{@link Command#name} or {@link Command#aliases} alias", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - } - ] - }, - { - "name": "CommandRegistry", - "description": "", - "extends": [ - "external:Collection" - ], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "CommandRegistry", - "description": "Stores loaded Commands as <[name]{@link Command#name}, [Command]{@link Command}> pairs", - "parameters": [], - "examples": [] - }, - "functions": [ - { - "name": "register", - "access": "", - "virtual": false, - "description": "Complete registration of a command and add to the parent [Collection]{@link external:Collection},\nerroring on duplicate names and aliases", - "parameters": [ - { - "name": "command", - "type": "Command", - "description": "The Command to be registered", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "key", - "type": "string", - "description": "The key to store the Command at. Will be {@link Command#name}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "reload", - "type": "boolean", - "description": "Whether or not the command is being reloaded and\nreplaced in the collection", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "findByNameOrAlias", - "access": "", - "virtual": false, - "description": "Finds a command by [name]{@link Command#name} or [alias]{@link Command#aliases}", - "parameters": [ - { - "name": "text", - "type": "string", - "description": "The name or alias of the Command", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Command", - "description": "" - } - }, - { - "name": "filterGuildUsable", - "access": "", - "virtual": false, - "description": "Returns all commands usable by the user in the guild text channel\nthe provided message is in", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js Message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "external:Collection.", - "description": "" - } - }, - { - "name": "filterDMUsable", - "access": "", - "virtual": false, - "description": "Returns all commands usable by the user within the DM channel the provided\nmessage is in", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js Message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "external:Collection.", - "description": "" - } - }, - { - "name": "filterDMHelp", - "access": "", - "virtual": false, - "description": "Returns all commands that can have their help looked up by the user\nin the DM channel the message is in", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "message", - "type": "external:Message", - "description": "Discord.js Message object", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "external:Collection.", - "description": "" - } - } - ], - "properties": [ - { - "name": "groups", - "access": "", - "virtual": false, - "description": "Contains all [Command groups]{@link Command#group}", - "type": { - "names": [ - "Array." - ] - } - } - ] - }, - { - "name": "GuildStorage", - "description": "", - "extends": [], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "GuildStorage", - "description": "Handle loading, saving, and storing Guild data and settings\nvia persistent storage. Created automatically per-guild\nby {@link GuildStorageLoader}", - "parameters": [ - { - "name": "bot", - "type": "Bot", - "description": "Bot instance", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "guild", - "type": [ - "external:Guild", - "string" - ], - "description": "Discord.js Guild object or guild ID string", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "dataStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific data", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "settingsStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific settings", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - "properties": [ - { - "name": "id", - "access": "", - "virtual": false, - "description": "Discord.js Guild ID string", - "type": { - "names": [ - "string" - ] - } - }, - { - "name": "settingsLength", - "access": "", - "virtual": false, - "description": "The number of keys in this Guild's settings", - "type": { - "names": [ - "number" - ] - } - }, - { - "name": "settingsKeys", - "access": "", - "virtual": false, - "description": "The names of all keys in this guild's settings", - "type": { - "names": [ - "Array." - ] - } - }, - { - "name": "length", - "access": "", - "virtual": false, - "description": "The number of keys in this guild's storage", - "type": { - "names": [ - "number" - ] - } - }, - { - "name": "keys", - "access": "", - "virtual": false, - "description": "The names of all keys in this guild's storage", - "type": { - "names": [ - "Array." - ] - } - } - ], - "functions": [ - { - "name": "settingKey", - "access": "", - "virtual": false, - "description": "Get the name of the key at the given index in this guild's settings", - "parameters": [ - { - "name": "index", - "type": "number", - "description": "The index of the key to find", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "string", - "description": "" - } - }, - { - "name": "getSetting", - "access": "", - "virtual": false, - "description": "Get the value of the given key in this guild's settings", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the setting to get", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "*", - "description": "" - } - }, - { - "name": "setSetting", - "access": "", - "virtual": false, - "description": "Set the value of a setting in this guild's settings", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the setting to set", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "value", - "type": "*", - "description": "The value to set", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "incrSetting", - "access": "", - "virtual": false, - "description": "Increment a stored integer settings value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to increment", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "deincrSetting", - "access": "", - "virtual": false, - "description": "Deincrement a stored integer settings value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to increment", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "removeSetting", - "access": "", - "virtual": false, - "description": "Delete a setting in this guild's settings", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the setting to delete", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "settingExists", - "access": "", - "virtual": false, - "description": "Check if a setting exists", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the setting to check for", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - }, - { - "name": "resetSettings", - "access": "", - "virtual": false, - "description": "Reset the settings for this guild to default, deleting any\nextra settings that are not part of the provided defaults", - "parameters": [ - { - "name": "defaults", - "type": "Object", - "description": "Should always use {@link defaultGuildSettings}", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [ - ".resetSettings(.storage.getItem('defaultGuildSettings'));" - ] - }, - { - "name": "key", - "access": "", - "virtual": false, - "description": "Get the name of the key at the given index in this guild's storage", - "parameters": [ - { - "name": "index", - "type": "number", - "description": "The index of the key to find", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "string", - "description": "" - } - }, - { - "name": "getItem", - "access": "", - "virtual": false, - "description": "Get the value of the given key in this guild's storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to get", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "*", - "description": "" - } - }, - { - "name": "setItem", - "access": "", - "virtual": false, - "description": "Set the value of a given key in this guild's storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to set", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "value", - "type": "*", - "description": "The value to set", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "incr", - "access": "", - "virtual": false, - "description": "Increment a stored integer value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to increment", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "deincr", - "access": "", - "virtual": false, - "description": "Deincrement a stored integer value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to increment", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "removeItem", - "access": "", - "virtual": false, - "description": "Delete an item in this guild's storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to delete", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "exists", - "access": "", - "virtual": false, - "description": "Check if key/value pair exists in this guild's storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to check for", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - }, - { - "name": "clear", - "access": "", - "virtual": false, - "description": "Delete all data from this guild's storage", - "parameters": [], - "examples": [] - }, - { - "name": "queue", - "access": "", - "virtual": false, - "description": "Allow access to a storage/settings item only when it is not currently being\naccessed. Waits for other nonConcurrentAccess operations to finish\nbefore proceeding with callback", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "the storage key you will be accessing", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "callback", - "type": "function", - "description": "callback to execute that will be accessing the key", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise", - "description": "" - } - } - ] - }, - { - "name": "GuildStorageLoader", - "description": "", - "extends": [], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "GuildStorageLoader", - "description": "Handles loading all guild-specific data from persistent storage into\n{@link GuildStorage} objects", - "parameters": [], - "examples": [] - }, - "functions": [ - { - "name": "loadStorages", - "access": "", - "virtual": false, - "description": "Load data for each guild from persistent storage and store it in a\n{@link GuildStorage} object", - "parameters": [ - { - "name": "dataStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific data", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "settingsStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific settings", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "initNewGuilds", - "access": "", - "virtual": false, - "description": "Assign a GuildStorage to guilds that lack one due to the bot being\nin the guild before adopting this storage spec or the bot being\nadded to a new guild", - "parameters": [ - { - "name": "dataStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific data", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "settingsStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific settings", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "cleanGuilds", - "access": "", - "virtual": false, - "description": "Clean out any storages/settings storages for guilds the\nbot is no longer a part of", - "parameters": [ - { - "name": "dataStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific data", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "settingsStorage", - "type": "LocalStorage", - "description": "LocalStorage instance containing all guild-specific settings", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - } - ] - }, - { - "name": "GuildStorageRegistry", - "description": "", - "extends": [ - "external:Collection" - ], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "GuildStorageRegistry", - "description": "Stores all guild-specific storages as <{@link string}, {@link GuildStorage}> pairs,\nwhere {@link string} is the guild's ID string", - "parameters": [], - "examples": [] - }, - "functions": [ - { - "name": "get", - "access": "", - "virtual": false, - "description": "Get the GuildStorage by [Guild]{@link external:Guild} or guild id string", - "parameters": [ - { - "name": "guild", - "type": [ - "external:Guild", - "string" - ], - "description": "Guild object or guild id string", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "GuildStorage", - "description": "" - } - }, - { - "name": "findAll", - "access": "", - "virtual": false, - "description": "Return a [Collection]{@link external:Collection} of GuildStorage items that\nhave the provided key and value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "Setting key to match", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "value", - "type": "*", - "description": "Value to match", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "external:Collection.", - "description": "" - } - }, - { - "name": "findAllBySetting", - "access": "", - "virtual": false, - "description": "Return a [Collection]{@link external:Collection} of GuildStorage items that\nhave the provided setting key and value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "Setting key to match", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "value", - "type": "*", - "description": "Value to match", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "external:Collection.", - "description": "" - } - }, - { - "name": "resetAllGuildSettings", - "access": "", - "virtual": false, - "description": "Reset all guild settings to default, deleting any extra settings that are\nnot part of the [DefaultGuildSettings]{@link DefaultGuildSettings}", - "parameters": [ - { - "name": "defaults", - "type": "DefaultGuildSettings", - "description": "Should always use [DefaultGuildSettings]{@link DefaultGuildSettings}", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - } - ] - }, - { - "name": "LocalStorage", - "description": "", - "extends": [], - "access": "", - "virtual": false, - "fires": "", - "constructor": { - "name": "LocalStorage", - "description": "Creates a persistent storage file and handles interacting with the persistent\nstorage", - "parameters": [ - { - "name": "fileName", - "type": "string", - "description": "The name of the persistent storage file. Will be json format", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - "properties": [ - { - "name": "length", - "access": "", - "virtual": false, - "description": "The number of keys in this storage", - "type": { - "names": [ - "number" - ] - } - }, - { - "name": "keys", - "access": "", - "virtual": false, - "description": "The names of all keys in this storage", - "type": { - "names": [ - "Array." - ] - } - } - ], - "functions": [ - { - "name": "key", - "access": "", - "virtual": false, - "description": "Get the name of the key at the given index in this storage", - "parameters": [ - { - "name": "index", - "type": "number", - "description": "The index of the key to find", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "string", - "description": "" - } - }, - { - "name": "getItem", - "access": "", - "virtual": false, - "description": "Get the value of the given key in this storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to get", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "*", - "description": "" - } - }, - { - "name": "setItem", - "access": "", - "virtual": false, - "description": "Set the value of a given key in this storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to set", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "value", - "type": "*", - "description": "The value to set", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "incr", - "access": "", - "virtual": false, - "description": "Increment a stored integer value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to increment", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "deincr", - "access": "", - "virtual": false, - "description": "Deincrement a stored integer value", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to increment", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "removeItem", - "access": "", - "virtual": false, - "description": "Delete an item in this storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to delete", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [] - }, - { - "name": "exists", - "access": "", - "virtual": false, - "description": "Check if key/value pair exists in this storage", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "The key of the item to check for", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "boolean", - "description": "" - } - }, - { - "name": "clear", - "access": "", - "virtual": false, - "description": "Delete all items from this storage", - "parameters": [], - "examples": [] - }, - { - "name": "queue", - "access": "", - "virtual": false, - "description": "Allow access to a storage item only when it is not currently being\naccessed. Waits for other nonConcurrentAccess operations to finish\nbefore proceeding with callback", - "parameters": [ - { - "name": "key", - "type": "string", - "description": "the storage key you will be accessing", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "callback", - "type": "function", - "description": "callback to execute that will be accessing the key", - "default": "", - "optional": "", - "nullable": "" - } - ], - "examples": [], - "returns": { - "type": "Promise", - "description": "" - } - } - ] - } - ], - "typedefs": [ - { - "name": "DefaultGuildSettings", - "description": "The default settings to apply to new guilds.\nStored under the key 'defaultGuildSettings' in {@link Bot#storage}", - "properties": [ - { - "name": "prefix", - "type": "string", - "description": "Prefix to prepend commands", - "default": "'/'", - "optional": "", - "nullable": "" - }, - { - "name": "disabledGroups", - "type": "Array", - "description": "Command groups to ignore", - "default": "[]", - "optional": true, - "nullable": "" - } - ] - }, - { - "name": "BotOptions", - "description": "Object containing required {@link Bot} properties to be\npassed to a Bot on construction", - "properties": [ - { - "name": "name", - "type": "string", - "description": "See: {@link Bot#name}", - "default": "'botname'", - "optional": true, - "nullable": "" - }, - { - "name": "token", - "type": "string", - "description": "See: {@link Bot#token}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "commandsDir", - "type": "string", - "description": "See: {@link Bot#commandsDir}", - "default": "", - "optional": true, - "nullable": "" - }, - { - "name": "statusText", - "type": "string", - "description": "See: {@link Bot#statusText}", - "default": null, - "optional": true, - "nullable": "" - }, - { - "name": "readyText", - "type": "string", - "description": "See: {@link Bot#readyText}", - "default": "'Ready!'", - "optional": true, - "nullable": "" - }, - { - "name": "noCommandErr", - "type": "boolean", - "description": "See: {@link Bot#noCommandErr}", - "default": true, - "optional": true, - "nullable": "" - }, - { - "name": "selfbot", - "type": "boolean", - "description": "See: {@link Bot#selfbot}", - "default": false, - "optional": true, - "nullable": "" - }, - { - "name": "passive", - "type": "boolean", - "description": "see {@link Bot#passive}", - "default": false, - "optional": true, - "nullable": "" - }, - { - "name": "version", - "type": "string", - "description": "See: {@link Bot#version}", - "default": "'0.0.0'", - "optional": true, - "nullable": "" - }, - { - "name": "config", - "type": "Object", - "description": "See: {@link Bot#config}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "disableBase", - "type": "Array.", - "description": "See: {@link Bot#disableBase}", - "default": "[]", - "optional": true, - "nullable": "" - } - ] - }, - { - "name": "args", - "description": "Array of values parsed from {@link external:Message} content\nthat will be passed to a command. Can contain a mix of string and number values.", - "properties": [] - }, - { - "name": "CommandInfo", - "description": "Object containing required {@link Command} properties\nto be passed to a Command on construction", - "properties": [ - { - "name": "name", - "type": "string", - "description": "See: {@link Command#name}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "description", - "type": "string", - "description": "See: {@link Command#description}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "usage", - "type": "string", - "description": "See: {@link Command#usage}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "extraHelp", - "type": "string", - "description": "See: {@link Command#extraHelp}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "group", - "type": "string", - "description": "See: {@link Command#group}", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "aliases", - "type": "Array.", - "description": "See: {@link Command#aliases}", - "default": "[]", - "optional": true, - "nullable": "" - }, - { - "name": "guildOnly", - "type": "boolean", - "description": "See: {@link Command#guildOnly}", - "default": false, - "optional": true, - "nullable": "" - }, - { - "name": "hidden", - "type": "boolean", - "description": "See: {@link Command#hidden}", - "default": false, - "optional": true, - "nullable": "" - }, - { - "name": "argOpts", - "type": "ArgOpts", - "description": "See: {@link Command#argOpts}, {@link ArgOpts}", - "default": "", - "optional": true, - "nullable": "" - }, - { - "name": "permissions", - "type": "Array.", - "description": "See: {@link Command#permissions}", - "default": "[]", - "optional": true, - "nullable": "" - }, - { - "name": "roles", - "type": "Array.", - "description": "See: {@link Command#roles}", - "default": "[]", - "optional": true, - "nullable": "" - }, - { - "name": "ownerOnly", - "type": "boolean", - "description": "See: {@link Command#ownerOnly}", - "default": false, - "optional": true, - "nullable": "" - }, - { - "name": "overloads", - "type": "string", - "description": "See: {@link Command#overloads}", - "default": null, - "optional": true, - "nullable": "" - } - ] - }, - { - "name": "ArgOpts", - "description": "Object containing options for\ncontrolling how command arguments will be parsed", - "properties": [ - { - "name": "stringArgs", - "type": "boolean", - "description": "Whether or not to parse all args as strings", - "default": "", - "optional": "", - "nullable": "" - }, - { - "name": "separator", - "type": "string", - "description": "The charactor to separate args by", - "default": "' '", - "optional": true, - "nullable": "" - } - ] - } - ] -} diff --git a/docs/external-Client.html b/docs/external-Client.html deleted file mode 100644 index aa94afed..00000000 --- a/docs/external-Client.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Client - Documentation - - - - - - - - - - - - - - - - - -
- -

Client

- - - - - - - -
- -
- -

- version~ - - Client -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/external-ClientOptions.html b/docs/external-ClientOptions.html deleted file mode 100644 index f6ac9957..00000000 --- a/docs/external-ClientOptions.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - ClientOptions - Documentation - - - - - - - - - - - - - - - - - -
- -

ClientOptions

- - - - - - - -
- -
- -

- version~ - - ClientOptions -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/external-Collection.html b/docs/external-Collection.html deleted file mode 100644 index b7eecee8..00000000 --- a/docs/external-Collection.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Collection - Documentation - - - - - - - - - - - - - - - - - -
- -

Collection

- - - - - - - -
- -
- -

- version~ - - Collection -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/external-Guild.html b/docs/external-Guild.html deleted file mode 100644 index 2304de3a..00000000 --- a/docs/external-Guild.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Guild - Documentation - - - - - - - - - - - - - - - - - -
- -

Guild

- - - - - - - -
- -
- -

- version~ - - Guild -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/external-Message.html b/docs/external-Message.html deleted file mode 100644 index b2be67de..00000000 --- a/docs/external-Message.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - Message - Documentation - - - - - - - - - - - - - - - - - -
- -

Message

- - - - - - - -
- -
- -

- version~ - - Message -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/external-PermissionResolvable.html b/docs/external-PermissionResolvable.html deleted file mode 100644 index c2131363..00000000 --- a/docs/external-PermissionResolvable.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - PermissionResolvable - Documentation - - - - - - - - - - - - - - - - - -
- -

PermissionResolvable

- - - - - - - -
- -
- -

- version~ - - PermissionResolvable -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/external-User.html b/docs/external-User.html deleted file mode 100644 index 10135bff..00000000 --- a/docs/external-User.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - User - Documentation - - - - - - - - - - - - - - - - - -
- -

User

- - - - - - - -
- -
- -

- version~ - - User -

- - -
- - - -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.eot b/docs/fonts/OpenSans-Bold-webfont.eot deleted file mode 100644 index 5d20d916..00000000 Binary files a/docs/fonts/OpenSans-Bold-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Bold-webfont.svg b/docs/fonts/OpenSans-Bold-webfont.svg deleted file mode 100644 index 3ed7be4b..00000000 --- a/docs/fonts/OpenSans-Bold-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Bold-webfont.woff b/docs/fonts/OpenSans-Bold-webfont.woff deleted file mode 100644 index 1205787b..00000000 Binary files a/docs/fonts/OpenSans-Bold-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.eot b/docs/fonts/OpenSans-BoldItalic-webfont.eot deleted file mode 100644 index 1f639a15..00000000 Binary files a/docs/fonts/OpenSans-BoldItalic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.svg b/docs/fonts/OpenSans-BoldItalic-webfont.svg deleted file mode 100644 index 6a2607b9..00000000 --- a/docs/fonts/OpenSans-BoldItalic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-BoldItalic-webfont.woff b/docs/fonts/OpenSans-BoldItalic-webfont.woff deleted file mode 100644 index ed760c06..00000000 Binary files a/docs/fonts/OpenSans-BoldItalic-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Italic-webfont.eot b/docs/fonts/OpenSans-Italic-webfont.eot deleted file mode 100644 index 0c8a0ae0..00000000 Binary files a/docs/fonts/OpenSans-Italic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Italic-webfont.svg b/docs/fonts/OpenSans-Italic-webfont.svg deleted file mode 100644 index e1075dcc..00000000 --- a/docs/fonts/OpenSans-Italic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Italic-webfont.woff b/docs/fonts/OpenSans-Italic-webfont.woff deleted file mode 100644 index ff652e64..00000000 Binary files a/docs/fonts/OpenSans-Italic-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Light-webfont.eot b/docs/fonts/OpenSans-Light-webfont.eot deleted file mode 100644 index 14868406..00000000 Binary files a/docs/fonts/OpenSans-Light-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Light-webfont.svg b/docs/fonts/OpenSans-Light-webfont.svg deleted file mode 100644 index 11a472ca..00000000 --- a/docs/fonts/OpenSans-Light-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Light-webfont.woff b/docs/fonts/OpenSans-Light-webfont.woff deleted file mode 100644 index e7860748..00000000 Binary files a/docs/fonts/OpenSans-Light-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.eot b/docs/fonts/OpenSans-LightItalic-webfont.eot deleted file mode 100644 index 8f445929..00000000 Binary files a/docs/fonts/OpenSans-LightItalic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-LightItalic-webfont.svg b/docs/fonts/OpenSans-LightItalic-webfont.svg deleted file mode 100644 index 431d7e35..00000000 --- a/docs/fonts/OpenSans-LightItalic-webfont.svg +++ /dev/null @@ -1,1835 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-LightItalic-webfont.woff b/docs/fonts/OpenSans-LightItalic-webfont.woff deleted file mode 100644 index 43e8b9e6..00000000 Binary files a/docs/fonts/OpenSans-LightItalic-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Regular-webfont.eot b/docs/fonts/OpenSans-Regular-webfont.eot deleted file mode 100644 index 6bbc3cf5..00000000 Binary files a/docs/fonts/OpenSans-Regular-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Regular-webfont.svg b/docs/fonts/OpenSans-Regular-webfont.svg deleted file mode 100644 index 25a39523..00000000 --- a/docs/fonts/OpenSans-Regular-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Regular-webfont.woff b/docs/fonts/OpenSans-Regular-webfont.woff deleted file mode 100644 index e231183d..00000000 Binary files a/docs/fonts/OpenSans-Regular-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-Semibold-webfont.eot b/docs/fonts/OpenSans-Semibold-webfont.eot deleted file mode 100644 index d8375dd0..00000000 Binary files a/docs/fonts/OpenSans-Semibold-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-Semibold-webfont.svg b/docs/fonts/OpenSans-Semibold-webfont.svg deleted file mode 100644 index eec4db8b..00000000 --- a/docs/fonts/OpenSans-Semibold-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-Semibold-webfont.ttf b/docs/fonts/OpenSans-Semibold-webfont.ttf deleted file mode 100644 index b3290843..00000000 Binary files a/docs/fonts/OpenSans-Semibold-webfont.ttf and /dev/null differ diff --git a/docs/fonts/OpenSans-Semibold-webfont.woff b/docs/fonts/OpenSans-Semibold-webfont.woff deleted file mode 100644 index 28d6adee..00000000 Binary files a/docs/fonts/OpenSans-Semibold-webfont.woff and /dev/null differ diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.eot b/docs/fonts/OpenSans-SemiboldItalic-webfont.eot deleted file mode 100644 index 0ab1db22..00000000 Binary files a/docs/fonts/OpenSans-SemiboldItalic-webfont.eot and /dev/null differ diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.svg b/docs/fonts/OpenSans-SemiboldItalic-webfont.svg deleted file mode 100644 index 7166ec1b..00000000 --- a/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf b/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf deleted file mode 100644 index d2d6318f..00000000 Binary files a/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf and /dev/null differ diff --git a/docs/fonts/OpenSans-SemiboldItalic-webfont.woff b/docs/fonts/OpenSans-SemiboldItalic-webfont.woff deleted file mode 100644 index d4dfca40..00000000 Binary files a/docs/fonts/OpenSans-SemiboldItalic-webfont.woff and /dev/null differ diff --git a/docs/global.html b/docs/global.html deleted file mode 100644 index 9e875772..00000000 --- a/docs/global.html +++ /dev/null @@ -1,1627 +0,0 @@ - - - - - Global - Documentation - - - - - - - - - - - - - - - - - -
- -

Global

- - - - - - - -
- -
- -

- -

- - -
- -
-
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - - - - - - - -

Type Definitions

- - - -

.ArgOpts

- -
- - - -
- Object containing options for -controlling how command arguments will be parsed -
- - - - Type: -
Object
 - - - - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
stringArgs - - -
boolean
 - - - - - 		- - - - - - Whether or not to parse all args as strings
separator - - -
string
 - - - - - 		- - <optional>
- - - - 		- - ' ' - - The charactor to separate args by
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.args

- -
- - - -
- Array of values parsed from Message content -that will be passed to a command. Can contain a mix of string and number values. -
- - - - Type: -
Array<(string|number)>
 - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.BotOptions

- -
- - - -
- Object containing required Bot properties to be -passed to a Bot on construction -
- - - - Type: -
Object
 - - - - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
name - - -
string
 - - - - - 		- - <optional>
- - - - 		- - 'botname' - - See: Bot#name
token - - -
string
 - - - - - 		- - - - - - See: Bot#token
commandsDir - - -
string
 - - - - - 		- - <optional>
- - - - 		- - See: Bot#commandsDir
statusText - - -
string
 - - - - - 		- - <optional>
- - - - 		- - null - - See: Bot#statusText
readyText - - -
string
 - - - - - 		- - <optional>
- - - - 		- - 'Ready!' - - See: Bot#readyText
noCommandErr - - -
boolean
 - - - - - 		- - <optional>
- - - - 		- - true - - See: Bot#noCommandErr
selfbot - - -
boolean
 - - - - - 		- - <optional>
- - - - 		- - false - - See: Bot#selfbot
passive - - -
boolean
 - - - - - 		- - <optional>
- - - - 		- - false - - see Bot#passive
version - - -
string
 - - - - - 		- - <optional>
- - - - 		- - '0.0.0' - - See: Bot#version
config - - -
Object
 - - - - - 		- - - - - - See: Bot#config
disableBase - - -
Array<string>
 - - - - - 		- - <optional>
- - - - 		- - [] - - See: Bot#disableBase
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.CommandInfo

- -
- - - -
- Object containing required Command properties -to be passed to a Command on construction -
- - - - Type: -
Object
 - - - - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
name - - -
string
 - - - - - 		- - - - - - See: Command#name
description - - -
string
 - - - - - 		- - - - - - See: Command#description
usage - - -
string
 - - - - - 		- - - - - - See: Command#usage
extraHelp - - -
string
 - - - - - 		- - - - - - See: Command#extraHelp
group - - -
string
 - - - - - 		- - - - - - See: Command#group
aliases - - -
Array<string>
 - - - - - 		- - <optional>
- - - - 		- - [] - - See: Command#aliases
guildOnly - - -
boolean
 - - - - - 		- - <optional>
- - - - 		- - false - - See: Command#guildOnly
hidden - - -
boolean
 - - - - - 		- - <optional>
- - - - 		- - false - - See: Command#hidden
argOpts - - -
ArgOpts
 - - - - - 		- - <optional>
- - - - 		- - See: Command#argOpts, ArgOpts
permissions - - -
Array<PermissionResolvable>
 - - - - - 		- - <optional>
- - - - 		- - [] - - See: Command#permissions
roles - - -
Array<string>
 - - - - - 		- - <optional>
- - - - 		- - [] - - See: Command#roles
ownerOnly - - -
boolean
 - - - - - 		- - <optional>
- - - - 		- - false - - See: Command#ownerOnly
overloads - - -
string
 - - - - - 		- - <optional>
- - - - 		- - null - - See: Command#overloads
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -

.DefaultGuildSettings

- -
- - - -
- The default settings to apply to new guilds. -Stored under the key 'defaultGuildSettings' in Bot#storage -
- - - - Type: -
Object
 - - - - - - - - -
Properties:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
prefix - - -
string
 - - - - - 		- - - - - - '/' - - Prefix to prepend commands
disabledGroups - - -
Array
 - - - - - 		- - <optional>
- - - - 		- - [] - - Command groups to ignore
- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - -
- - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 5e91e75f..00000000 --- a/docs/index.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Home - Documentation - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
-

YAMDBF: Yet Another Modular Discord Bot Framework

Discord -npm -David -CircleCI

-

NPM

-

A Discord.js-based Discord Bot framework to be used as a base for quick bot development.

-

Usage of the framework is pretty simple. Run npm install --save yamdbf in your project folder, create a folder to put commands in, create a file named config.json that looks like this:

-
{
-    "token": "token",
-    "owner": ["ownerid"]
-}

Then fill in the values and create a basic bot script.

-

A basic bot script will look something like this

-
const Bot = require('yamdbf').Bot;
-const config = require('./config.json');
-const path = require('path');
-const bot = new Bot({
-    name: 'bot',
-    token: config.token,
-    config: config,
-    selfbot: false,
-    version: '1.0.0',
-    statusText: 'try @mention help',
-    commandsDir: path.join(__dirname, 'commands')
-}).start();
-

By default the prefix is /, for all of the selfbot users out there. For regular bots, you can just mention the bot and use setprefix to change it.

-
-

And that's all it takes! Just that and you have a fully functioning bot with the base commands available in the framework. After that you'll just need to write your own commands. Here's an example command:

-
let Command = require('yamdbf').Command;
-
-exports.default = class Ping extends Command
-{
-    constructor(bot)
-    {
-        super(bot, {
-            name: 'ping',
-            aliases: ['p'],
-            description: 'Pong!',
-            usage: '<prefix>ping',
-            extraHelp: 'A basic ping/pong command example.',
-            group: 'example',
-            guildOnly: false,
-            permissions: [],
-            roles: [],
-            ownerOnly: false
-        });
-    }
-
-    action(message, args, mentions, original) // eslint-disable-line no-unused-vars
-    {
-        message.reply('Pong!');
-    }
-};

It should be noted that command actions have access to the Discord.js Client instance via this.bot.

-

That's about it for creating a bot and adding commands. If you don't want to have to copy and paste templates all the time or look at them for examples, a Yeoman generator has been written that can be used for creating new bot projects and new commands from the command line. It's very handy!

-

Links

-
- - - - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-Bot.html b/docs/module-Bot.html deleted file mode 100644 index 6f546d9c..00000000 --- a/docs/module-Bot.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - Bot - Documentation - - - - - - - - - - - - - - - - - -
- -

Bot

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-Command.html b/docs/module-Command.html deleted file mode 100644 index 9f3771c4..00000000 --- a/docs/module-Command.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - Command - Documentation - - - - - - - - - - - - - - - - - -
- -

Command

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-CommandDispatcher.html b/docs/module-CommandDispatcher.html deleted file mode 100644 index 4602145d..00000000 --- a/docs/module-CommandDispatcher.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - CommandDispatcher - Documentation - - - - - - - - - - - - - - - - - -
- -

CommandDispatcher

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-CommandLoader.html b/docs/module-CommandLoader.html deleted file mode 100644 index a239a8c5..00000000 --- a/docs/module-CommandLoader.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - CommandLoader - Documentation - - - - - - - - - - - - - - - - - -
- -

CommandLoader

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-CommandRegistry.html b/docs/module-CommandRegistry.html deleted file mode 100644 index 26ca9f60..00000000 --- a/docs/module-CommandRegistry.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - CommandRegistry - Documentation - - - - - - - - - - - - - - - - - -
- -

CommandRegistry

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-GuildStorage.html b/docs/module-GuildStorage.html deleted file mode 100644 index 610f8d53..00000000 --- a/docs/module-GuildStorage.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - GuildStorage - Documentation - - - - - - - - - - - - - - - - - -
- -

GuildStorage

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-GuildStorageLoader.html b/docs/module-GuildStorageLoader.html deleted file mode 100644 index 463db389..00000000 --- a/docs/module-GuildStorageLoader.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - GuildStorageLoader - Documentation - - - - - - - - - - - - - - - - - -
- -

GuildStorageLoader

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-GuildStorageRegistry.html b/docs/module-GuildStorageRegistry.html deleted file mode 100644 index f07541ef..00000000 --- a/docs/module-GuildStorageRegistry.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - GuildStorageRegistry - Documentation - - - - - - - - - - - - - - - - - -
- -

GuildStorageRegistry

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-LocalStorage.html b/docs/module-LocalStorage.html deleted file mode 100644 index addd4738..00000000 --- a/docs/module-LocalStorage.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - LocalStorage - Documentation - - - - - - - - - - - - - - - - - -
- -

LocalStorage

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-Util.html b/docs/module-Util.html deleted file mode 100644 index a606468f..00000000 --- a/docs/module-Util.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - Util - Documentation - - - - - - - - - - - - - - - - - -
- -

Util

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - -

- (static) .normalize(text) → {string} -

- - - - -
- -
- Returns the given string lowercased with any non -alphanumeric chars removed -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
text - - -
string
 - - - - - 		Text to normalize
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - - -

- (static) .padRight(text, length) → {string} -

- - - - -
- -
- Pads the right side of a string with spaces to the given length -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
text - - -
string
 - - - - - 		Text to pad
length - - -
number
 - - - - - 		Length to pad to
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - -
- -
- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - -

- (static) .normalize(text) → {string} -

- - - - -
- -
- Returns the given string lowercased with any non -alphanumeric chars removed -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
text - - -
string
 - - - - - 		Text to normalize
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - - -

- (static) .padRight(text, length) → {string} -

- - - - -
- -
- Pads the right side of a string with spaces to the given length -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
text - - -
string
 - - - - - 		Text to pad
length - - -
number
 - - - - - 		Length to pad to
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -Returns: - - - - - -
-
string
 - - - - - - - - - -
- - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/module-version.html b/docs/module-version.html deleted file mode 100644 index c2149918..00000000 --- a/docs/module-version.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - version - Documentation - - - - - - - - - - - - - - - - - -
- -

version

- - - - - - - -
- -
- - - -
- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js deleted file mode 100644 index 8d52f7ea..00000000 --- a/docs/scripts/linenumber.js +++ /dev/null @@ -1,25 +0,0 @@ -/*global document */ -(function() { - var source = document.getElementsByClassName('prettyprint source linenums'); - var i = 0; - var lineNumber = 0; - var lineId; - var lines; - var totalLines; - var anchorHash; - - if (source && source[0]) { - anchorHash = document.location.hash.substring(1); - lines = source[0].getElementsByTagName('li'); - totalLines = lines.length; - - for (; i < totalLines; i++) { - lineNumber++; - lineId = 'line' + lineNumber; - lines[i].id = lineId; - if (lineId === anchorHash) { - lines[i].className += ' selected'; - } - } - } -})(); diff --git a/docs/scripts/prettify/Apache-License-2.0.txt b/docs/scripts/prettify/Apache-License-2.0.txt deleted file mode 100644 index d6456956..00000000 --- a/docs/scripts/prettify/Apache-License-2.0.txt +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/docs/scripts/prettify/lang-css.js b/docs/scripts/prettify/lang-css.js deleted file mode 100644 index 041e1f59..00000000 --- a/docs/scripts/prettify/lang-css.js +++ /dev/null @@ -1,2 +0,0 @@ -PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", -/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/docs/scripts/prettify/prettify.js b/docs/scripts/prettify/prettify.js deleted file mode 100644 index eef5ad7e..00000000 --- a/docs/scripts/prettify/prettify.js +++ /dev/null @@ -1,28 +0,0 @@ -var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; -(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= -[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), -l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, -q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, -q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, -"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), -a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} -for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], -"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], -H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], -J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ -I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), -["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", -/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), -["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", -hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= -!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p ul { - padding: 0 10px; -} - -nav > ul > li > a { - color: #000; -} - -nav ul ul { - margin-bottom: 10px -} - -nav ul ul a { - color: hsl(207, 1%, 60%); - border-left: 1px solid hsl(207, 10%, 86%); -} - -nav ul ul a, -nav ul ul a:active { - padding-left: 20px -} - -nav h2 { - font-size: 12px; - margin: 0; - padding: 0; -} - -nav > h2 > a { - display: block; - margin: 10px 0 -10px; - color: hsl(202, 71%, 50%) !important; -} - -footer { - color: hsl(0, 0%, 28%); - margin-left: 250px; - display: block; - padding: 15px; - font-style: italic; - font-size: 90%; -} - -.ancestors { - color: #999 -} - -.ancestors a { - color: #999 !important; - text-decoration: none; -} - -.clear { - clear: both -} - -.important { - font-weight: bold; - color: #950B02; -} - -.yes-def { - text-indent: -1000px -} - -.type-signature { - color: #aaa -} - -.name, .signature { - font-family: Consolas, Monaco, 'Andale Mono', monospace -} - -.details { - margin-top: 14px; - /*border-left: 2px solid #DDD;*/ - line-height: 30px; -} - -.details dt { - /*width: 120px;*/ - float: left; - padding-left: 0px; -} - -.details dd { - margin-left: 0px -} - -.details ul { - margin: 0 -} - -.details ul { - list-style-type: none -} - -.details li { - margin-left: 30px -} - -.details pre.prettyprint { - margin: 0 -} - -.details .object-value { - padding-top: 0 -} - -.description { - margin-bottom: 1em; - margin-top: 1em; -} - -.code-caption { - font-style: italic; - font-size: 107%; - margin: 0; -} - -.prettyprint { - font-size: 13px; - border: 1px solid #ddd; - border-radius: 3px; - box-shadow: 0 1px 3px hsla(0, 0%, 0%, 0.05); - overflow: auto; -} - -.prettyprint.source { - width: inherit -} - -.prettyprint code { - font-size: 100%; - line-height: 18px; - display: block; - margin: 0 30px; - background-color: #fff; - color: #4D4E53; -} - -.prettyprint > code { - padding: 15px -} - -.prettyprint .linenums code { - padding: 0 15px -} - -.prettyprint .linenums li:first-of-type code { - padding-top: 15px -} - -.prettyprint code span.line { - display: inline-block -} - -.prettyprint.linenums { - padding-left: 70px; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -.prettyprint.linenums ol { - padding-left: 0 -} - -.prettyprint.linenums li { - border-left: 3px #ddd solid -} - -.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * { - background-color: lightyellow -} - -.prettyprint.linenums li * { - -webkit-user-select: text; - -moz-user-select: text; - -ms-user-select: text; - user-select: text; -} - -.params, .props { - border-spacing: 0; - border: 1px solid #ddd; - border-collapse: collapse; - border-radius: 3px; - box-shadow: 0 1px 3px rgba(0,0,0,0.1); - width: 100%; - font-size: 14px; -} - -.params .name, .props .name, .name code { - color: #4D4E53; - font-family: Consolas, Monaco, 'Andale Mono', monospace; - font-size: 100%; -} - -.params td, .params th, .props td, .props th { - margin: 0px; - text-align: left; - vertical-align: top; - padding: 10px; - display: table-cell; -} - -.params td { - border-top: 1px solid #eee -} - -.params thead tr, .props thead tr { - background-color: #fff; - font-weight: bold; -} - -.params .params thead tr, .props .props thead tr { - background-color: #fff; - font-weight: bold; -} - -.params td.description > p:first-child, .props td.description > p:first-child { - margin-top: 0; - padding-top: 0; -} - -.params td.description > p:last-child, .props td.description > p:last-child { - margin-bottom: 0; - padding-bottom: 0; -} - -dl.param-type { - border-bottom: 1px solid hsl(0, 0%, 87%); - margin-bottom: 30px; - padding-bottom: 30px; -} - -.param-type dt, .param-type dd { - display: inline-block; - margin-left: 0px; -} - -.param-type dd { - font-family: Consolas, Monaco, 'Andale Mono', monospace -} - -.disabled { - color: #454545 -} - -/* navicon button */ -.navicon-button { - display: none; - position: relative; - padding: 2.0625rem 1.5rem; - transition: 0.25s; - cursor: pointer; - user-select: none; - opacity: .8; -} -.navicon-button .navicon:before, .navicon-button .navicon:after { - transition: 0.25s; -} -.navicon-button:hover { - transition: 0.5s; - opacity: 1; -} -.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after { - transition: 0.25s; -} -.navicon-button:hover .navicon:before { - top: .825rem; -} -.navicon-button:hover .navicon:after { - top: -.825rem; -} - -/* navicon */ -.navicon { - position: relative; - width: 2.5em; - height: .3125rem; - background: #000; - transition: 0.3s; - border-radius: 2.5rem; -} -.navicon:before, .navicon:after { - display: block; - content: ""; - height: .3125rem; - width: 2.5rem; - background: #000; - position: absolute; - z-index: -1; - transition: 0.3s 0.25s; - border-radius: 1rem; -} -.navicon:before { - top: .625rem; -} -.navicon:after { - top: -.625rem; -} - -/* open */ -.nav-trigger:checked + label:not(.steps) .navicon:before, -.nav-trigger:checked + label:not(.steps) .navicon:after { - top: 0 !important; -} - -.nav-trigger:checked + label .navicon:before, -.nav-trigger:checked + label .navicon:after { - transition: 0.5s; -} - -/* Minus */ -.nav-trigger:checked + label { - transform: scale(0.75); -} - -/* × and + */ -.nav-trigger:checked + label.plus .navicon, -.nav-trigger:checked + label.x .navicon { - background: transparent; -} - -.nav-trigger:checked + label.plus .navicon:before, -.nav-trigger:checked + label.x .navicon:before { - transform: rotate(-45deg); - background: #FFF; -} - -.nav-trigger:checked + label.plus .navicon:after, -.nav-trigger:checked + label.x .navicon:after { - transform: rotate(45deg); - background: #FFF; -} - -.nav-trigger:checked + label.plus { - transform: scale(0.75) rotate(45deg); -} - -.nav-trigger:checked ~ nav { - left: 0 !important; -} - -.nav-trigger:checked ~ .overlay { - display: block; -} - -.nav-trigger { - position: fixed; - top: 0; - clip: rect(0, 0, 0, 0); -} - -.overlay { - display: none; - position: fixed; - top: 0; - bottom: 0; - left: 0; - right: 0; - width: 100%; - height: 100%; - background: hsla(0, 0%, 0%, 0.5); - z-index: 1; -} - -@media only screen and (min-width: 320px) and (max-width: 680px) { - body { - overflow-x: hidden; - } - - nav { - background: #FFF; - width: 250px; - height: 100%; - position: fixed; - top: 0; - right: 0; - bottom: 0; - left: -250px; - z-index: 3; - padding: 0 10px; - transition: left 0.2s; - } - - .navicon-button { - display: inline-block; - position: fixed; - top: 1.5em; - right: 0; - z-index: 2; - } - - #main { - width: 100%; - min-width: 360px; - } - - #main h1.page-title { - margin: 1em 0; - } - - #main section { - padding: 0; - } - - footer { - margin-left: 0; - } -} diff --git a/docs/styles/prettify-jsdoc.css b/docs/styles/prettify-jsdoc.css deleted file mode 100644 index 834a866d..00000000 --- a/docs/styles/prettify-jsdoc.css +++ /dev/null @@ -1,111 +0,0 @@ -/* JSDoc prettify.js theme */ - -/* plain text */ -.pln { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* string content */ -.str { - color: hsl(104, 100%, 24%); - font-weight: normal; - font-style: normal; -} - -/* a keyword */ -.kwd { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a comment */ -.com { - font-weight: normal; - font-style: italic; -} - -/* a type name */ -.typ { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* a literal value */ -.lit { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* punctuation */ -.pun { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* lisp open bracket */ -.opn { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* lisp close bracket */ -.clo { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a markup tag name */ -.tag { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a markup attribute name */ -.atn { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a markup attribute value */ -.atv { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a declaration */ -.dec { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a variable name */ -.var { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* a function name */ -.fun { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; -} diff --git a/docs/styles/prettify-tomorrow.css b/docs/styles/prettify-tomorrow.css deleted file mode 100644 index 81e74d13..00000000 --- a/docs/styles/prettify-tomorrow.css +++ /dev/null @@ -1,132 +0,0 @@ -/* Tomorrow Theme */ -/* Original theme - https://github.com/chriskempson/tomorrow-theme */ -/* Pretty printing styles. Used with prettify.js. */ -/* SPAN elements with the classes below are added by prettyprint. */ -/* plain text */ -.pln { - color: #4d4d4c; } - -@media screen { - /* string content */ - .str { - color: hsl(104, 100%, 24%); } - - /* a keyword */ - .kwd { - color: hsl(240, 100%, 50%); } - - /* a comment */ - .com { - color: hsl(0, 0%, 60%); } - - /* a type name */ - .typ { - color: hsl(240, 100%, 32%); } - - /* a literal value */ - .lit { - color: hsl(240, 100%, 40%); } - - /* punctuation */ - .pun { - color: #000000; } - - /* lisp open bracket */ - .opn { - color: #000000; } - - /* lisp close bracket */ - .clo { - color: #000000; } - - /* a markup tag name */ - .tag { - color: #c82829; } - - /* a markup attribute name */ - .atn { - color: #f5871f; } - - /* a markup attribute value */ - .atv { - color: #3e999f; } - - /* a declaration */ - .dec { - color: #f5871f; } - - /* a variable name */ - .var { - color: #c82829; } - - /* a function name */ - .fun { - color: #4271ae; } } -/* Use higher contrast and text-weight for printable form. */ -@media print, projection { - .str { - color: #060; } - - .kwd { - color: #006; - font-weight: bold; } - - .com { - color: #600; - font-style: italic; } - - .typ { - color: #404; - font-weight: bold; } - - .lit { - color: #044; } - - .pun, .opn, .clo { - color: #440; } - - .tag { - color: #006; - font-weight: bold; } - - .atn { - color: #404; } - - .atv { - color: #060; } } -/* Style */ -/* -pre.prettyprint { - background: white; - font-family: Consolas, Monaco, 'Andale Mono', monospace; - font-size: 12px; - line-height: 1.5; - border: 1px solid #ccc; - padding: 10px; } -*/ - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; } - -/* IE indents via margin-left */ -li.L0, -li.L1, -li.L2, -li.L3, -li.L4, -li.L5, -li.L6, -li.L7, -li.L8, -li.L9 { - /* */ } - -/* Alternate shading for lines */ -li.L1, -li.L3, -li.L5, -li.L7, -li.L9 { - /* */ } diff --git a/docs/tutorial-NoCommandErrors.html b/docs/tutorial-NoCommandErrors.html deleted file mode 100644 index 6d1e3de5..00000000 --- a/docs/tutorial-NoCommandErrors.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Documentation - - - - - - - - - - - - - - - - - -
- -

- - -
- -
- - -

Not getting Command errors?

-
- -
-

If you're not receiving any error output from your commands and you are writing your commands without babel following the example on the main page, this is because error catching is handled in the pre-compiled code via a Promise catch. This doesn't translate well to non-babel code if you're using the example command as a base due to the Command action not being declared as async. Because commands are executed within a promise via async, they are effectively sandboxed so errors within your commands won't crash your bot but without access to that Promise catch, you won't see anything either.

-

If you're not receiving errors from your commands as a result of this, until async/await is implemented in Node, the best course of action is to surround the content of your Command action in a try/catch block. I'll demonstrate using the same ping command example from the main page.

-
let Command = require('yamdbf').Command;
-
-exports.default = class Ping extends Command
-{
-    constructor(bot)
-    {
-        super(bot, {
-            name: 'ping',
-            aliases: ['p'],
-            description: 'Pong!',
-            usage: '<prefix>ping',
-            extraHelp: 'A basic ping/pong command example.',
-            group: 'example',
-            guildOnly: false,
-            permissions: [],
-            roles: [],
-            ownerOnly: false
-        });
-    }
-
-    action(message, args, mentions, original) // eslint-disable-line no-unused-vars
-    {
-        try
-        {
-            message.reply('Pong!');
-        }
-        catch (err)
-        {
-            console.error(err);
-        }
-    }
-};

Just remember that despite not having access to async without babel, commands are still being executed asynchronously by the framework, and even still would be just by the fact that they're being dispatched from within the 'message' event handler.

-

I'll make sure to make a big announcement when async/await can be used for writing commands with YAMDBF. In the meantime, this will have to do if you don't want to have to use babel to write commands with async in mind and want to be able to catch errors when debugging your commands.

-
- -
- -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/tutorial-UsingBotStorage.html b/docs/tutorial-UsingBotStorage.html deleted file mode 100644 index af86e2f8..00000000 --- a/docs/tutorial-UsingBotStorage.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Documentation - - - - - - - - - - - - - - - - - -
- -

- - -
- -
- - -

Using bot-specific storage

-
- -
-

Using the bot's default persistent storage is very easy, but it should be noted that this storage is universal, unlike guild-specific storage. If you want to use storage for values specific to an individual guild, you should head on over to Using guild-specific storage.

-

The bot's default storage can be accessed via storage property of the Bot instance. We'll assume here that you're going to be accessing the storage from within a command action, and thus have access to the Bot instance via this.bot:

-
let storage = this.bot.storage;

We'll be using this storage variable for the rest of the examples.

-

Storing values

Storing values is done with the setItem() method. Let's say we know the storage contains the key 'foo'. We want to assign the vale 'bar' to the key 'foo' in storage:

-
storage.setItem('foo', 'bar');

If you only need to interact when storage once, there's no need to load the storage into a variable first. You can interact with storage directly, in-line, like so:

-
this.bot.storage.setItem('foo', 'bar');

It should be noted that if a key does not exist in storage it will be created when using setItem().

-

Retrieving and modifying values

Earlier we set the value of the key 'foo', so now we'll pull it back out of storage.

-
let foo = storage.getItem('foo');
-// foo === 'bar'
-
-// Now we'll modify it:
-
-storage.setItem('foo', 'boo');
-foo = storage.getItem('foo');
-// foo === 'boo'

Storing and modifying stored objects

Objects can be placed in storage just as easily as any other value, but modifying them requires a little extra effort. You'll need to pull the object out of storage, modify it, and then put it back in:

-
let oldObject = {
-    foo: 'bar',
-    bar: 'baz'
-}
-
-storage.setItem('object', oldObject);
-
-// Now, let's modify it!
-
-let newObject = storage.getItem('object');
-newObject.foo = 'boo';
-storage.setItem('object', newObject);
-console.log(storage.getItem('object'));
-// logs: { foo: 'boo', bar: 'baz' }

Of course, you can store Arrays as well:

-
let array = ['foo', 'bar'];
-
-storage.setItem('array', array);
-
-let newArray = storage.getItem('array')
-newArray.push('baz');
-storage.setItem('array', newArray);
-console.log(storage.getItem('array'));
-// logs: ['foo', 'bar', 'baz']

As far as the basics of storage go, that's about it. Make sure to check out LocalStorage to read up on the methods available for interacting with storages using the LocalStorage class. You can even declare your own storages separate from the bot's default storage. The docs should point you in the right direction for this, but as always you can ask questions on the YAMDB Discord server if you have any.

-

If you haven't already, take a look at Using guild-specific storage to read up on using guild-specific storages in your bot.

-
- -
- -
- -
- - - - - - - \ No newline at end of file diff --git a/docs/tutorial-UsingGuildStorage.html b/docs/tutorial-UsingGuildStorage.html deleted file mode 100644 index f21b205d..00000000 --- a/docs/tutorial-UsingGuildStorage.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Documentation - - - - - - - - - - - - - - - - - -
- -

- - -
- -
- - -

Using guild-specific storage

-
- -
-

So you want to store some stuff for a specific guild. The most likely occurrence of this is a user calling a command that requires interacting guild-specific data, either storing or retrieving. Accessing guild specific data from within a command is really easy because you have access to the guild in question via the Message object passed to the command under the message parameter.

-

Because message contains a guild, we can use it to find the GuildStorage for that guild. If you have a lot of separate items you want to set in storage for a guild, it may be easiest to load the guild storage into a local variable:

-
let guildStorage = this.bot.guildStorages.get(message.guild);

We will be using this guildStorage variable for the remainder of this example page.

-

Storing values

Storing values is done using the setItem() method. -Let's say we know the storage for this guild contains the key 'foo'. We want to assign the value 'bar' to the key 'foo' in this guild's storage:

-
guildStorage.setItem('foo', 'bar');

Now that was easy! If you only need to set the one item in storage there's no need to load the guildStorage into a local variable. You can interact with the storage directly, in-line, like so:

-
this.bot.guildStorages.get(message.guild).setItem('foo', 'bar');

It should be noted that if a key does not yet exist in storage, it will be created when using setItem().

-

Retrieving values

Retrieving values from a guild's storage is just as easy as setting them. Assuming you still have the guild storage loaded into a local variable as demonstrated earlier, use getItem():

-
let foo = guildStorage.getItem('foo');
-// foo === 'bar'

This can also be done in-line as before in the storing values example.

-

Interacting with guild settings

In addition to guild-specific storage, every guild has settings within its own storage that are able to be interacted with via different methods than regular guild storage. See: GuildStorage for more information.

-

Interacting with settings values is just as easy as interacting with storage values. Settings are keys that have default values that are applied to all new guilds whenever the bot is added to a guild. New default settings can also be added -to all guilds which can then, of course, be changed per guild as code that interacts with those settings is run.

-

For this example we'll use the 'prefix' setting, and we'll be ignoring the fact that there's a shortcut to access the prefix value via this.bot.getPrefix(<guild>).

-
let prefix = guildStorage.getSetting('prefix');
-// prefix === '/' by default. This can of course be changed

And of course, to set the value:

-
let newPrefix = '+';
-guildStorage.setSetting('prefix', newPrefix);
-console.log(guildStorage.getSetting('prefix'));
-// logs: +

Storing Objects

Objects can be stored in guild-specific storage just as easily as any other value, but modifying them requires a little extra effort. You'll need to pull the object out of storage, modify it, and then put it back in:

-
let oldObject = {
-    foo: 'bar',
-    bar: 'baz'
-}
-
-guildStorage.setItem('object', oldObject);
-
-// Now, let's modify it!
-
-let newObject = guildStorage.getItem('object');
-newObject.foo = 'boo';
-guildStorage.setItem('object', newObject);
-console.log(guildStorage.getItem('object'));
-// logs: { foo: 'boo', bar: 'baz' }

And that's about it for using guild specific storage! There is so much that can be done by utilizing guild-specific data but it's up to find your own uses for it! Don't forget to check out the docs for GuildStorage to read up on all the methods available for interacting with guild-specific storage and settings. It would also be good to read Using bot-specific storage if you haven't already. Knowing the applications and differences between the two storages will leave you with a pretty handy tool for writing your bots!

-
- -
- -
- -
- - - - - - - \ No newline at end of file diff --git a/package.json b/package.json index 61425e37..15a35935 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "rebuild": "gulp clean && gulp build", "package": "gulp clean-package && gulp package", "tag-release": "gulp tag-release", - "docs": "jsdoc -R README.md -c .jsdoc.json -u examples -r src && jsdoc -c .jsdoc.json -t templates/haruki -r src -d console > docs/docs.json", + "docs": "jsdoc -R README.md -c .jsdoc.json -u examples -r src && jsdoc -c .jsdoc.json -t templates/haruki -r src -d console > ../yamdbf-docs/docs.json", "lint": "eslint ./src/", "lint-typings": "tslint typings/index.d.ts" }, diff --git a/src/lib/storage/GuildStorage.js b/src/lib/storage/GuildStorage.js index 670f0fc2..016923a6 100644 --- a/src/lib/storage/GuildStorage.js +++ b/src/lib/storage/GuildStorage.js @@ -297,8 +297,8 @@ export default class GuildStorage /** * Allow access to a storage/settings item only when it is not currently being - * accessed. Waits for other nonConcurrentAccess operations to finish - * before proceeding with callback + * accessed. Waits for other queued operations to finish before proceeding + * with the supplied callback * @memberof GuildStorage * @instance * @param {string} key - the storage key you will be accessing diff --git a/src/lib/storage/LocalStorage.js b/src/lib/storage/LocalStorage.js index 99622ca2..556f00c6 100644 --- a/src/lib/storage/LocalStorage.js +++ b/src/lib/storage/LocalStorage.js @@ -180,8 +180,8 @@ export default class LocalStorage /** * Allow access to a storage item only when it is not currently being - * accessed. Waits for other nonConcurrentAccess operations to finish - * before proceeding with callback + * accessed. Waits for other queued operations to finish before + * proceeding with the provided callback * @memberof LocalStorage * @instance * @param {string} key - the storage key you will be accessing