Custom Events

Table of Content

• CustomEvent Class
• Emitting Custom Events
  • Node.js / Discord.js Method
  • Aoi.js Function Method
• Example Usage of Custom Events

---

aoi.js has a built-in way to create Custom Events, these can be used for various things. This guide will be covering their usage, how they work, and an example.

CustomEvent Class

const { CustomEvent } = require("aoi.js");

const event = new CustomEvent(client); // Creates a new instance of the CustomEvent class, passing the "client" as an argument.

event.command({
    listen: "eventName", // This should represent the name of the event, in this case it is "eventName".
    code: `
    code
    ` // The code of the event that will be triggered once the event is emitted.
});

event.listen("eventName"); // This will make the client "listen" or in other words, wait for the event to be triggered. It does not trigger the event yet.

Emitting Custom Events

To emit a previously created custom event you have to options.

Node.js / Discord.js Method

You can use the native node.js method by using emit:

EventEmitter.emit(eventName, ...args);

Aoi.js Function Method

On the other side you have the aoi.js method with functions:

$eventEmit[eventName, ...args]

It would basically do the same as the node.js method.

---

Example Usage of Custom Events

const { AoiClient, LoadCommands, CustomEvent } = require("aoi.js");

const client = AoiClient({
    token: "DISCORD BOT TOKEN",
    prefix: "DISCORD BOT PREFIX",
    intents: ["MessageContent", "GuildMembers", "GuildMessages", "Guilds"],
    events: ["onMessage", "onInteractionCreate"],
    database: {
        type: "aoi.db",
        db: require("aoi.db"),
        tables: ["main"],
        path: "./database/",
        extraOptions: {
            dbType: "KeyValue"
        }
    }
});

const event = new CustomEvent(client);

event.command({
    listen: "log",
    code: `$log[Hello!] `
});

event.listen("log");

Inside of aoi.js command files or aoi.js related code you can use the $eventEmit & $eventData functions to interact with created events.

$eventEmit[log];

Would do the same as

event.emit("log");

Both emit the created log event, which causes Hello! to appear in your console.