aboutsummaryrefslogtreecommitdiff
path: root/doc/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.html')
-rw-r--r--doc/index.html423
1 files changed, 0 insertions, 423 deletions
diff --git a/doc/index.html b/doc/index.html
deleted file mode 100644
index 517b2c9..0000000
--- a/doc/index.html
+++ /dev/null
@@ -1,423 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-<head>
- <title>Reference</title>
- <link rel="stylesheet" href="ldoc.css" type="text/css" />
-</head>
-<body>
-
-<div id="container">
-
-<div id="product">
- <div id="product_logo"></div>
- <div id="product_name"><big><b></b></big></div>
- <div id="product_description"></div>
-</div> <!-- id="product" -->
-
-
-<div id="main">
-
-
-<!-- Menu -->
-
-<div id="navigation">
-<br/>
-<h1>Brok[en]gine</h1>
-
-
-<h2>Contents</h2>
-<ul>
-<li><a href="#Functions">Functions</a></li>
-<li><a href="#Tables">Tables</a></li>
-</ul>
-
-
-<h2>Modules</h2>
-<ul class="nowrap">
- <li><strong>net</strong></li>
-</ul>
-<h2>Topics</h2>
-<ul class="">
- <li><a href="topics/readme.md.html">readme</a></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>net</code></h1>
-<p>The net library
-Exposes various structs, constants, and functions for passing messages</p>
-<p></p>
-
-
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#stream:readint">stream:readint ()</a></td>
- <td class="summary">Read an integer from the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:readdouble">stream:readdouble ()</a></td>
- <td class="summary">Read double percision float from the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:readdata">stream:readdata (size)</a></td>
- <td class="summary">Read some data from the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:readstring">stream:readstring ()</a></td>
- <td class="summary">Read a string from the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:writeint">stream:writeint (i)</a></td>
- <td class="summary">Write an integer to the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:writedouble">stream:writedouble (d)</a></td>
- <td class="summary">Write a double percision float to the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:writedata">stream:writedata (d)</a></td>
- <td class="summary">Write some data to the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#stream:writestring">stream:writestring (s)</a></td>
- <td class="summary">Write a string to the stream</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#socket:bind">socket:bind (where)</a></td>
- <td class="summary"></td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#receive">receive (message, callback)</a></td>
- <td class="summary"></td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#newsocket">newsocket ()</a></td>
- <td class="summary"></td>
- </tr>
-</table>
-<h2><a href="#Tables">Tables</a></h2>
-<table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#socket">socket</a></td>
- <td class="summary"></td>
- </tr>
-</table>
-
-<br/>
-<br/>
-
-
- <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
- <dl class="function">
- <dt>
- <a name = "stream:readint"></a>
- <strong>stream:readint ()</strong>
- </dt>
- <dd>
- Read an integer from the stream
-
- </ul>
-
-
- <h3>Returns:</h3>
- <ol>
-
- <span class="types"><span class="type">number</span></span>
- The number read from the stream
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:readdouble"></a>
- <strong>stream:readdouble ()</strong>
- </dt>
- <dd>
- Read double percision float from the stream
-
- </ul>
-
-
- <h3>Returns:</h3>
- <ol>
-
- <span class="types"><span class="type">number</span></span>
- The number read from the stream
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:readdata"></a>
- <strong>stream:readdata (size)</strong>
- </dt>
- <dd>
- Read some data from the stream
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">size</span>
- <span class="types"><span class="type">number</span></span>
- The size of the data to read from the stream
- </li>
- </ul>
-
- <h3>Returns:</h3>
- <ol>
-
- <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
- The data read from the stream
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:readstring"></a>
- <strong>stream:readstring ()</strong>
- </dt>
- <dd>
- Read a string from the stream
-
- </ul>
-
-
- <h3>Returns:</h3>
- <ol>
-
- <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
- The string read from the stream
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:writeint"></a>
- <strong>stream:writeint (i)</strong>
- </dt>
- <dd>
- Write an integer to the stream
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">i</span>
- <span class="types"><span class="type">number</span></span>
- The integer to write to the stream
- </li>
- </ul>
-
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:writedouble"></a>
- <strong>stream:writedouble (d)</strong>
- </dt>
- <dd>
- Write a double percision float to the stream
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">d</span>
- <span class="types"><span class="type">number</span></span>
- The number to write to the stream
- </li>
- </ul>
-
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:writedata"></a>
- <strong>stream:writedata (d)</strong>
- </dt>
- <dd>
- Write some data to the stream
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">d</span>
- <span class="types"><span class="type">number</span></span>
- The number to write to the stream
- </li>
- </ul>
-
- <h3>Returns:</h3>
- <ol>
-
- <span class="types"><span class="type">number</span></span>
- The number of bytes written to the stream
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "stream:writestring"></a>
- <strong>stream:writestring (s)</strong>
- </dt>
- <dd>
- Write a string to the stream
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">s</span>
- <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
- The string to the stream
- </li>
- </ul>
-
-
-
-
-
-</dd>
- <dt>
- <a name = "socket:bind"></a>
- <strong>socket:bind (where)</strong>
- </dt>
- <dd>
-
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">where</span>
- <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
- Where to connect this socket to
- </li>
- </ul>
-
-
-
-
- <h3>Usage:</h3>
- <ul>
- <pre class="example"><span class="keyword">local</span> s = net.newsocket()
-s:bind(<span class="string">"127.0.0.1"</span>)
-s:receive(<span class="string">"ping"</span>,<span class="keyword">function</span>(stream)
- <span class="global">print</span>(instream:readstring())
-<span class="keyword">end</span>)
-<span class="keyword">local</span> c = net.newsocket()
-c:connect(<span class="string">"127.0.0.1"</span>)</pre>
- </ul>
-
-</dd>
- <dt>
- <a name = "receive"></a>
- <strong>receive (message, callback)</strong>
- </dt>
- <dd>
-
-
- </ul>
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">message</span>
- <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
- The message to bind this function to
- </li>
- <li><span class="parameter">callback</span>
- <span class="types"><span class="type">function</span></span>
- The function to call when this message is received
- </li>
- </ul>
-
-
-
-
-
-</dd>
- <dt>
- <a name = "newsocket"></a>
- <strong>newsocket ()</strong>
- </dt>
- <dd>
-
-
- <h3>domain:</h3>
- <ul>
- shared
- </ul>
-
-
- <h3>Returns:</h3>
- <ol>
-
- net.socket
- </ol>
-
-
-
-
-</dd>
-</dl>
- <h2 class="section-header "><a name="Tables"></a>Tables</h2>
-
- <dl class="function">
- <dt>
- <a name = "socket"></a>
- <strong>socket</strong>
- </dt>
- <dd>
-
-
- <h3>domain:</h3>
- <ul>
- shared
- </ul>
-
- <h3>Fields:</h3>
- <ul>
- <li><span class="parameter">fd</span>
-
- </li>
- </ul>
-
-
-
-
-
-</dd>
-</dl>
-
-
-</div> <!-- id="content" -->
-</div> <!-- id="main" -->
-<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2018-07-03 16:38:22 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
-</body>
-</html>
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2026-01-18 16:45:33 +0000