Class: Settings

ModLog~ Settings


new Settings()

Create default settings.
Source:

Members


<nullable> channel :string

The channel ID of where to send log messages.
Type:
  • string
Source:

logBans :boolean

Should the bot log when users are banned?
Type:
  • boolean
Source:

logKicks :boolean

Should the bot log when users are kicked?
Type:
  • boolean
Source:

logMemberJoin :boolean

Should the bot log when a user joins the guild?
Type:
  • boolean
Source:

logMemberLeave :boolean

Should the bot log when a user leaves the guild?
Type:
  • boolean
Source:

logMentionAbuse :boolean

Should the bot log when users abuse mentions?
Type:
  • boolean
Source:

logMessageBotDelete :boolean

Should the bot log when a bot message is deleted?
Type:
  • boolean
Source:

logMessageBotUpdate :boolean

Should the bot log when a bot's message is edited?
Type:
  • boolean
Source:

logMessageDelete :boolean

Should the bot log when a user's message is deleted?
Type:
  • boolean
Source:

logMessagePurge :boolean

Should the bot log when messages are purged?
Type:
  • boolean
Source:

logMessageUpdate :boolean

Should the bot log when a user's message is edited?
Type:
  • boolean
Source:

logMutes :boolean

Should the bot log when users are muted?
Type:
  • boolean
Source:

logOther :boolean

Log other actions that have not been classified.
Type:
  • boolean
Source:

logRaidLockdown :boolean

Should the bot log when a lockdown is started?
Type:
  • boolean
Source:

Methods


<static> from(obj)

Create a Settings object from a Settings-like object. Similar to copy-constructor.
Parameters:
Name Type Description
obj object Object to create a Settings object from.
Source:
Returns:
The created object.
Type
ModLog~Settings

check(action)

Check if the given action should be logged. Ignores if channel is set.
Parameters:
Name Type Description
action string The action to check if should log.
Source:
Returns:
True if should log.
Type
boolean