Source: hg/actions/ChannelAction.js

// Copyright 2019 Campbell Crowley. All rights reserved.
// Author: Campbell Crowley (dev@campbellcrowley.com)
const Action = require('./Action.js');

/**
 * @description Handler function for a action to be performed on the game
 * channel.
 * @typedef HungryGames~Action~ChannelActionHandler
 * @type {Function}
 *
 * @param {HungryGames} hg HG context.
 * @param {HungryGames~GuildGame} game Game context.
 * @param {Discord~TextChannel} channel Channel context.
 */

/**
 * @description Action to perform on the channel where the game is taking place.
 *
 * @memberof HungryGames
 * @inner
 * @augments HungryGames~Action
 */
class ChannelAction extends Action {
  /**
   * @inheritdoc
   * @param {HungryGames~Action~ChannelActionHandler} handler Handler to
   * override.
   * @param {number} [delay=0] Delay calling the handler by this many
   * milliseconds after triggered.
   */
  constructor(handler, delay) {
    super(handler, delay);
  }
}

module.exports = ChannelAction;