Monitor

Monitor are functions that are designed to watch incoming messages. These can range from checking a message for specific words, or logging all mentions to a channel.
Example

They will always follow this structure. 

exports.run = (client, msg) => { // code here };
exports.conf = {};

Members

static conf :Conf
documentation/MonitorStructure.js, line 41

An object that configures the monitor.
Example
exports.conf = {
   enabled: true,
   ignoreBots: true,
   ignoreSelf: true
 };

Methods

static run(client, msg)
documentation/MonitorStructure.js, line 19

The part of the monitor that will run on the message.
Parameters:
Name Type Description
client KomadaClient The Komada Client
msg Message A Message object obtained from discord.js
Example

This will create a monitor that logs every message that mentions the bot. 

exports.run = (client, msg, cmd) => {
  if (msg.mentions.users.has(client.user.id)) console.log(`Message ${msg.id} contained the bots mention: ${msg.cleanContent}`);
}

Type Definitions

Conf
documentation/MonitorStructure.js, line 22

An Object containing configuration values that will configure a monitor.
Properties:
Name Type Description
enabled Boolean Whether or not this monitor should be enabled for use.
ignoreBots Boolean Whether or not this monitor should ignore other bots.
ignoreSelf Boolean Whether or not this monitor should ignore messages from the ClientUser.