Locks a channel preventing default levels from joining
- Version:
- 1.0.0
- Source:
Methods
(static) changeNickCheck(env) → {Object|boolean|string}
Executes every time an incoming changenick command is invoked;
hook incoming changenick commands, reject them if the channel is 'purgatory'
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
(static) chatCheck(env) → {Object|boolean|string}
Executes every time an incoming chat command is invoked;
hook incoming chat commands, reject them if the channel is 'purgatory'
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
(static) init(core) → {void}
Automatically executes once after server is ready
Parameters:
| Name | Type | Description |
|---|---|---|
core |
Object | Reference to core enviroment 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 enviroment object |
- Source:
Returns:
- Type
- void
(static) inviteCheck(env) → {Object|boolean|string}
Executes every time an incoming invite command is invoked;
hook incoming invite commands, reject them if the channel is 'purgatory'
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
(static) joinCheck(env) → {Object|boolean|string}
Executes every time an incoming join command is invoked;
hook incoming join commands, shunt them to purgatory if needed
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
(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 whisper command is invoked;
hook incoming whisper commands, reject them if the channel is 'purgatory'
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
kick/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: