Module: enablecaptcha

Enables the captcha on the channel specified in the channel property, default is current channel
Version:
  • 1.0.0
Author:
  • Marzavec ( https://github.com/marzavec )
Source:

Methods

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

Executes every time an incoming chat command is invoked; hook incoming chat commands, check if they are answering a captcha
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) joinCheck(env) → {Object|boolean|string}

Executes every time an incoming join command is invoked; hook incoming join commands, check if they are joining a captcha protected channel
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

Type Definitions

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