SpikeyBot-Discord

Class: RaidBlock

RaidBlock

new RaidBlock()

Manages raid blocking commands and configuration.
Source:
Fires:
  • RaidBlock#event:shutdown
  • RaidBlock#event:lockdown
  • RaidBlock#event:action
Listens to Events:
  • Discord~Client#event:guildMemberAdd
  • Command#event:raid
  • Command#event:lockdown

Extends

Classes

RaidSettings

Members

<private> _events :object.<Array.<function()>>

All event handlers registered.
Type:
  • object.<Array.<function()>>
Default Value:
  • {}
Source:

<private> _settings :object.<RaidBlock~RaidSettings>

Guild settings for raids mapped by their guild id.
Type:
Default Value:
  • {}
Source:

<nullable> bot :SpikeyBot

The parent SpikeyBot instance. Defaults to required cache value for autocompletion, updates to current reference at init.
Type:
Inherited From:
Overrides:
Source:

client :Discord~Client

The current bot client. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord~Client
Inherited From:
Overrides:
Source:

command :Command

The command object for registering command listeners. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Overrides:
Source:

<constant> commit :string

The commit at HEAD at the time this module was loaded. Essentially the version of this submodule.
Type:
  • string
Inherited From:
Overrides:
Source:

common :Common

The common object. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Overrides:
Source:

Discord :Discord

The current Discord object instance of the bot. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord
Inherited From:
Overrides:
Source:

<abstract> helpMessage :undefined|string|Discord~EmbedBuilder

The help message to show the user in the main help message.
Type:
  • undefined | string | Discord~EmbedBuilder
Inherited From:
Overrides:
Source:

<protected, readonly> initialized :boolean

Has this subModule been initialized yet (Has begin() been called).
Type:
  • boolean
Inherited From:
Overrides:
Source:

<constant> loadTime :number

The time at which this module was loaded for use in checking if the module needs to be reloaded because the file has been modified since loading.
Type:
  • number
Inherited From:
Overrides:
Source:

<protected> myName :string

The name of this submodule. Used for differentiating in the log. Should be defined before begin().
Type:
  • string
Inherited From:
Overrides:
Source:

<abstract> postPrefix :string

The postfix for the global prefix for this subModule. Must be defined before begin(), otherwise it is ignored.
Type:
  • string
Inherited From:
Overrides:
Source:

Methods

<private> _commandLockdown(msg)

Initiate a server lockdown, or lift a current lockdown.
Parameters:
Name Type Description
msg Discord~Message Message that triggered command.
Source:
Listens to Events:
  • Command#event:lockdown
  • Command#event:raid

<private> _doAction(member, s)

Perform lockdown action on a member with given settings.
Parameters:
Name Type Description
member Discord~GuildMember Member to perform action on.
s RaidBlock~RaidSettings Guild settings for raids.
Source:

<private> _fire(event, args)

Fire an event on all handlers.
Parameters:
Name Type Argument Description
event string The event name to fire.
args * <repeatable>
 The arguments to pass to handlers.
Source:

<private> _formatDelay(msecs)

Format a duration in milliseconds into a human readable string.
Parameters:
Name Type Description
msecs number Duration in milliseconds.
Source:
Returns:
Formatted string.
Type
string

<private> _modLog(args)

Send a message to a guild's moderation channel (if configured), describing the action that took place.
Parameters:
Name Type Argument Description
args * <repeatable>
 The arguments to pass to ModLog.
Source:
See:

<private> _muteMember(member, cb)

Mute a discord guild member.
Parameters:
Name Type Description
member Discord~GuildMember Member to mute.
cb function Callback function.
Source:
See:
  • Moderation~muteMember

<private> _onGuildMemberAdd(member)

Handle a member being added to a guild.
Parameters:
Name Type Description
member Discord~GuildMember The guild member that was added to a guild.
Source:

begin(Discord, client, command, common, bot)

Initialize this submodule.
Parameters:
Name Type Description
Discord Discord The Discord object for the API library.
client Discord~Client The client that represents this bot.
command Command The command instance in which to register command listeners.
common Common Class storing common functions.
bot SpikeyBot The parent SpikeyBot instance.
Inherited From:
Overrides:
Source:

<protected> debug(msg)

Log using common.logDebug, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source:

end()

Trigger subModule to shutdown and get ready for process terminating.
Inherited From:
Overrides:
Source:

<protected> error(msg)

Log using common.error, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source:

getSettings(gId)

Get the settings for a guilds.
Parameters:
Name Type Description
gId string The ID of the guild to fetch.
Source:
Returns:
Reference to settings object. If it does not exist yet, it will first be created with defaults.
Type
RaidBlock~RaidSettings

<protected> initialize()

The function called at the end of begin() for further initialization specific to the subModule. Must be defined before begin() is called.
Inherited From:
Overrides:
Source:

<protected> log(msg)

Log using common.log, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source:

on(event, handler)

Register an event handler for a specific event. Fires the handler when the event occurs.
Parameters:
Name Type Description
event string Name of the event to listen for.
handler function Callback function handler to fire on the event.
Source:

<abstract> reloadable()

Check if this module is in a state that is ready to be reloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state. This is different from unloadable, which checks if this module can be stopped completely, this checks if the module can be stopped and restarted.
Inherited From:
Overrides:
Source:
See:
  • SubModule~unloadable
Returns:
True if can be reloaded, false if cannot.
Type
boolean

removeListener(event, handler)

Remove an event handler that was previously registered.
Parameters:
Name Type Description
event string Name of the event to listen for.
handler function Callback function handler to fire on the event.
Source:

save( [opt])

Saves all data to files necessary for saving current state.
Parameters:
Name Type Argument Default Description
opt string <optional>
 'sync' Can be 'async', otherwise defaults to synchronous.
Inherited From:
Overrides:
Source:

<protected> shutdown()

Shutdown and disable this submodule. Removes all event listeners.
Inherited From:
Overrides:
Source:

<abstract> unloadable()

Check if this module is in a state that is ready to be unloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state.
Inherited From:
Overrides:
Source:
See:
  • SubModule~reloadable
Returns:
True if can be unloaded, false if cannot.
Type
boolean

<protected> warn(msg)

Log using common.logWarning, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source: