The "e" object

What's e?

e is the name of the object given to a command when it's executed. It's constructor is DiscordBotMessage. This is the most important object, and the one you'll use to access almost everything on the API. It contains information about the message that triggered your command, including user ID, server ID, channel ID, database access, and your constructed plugin.

There are several helper functions that make it very easy to respond to the message. These messages go on a queue, and are guaranteed to arrive in order.

e structure

These are all of the properties of the e object, with some basic info:

{
    "_disco": "object", // DiscordBot object
    "_mod": "string", // your plugin's name
    "mod": "object", // constructed object from your plugin
    "serverID": "string", // server this message was sent on
    "user": "string", // user name
    "userID": "string", //user ID
    "channelID": "string", // channel ID
    "message": "string", // the full message, unaltered
    "rawEvent": "object", // the rawEvent object received from Discord.io
    "db": "object", // database access object
    "activator": "string", // the bot's name on the current server, e.g., "bot" in "bot say hi"
    "globalActivator": "string", // the bot's name when not on a server (serverID = 0)
    "_prepend": "string", // helper string, used by the response functions
    "respond": "function", // send a text message
    "respondFile": "function", // send a file
    "mention": "function", // generate a mention
    "text": "function", // add text
    "code": "function", // add a code block
    "n": "function", // add a new line
    "getName": "function", // returns the name from an uid
    "getUser": "function", // returns the user object on the current server, from Discord.io
    "editMessage": "function", // edit a message by it's ID and channel
    "getMod": "function", // returns the constructed object of another plugin
    "command": "function", // executes a command by it's string
    "deleteMessage": "function", // delete a message by id and channelID
    "getRoles": "function", // returns user roles
    "getRole": "function", // returns Discord.io role object
    "roleName": "function" // returns the name of a role
}

_disco

The DiscordBot object. Contains the command register, parsers, plugin manager, and all of the processing

Accessing this object directly is not recommended.

_mod

The name of your plugin, which is the same as it's folder name.

mod

Your plugin object. Constructed once by calling new require("pluginName").init(e, callback).

You can store volatile information by setting it upon construction, and access it from any command. Using global variables within your plugin is not recommended. Store them on this object, and access it later.

serverID

The server ID where this message was sent. If this is a private message, this will be "0" instead.

user

The user's name

userID

The user's ID

channelID

You guessed it, the channel ID

message

The full message, as sent by the user.

rawEvent

The Discord.io raw event

May be an empty object if this command didn't originate from a message (e.g., called by e.command())

db

The Database Access object

activator

The bot's 'name' on the current channel

globalActivator

The bot's 'name' on global channels

_prepend

The current "buffer", used by the following functions to send messages

respond([message, [callback]])

If message if a string, sends _prepend + message on the channelID. Clears _prepend.

All callbacks are of the form callback(err, results), and the same as here

returns: e. This means you can chain these functions by doing e.mention().respond("Hello");

respondFile(file, [callback])

Sends a file on the current channel, and clears _prepend. file should be a string

returns: e

mention([uid])

Makes

_prepend += `<@${uid}> `;

If uid is not given, uses e.userID.

returns: e

text([message])

_prepend += message;

returns: e

code(message, [lang])

Generates a code block.

_prepend += "\```" + (lang || "") + "\n" + message + "\n\```"

returns: e

n()

Adds a new line.

returns: e

getName(uid)

Returns the username of UID.

getUser(uid, sid)

Returns the user object on server sid. Make uid = undefined to default to e.userID

editMessage(id, channelID, newMessage, [callback])

Edits a message. Make channelID = undefined to default to e.channelID.

You can get the id from a response callback (response.id).

getMod(mod)

Returns the plugin object of mod, or undefined if not there.

command(command, [rawEvent])

Executes a command as e.user on the current channel. Note that this may fail if the user doesn't have permission.

If you set rawEvent._extend, you can replace properties on the e object sent to the command.

rawEvent = {
    _extend: {
         mod: e.mod
    }
}

This is used by the live api to modify the response function on the passed e.

deleteMessage([id, channelID, callback]) or deleteMessage(callback)

Deletes a message. If the first param is a function, deletes the message referenced by e.

returns: e

getRoles([uid, [sid]])

Returns the role objects for this user.

getRole(rid, [sid])

Returns the role object for this ID.

roleName(rid, [sid])

Returns only the role name.