Module: chat

Broadcasts passed `text` field to the calling users channel
Version:
  • 1.0.0
Author:
  • Marzavec ( https://github.com/marzavec )
Source:

Methods

(static) commandCheckIn(env)

Executes every time an incoming chat command is invoked; checks for miscellaneous '/' based commands
Parameters:
Name Type Description
env Object Enviroment object with references to core, server, socket & payload
Source:
Returns:

(static) finalCmdCheck(env)

Executes every time an incoming chat command is invoked; assumes a failed chat command invocation and will reject with notice
Parameters:
Name Type Description
env Object Enviroment object with references to core, server, socket & payload
Source:
Returns:

(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

Type Definitions

chat/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:

chat/requiredData

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