Unlocks a channel allowing anyone to join
- Version:
- 1.0.0
- Source:
Methods
(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) 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
unlockroom/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: