Module: dumb

Globally shadow mute a connection. Optional allies array will see muted messages.
Version:
  • 1.0.0
Author:
  • OpSimple ( https://github.com/OpSimple )
Source:

Methods

(static) chatCheck(env) → {Object|boolean|string}

Executes every time an incoming chat command is invoked; hook incoming chat commands, shadow-prevent chat if they are muzzled
Parameters:
Name Type Description
env Object Environment object with references to core, server, socket & payload
Source:
Returns:
Object = same/altered payload, false = suppress action, string = error
Type
Object | boolean | string

(static) init(core) → {void}

Automatically executes once after server is ready
Parameters:
Name Type Description
core Object Reference to core environment object
Source:
Returns:
Type
void

(static) initHooks(server) → {void}

Automatically executes once after server is ready to register this modules hooks
Parameters:
Name Type Description
server Object Reference to server environment object
Source:
Returns:
Type
void

(static) inviteCheck(env) → {Object|boolean|string}

Executes every time an incoming chat command is invoked; shadow-prevent all invites from muzzled users
Parameters:
Name Type Description
env Object Environment object with references to core, server, socket & payload
Source:
Returns:
Object = same/altered payload, false = suppress action, string = error
Type
Object | boolean | string

(static) run(env) → {void}

Executes when invoked by a remote client
Parameters:
Name Type Description
env Object Environment object with references to core, server, socket & payload
Source:
Returns:
Type
void

(static) whisperCheck(env) → {Object|boolean|string}

Executes every time an incoming chat command is invoked; shadow-prevent all whispers from muzzled users
Parameters:
Name Type Description
env Object Environment object with references to core, server, socket & payload
Source:
Returns:
Object = same/altered payload, false = suppress action, string = error
Type
Object | boolean | string

Type Definitions

dumb/info

Module meta information
Type:
  • Object
Properties:
Name Type Description
name string Module command name
category string Module category name
description string Information about module
aliases Array An array of alternative cmd names
usage string Information about module usage
Source: