Module: whisper

Display text on target users screen that only they can see
Version:
  • 1.0.0
Author:
  • Marzavec ( https://github.com/marzavec )
Source:
To Do:
  • This should be changed to it's own event type, instead of `info` and accept a `userid` rather than `nick`

Methods

(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 enviroment object
Source:
Returns:
Type
void

(static) run(env) → {void}

Executes when invoked by a remote client
Parameters:
Name Type Description
env Object Enviroment 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; hooks chat commands checking for /whisper
Parameters:
Name Type Description
env Object Enviroment 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

whisper/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
usage string Information about module usage
Source:

whisper/requiredData

The following payload properties are required to invoke this module: "nick", "text"
Type:
  • Array
Source: