StarMirror/hack-chat-main
1
0
Fork 0
mirror of https://github.com/hack-chat/main.git synced 2024-03-22 13:20:33 +08:00
Code Issues Projects Releases Wiki Activity
70ee8a7969
hack-chat-main/documentation/module-chat.html

1047 lines
12 KiB
HTML
Raw Normal View History

Latest dev sync
2022-06-23 00:32:51 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: chat</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: chat</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">Broadcasts passed `text` field to the calling users channel</div>
<dl class="details">
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>1.0.0</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Marzavec ( https://github.com/marzavec )</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".commandCheckIn"><span class="type-signature">(static) </span>commandCheckIn<span class="signature">(env)</span><span class="type-signature"></span></h4>
<div class="description">
Executes every time an incoming chat command is invoked;
checks for miscellaneous '/' based commands
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>env</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Enviroment object with references to core, server, socket & payload</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line118">line 118</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<h4 class="name" id=".finalCmdCheck"><span class="type-signature">(static) </span>finalCmdCheck<span class="signature">(env)</span><span class="type-signature"></span></h4>
<div class="description">
Executes every time an incoming chat command is invoked;
assumes a failed chat command invocation and will reject with notice
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>env</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Enviroment object with references to core, server, socket & payload</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line145">line 145</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<h4 class="name" id=".initHooks"><span class="type-signature">(static) </span>initHooks<span class="signature">(server)</span><span class="type-signature"> &rarr; {void}</span></h4>
<div class="description">
Automatically executes once after server is ready to register this modules hooks
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>server</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Reference to server enviroment object</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line104">line 104</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">void</span>
</dd>
</dl>
<h4 class="name" id=".run"><span class="type-signature">(static) </span>run<span class="signature">(env)</span><span class="type-signature"> &rarr; {void}</span></h4>
<div class="description">
Executes when invoked by a remote client
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>env</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Enviroment object with references to core, server, socket & payload</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">void</span>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="~chat/info">chat/info</h4>
<div class="description">
Module meta information
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Module command name</td>
</tr>
<tr>
<td class="name"><code>category</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Module category name</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Information about module</td>
</tr>
<tr>
<td class="name"><code>usage</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Information about module usage</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line177">line 177</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~chat/requiredData">chat/requiredData</h4>
<div class="description">
The following payload properties are required to invoke this module:
"text"
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_chat.js.html">core/chat.js</a>, <a href="core_chat.js.html#line169">line 169</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-addmod.html">addmod</a></li><li><a href="module-ban.html">ban</a></li><li><a href="module-changecolor.html">changecolor</a></li><li><a href="module-changenick.html">changenick</a></li><li><a href="module-chat.html">chat</a></li><li><a href="module-disconnect.html">disconnect</a></li><li><a href="module-dumb.html">dumb</a></li><li><a href="module-emote.html">emote</a></li><li><a href="module-forcecolor.html">forcecolor</a></li><li><a href="module-help.html">help</a></li><li><a href="module-invite.html">invite</a></li><li><a href="module-join.html">join</a></li><li><a href="module-kick.html">kick</a></li><li><a href="module-listusers.html">listusers</a></li><li><a href="module-morestats.html">morestats</a></li><li><a href="module-ping.html">ping</a></li><li><a href="module-reload.html">reload</a></li><li><a href="module-removemod.html">removemod</a></li><li><a href="module-saveconfig.html">saveconfig</a></li><li><a href="module-session.html">session</a></li><li><a href="module-shout.html">shout</a></li><li><a href="module-socketreply.html">socketreply</a></li><li><a href="module-speak.html">speak</a></li><li><a href="module-stats.html">stats</a></li><li><a href="module-unban.html">unban</a></li><li><a href="module-unbanall.html">unbanall</a></li><li><a href="module-whisper.html">whisper</a></li></ul>
</nav>
<br class="clear">
<footer>
four new modules
2023-12-22 15:14:03 +08:00
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 05 2022 00:29:35 GMT-0700 (Pacific Daylight Time)
Latest dev sync
2022-06-23 00:32:51 +08:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in New Issue Copy Permalink