Giter Club home page Giter Club logo

discord-r9k-framework's Introduction

discord-r9k

Framework for R9K and other bots.

Documentation

addMessageTrigger(trigger, callback)

trigger

A The trigger can be one of the following types:

  • String The callback will be triggered if the message matches the String exactly
  • RegExp If the message matches the RegExp, the callback will be triggered, the callback argument will include the list of matches returned by String.match()
  • Array All array elements are treated as separate triggers

callback

A function that will be called if the trigger is matched.

The callback has one argument, an object containing the following fields:

  • user the user that triggered this event
  • userId that users, id
  • channelId the id of the channel
  • message the message that triggered this event
  • matches any matches if the trigger was a regular expression
  • event the full event from discord.io that triggered this event
  • bot this discord.io client object, can be used to respond asynchronously

If the callback returns a String, it will be sent as a message to the channel this event was triggered from. If you want to respond to an event asynchronously, you can use the bot object to send a message.

addMessageTrigger('!someTrigger', (opts) => {
  returnsAPromise().then(result => opts.bot.sendMessage({
    message: result,
    to: opts.channelId,
  }));
});

Further reading

See the Discord developer docs, or the docs for discord.io, the library that powers this bot.

discord-r9k-framework's People

Contributors

sarencurrie avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.