Last Time Chaning Doc For StdLib

This commit is contained in:
Cooldude2606
2018-05-30 00:08:59 +01:00
parent 310d9599b8
commit d8bb39d661
28 changed files with 369 additions and 510 deletions

View File

@@ -43,11 +43,11 @@
<li><a href="modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="modules/FSM.html">FSM</a></li>
<li><a href="modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="modules/Color.html">Color</a></li>
<li><a href="modules/Game.html">Game</a></li>
<li><a href="modules/String.html">String</a></li>
<li><a href="modules/Table.html">Table</a></li>
<li><a href="modules/Time.html">Time</a></li>
<li><a href="modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -112,23 +112,23 @@
<td class="summary">Adds some common functions used though out all ExpGaming modules</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Color.html">Color</a></td>
<td class="name" nowrap><a href="modules/StdLib.Color.html">StdLib.Color</a></td>
<td class="summary">A defines module for retrieving colors by name.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Game.html">Game</a></td>
<td class="name" nowrap><a href="modules/StdLib.Game.html">StdLib.Game</a></td>
<td class="summary">The game module.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/String.html">String</a></td>
<td class="name" nowrap><a href="modules/StdLib.String.html">StdLib.String</a></td>
<td class="summary">Extends Lua 5.2 string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Table.html">Table</a></td>
<td class="name" nowrap><a href="modules/StdLib.Table.html">StdLib.Table</a></td>
<td class="summary">Extends Lua 5.2 table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/Time.html">Time</a></td>
<td class="name" nowrap><a href="modules/StdLib.Time.html">StdLib.Time</a></td>
<td class="summary">A defines module for retrieving the number of ticks in 1 unit of time.</td>
</tr>
</table>
@@ -148,7 +148,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -1,210 +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>ldoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/modules.expgaminglib.control.html">modules.expgaminglib.control</a></li>
<li><a href="../modules/defines.color.html">defines.color</a></li>
<li><strong>Event</strong></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li>
<li><a href="../modules/table.html">table</a></li>
<li><a href="../modules/defines.time.html">defines.time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
<li><a href="../scripts/control.lua.html">control.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Event</code></h1>
<p>Makes working with events in factorio a lot more simple.</p>
<p>
<p>Factorio can only have one handler registered per event. This module
allows you to easily register multiple handlers for each event.
Using this module is as simple as replacing script.on_event(...) with Event.register(...)</p></p>
<h3>Usage:</h3>
<ul>
<pre class="example">require(&apos;stdlib/event/event&apos;)
</pre>
</ul>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#register">register (event, handler)</a></td>
<td class="summary">Registers a function for a given event.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#dispatch">dispatch (event)</a></td>
<td class="summary">Calls the registerd handlers
Will stop dispatching remaning handlers if any handler passes invalid event userdata.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#remove">remove (event, handler)</a></td>
<td class="summary">Removes the handler from the event.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "register"></a>
<strong>register (event, handler)</strong>
</dt>
<dd>
Registers a function for a given event. If a nil handler is passed remove all events and stop listening for that event.
Events are dispatched in the order they are registered.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">event</span>
<span class="types"><span class="type">defines.events</span> or <span class="type">{defines.events,...}</span></span>
events to register
</li>
<li><span class="parameter">handler</span>
<span class="types"><span class="type">function</span></span>
Function to call when event is triggered
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">Event</span></span>
</ol>
<h3>Usage:</h3>
<ul>
<pre class="example">Event.register(defines.events.on_tick, <span class="keyword">function</span>(event) <span class="global">print</span> event.tick <span class="keyword">end</span>)
<span class="comment">-- creates an event that prints the current tick every tick.</span></pre>
</ul>
</dd>
<dt>
<a name = "dispatch"></a>
<strong>dispatch (event)</strong>
</dt>
<dd>
Calls the registerd handlers
Will stop dispatching remaning handlers if any handler passes invalid event userdata.
Handlers are dispatched in the order they were created
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">event</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
LuaEvent as created by script.raise_event
</li>
</ul>
<h3>See also:</h3>
<ul>
</ul>
</dd>
<dt>
<a name = "remove"></a>
<strong>remove (event, handler)</strong>
</dt>
<dd>
Removes the handler from the event. If it removes the last handler for an event stop listening for that event.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">event</span>
<span class="types"><span class="type">defines.events</span> or <span class="type">{defines.events,...}</span></span>
events to remove the handler for
</li>
<li><span class="parameter">handler</span>
<span class="types"><span class="type">function</span></span>
to remove
</li>
</ul>
<h3>Returns:</h3>
<ol>
Event
</ol>
</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-05-29 20:06:55 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><strong>ExpGamingLib</strong></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -371,7 +371,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -51,11 +51,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><strong>FSM</strong></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -412,7 +412,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -51,11 +51,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><strong>Color</strong></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><strong>StdLib.Color</strong></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -67,15 +67,10 @@
<div id="content">
<h1>Module <code>Color</code></h1>
<h1>Module <code>StdLib.Color</code></h1>
<p>A defines module for retrieving colors by name.</p>
<p>
Extends the Factorio defines table.</p>
<h3>Usage:</h3>
<ul>
<pre class="example">require(&apos;stdlib/defines/color&apos;)
</pre>
</ul>
<h2><a href="#Functions">Functions</a></h2>
@@ -96,6 +91,14 @@
<td class="name" nowrap><a href="#from_hex">from_hex (hex[, alpha=1])</a></td>
<td class="summary">Get a color table with a hexadecimal string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#to_rgb">to_rgb (color)</a></td>
<td class="summary">Converts a color in the color table format to rgb</td>
</tr>
<tr>
<td class="name" nowrap><a href="#to_hex">to_hex (color)</a></td>
<td class="summary">Converts a color in the color table format to hex</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
@@ -109,7 +112,7 @@
</tr>
<tr>
<td class="name" nowrap><a href="#defines.lightcolor">defines.lightcolor</a></td>
<td class="summary">Returns a lighter color of a named color.</td>
<td class="summary">Returns a lighter color of a named color</td>
</tr>
<tr>
<td class="name" nowrap><a href="#defines.textcolor">defines.textcolor</a></td>
@@ -141,7 +144,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="../modules/Color.html#defines.color">defines.color</a> or <span class="type">Concepts.Color</span></span>
<span class="types"><a class="type" href="../modules/StdLib.Color.html#defines.color">defines.color</a> or <span class="type">Concepts.Color</span></span>
the color to configure
(<em>default</em> white)
</li>
@@ -265,6 +268,60 @@
</dd>
<dt>
<a name = "to_rgb"></a>
<strong>to_rgb (color)</strong>
</dt>
<dd>
Converts a color in the color table format to rgb
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the color to convert
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the color as rgb
</ol>
</dd>
<dt>
<a name = "to_hex"></a>
<strong>to_hex (color)</strong>
</dt>
<dd>
Converts a color in the color table format to hex
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the color to convert
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
the color as hex
</ol>
</dd>
</dl>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
@@ -423,7 +480,7 @@
<strong>defines.lightcolor</strong>
</dt>
<dd>
Returns a lighter color of a named color.
Returns a lighter color of a named color
<h3>Fields:</h3>
@@ -501,7 +558,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><strong>Game</strong></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><strong>StdLib.Game</strong></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -66,14 +66,9 @@
<div id="content">
<h1>Module <code>Game</code></h1>
<h1>Module <code>StdLib.Game</code></h1>
<p>The game module.</p>
<p></p>
<h3>Usage:</h3>
<ul>
<pre class="example">local Game = require(&apos;stdlib/game&apos;)
</pre>
</ul>
<h2><a href="#Functions">Functions</a></h2>
@@ -224,7 +219,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><strong>String</strong></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><strong>StdLib.String</strong></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -66,7 +66,7 @@
<div id="content">
<h1>Module <code>String</code></h1>
<h1>Module <code>StdLib.String</code></h1>
<p>Extends Lua 5.2 string.</p>
<p></p>
@@ -299,7 +299,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><strong>Table</strong></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><strong>StdLib.Table</strong></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -66,7 +66,7 @@
<div id="content">
<h1>Module <code>Table</code></h1>
<h1>Module <code>StdLib.Table</code></h1>
<p>Extends Lua 5.2 table.</p>
<p></p>
@@ -1128,7 +1128,7 @@ some_func(<span class="number">1</span>,<span class="number">2</span>) <span cla
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li>
<li><a href="../modules/table.html">table</a></li>
<li><strong>defines.time</strong></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><strong>StdLib.Time</strong></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -66,15 +66,10 @@
<div id="content">
<h1>Module <code>defines.time</code></h1>
<h1>Module <code>StdLib.Time</code></h1>
<p>A defines module for retrieving the number of ticks in 1 unit of time.</p>
<p>
Extends the Factorio defines table.</p>
<h3>Usage:</h3>
<ul>
<pre class="example">require(&apos;stdlib/defines/time&apos;)
</pre>
</ul>
<h2><a href="#Tables">Tables</a></h2>
@@ -141,7 +136,7 @@
</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-05-29 20:54:20 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><strong>Time</strong></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><strong>StdLib</strong></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -66,15 +66,10 @@
<div id="content">
<h1>Module <code>Time</code></h1>
<h1>Module <code>StdLib</code></h1>
<p>A defines module for retrieving the number of ticks in 1 unit of time.</p>
<p>
Extends the Factorio defines table.</p>
<h3>Usage:</h3>
<ul>
<pre class="example">require(&apos;stdlib/defines/time&apos;)
</pre>
</ul>
<h2><a href="#Tables">Tables</a></h2>
@@ -83,10 +78,6 @@
<td class="name" nowrap><a href="#defines.time">defines.time</a></td>
<td class="summary">Returns the number of ticks in a second, minute, hour, day, week, month, or year.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Time">Time</a></td>
<td class="summary">Allows index to deines.time though the Time module</td>
</tr>
</table>
<br/>
@@ -137,20 +128,6 @@
<pre class="example"><span class="keyword">local</span> ten_seconds = defines.time.second * <span class="number">10</span></pre>
</ul>
</dd>
<dt>
<a name = "Time"></a>
<strong>Time</strong>
</dt>
<dd>
Allows index to deines.time though the Time module
</dd>
</dl>
@@ -159,7 +136,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:33 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -129,7 +129,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -165,7 +165,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -283,7 +283,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -439,7 +439,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -186,7 +186,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -131,7 +131,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -122,7 +122,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -379,7 +379,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -564,7 +564,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,11 +50,11 @@
<li><strong>expcore.sync</strong></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -535,7 +535,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -51,11 +51,8 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><strong>defines.color</strong></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li>
<li><a href="../modules/table.html">table</a></li>
<li><a href="../modules/defines.time.html">defines.time</a></li>
<li><a href="../modules/StdLib.html">StdLib</a></li>
<li><strong>modules.factoriostdlib.color</strong></li>
</ul>
<h2>Scripts</h2>
<ul class="nowrap">
@@ -67,7 +64,7 @@
<div id="content">
<h1>Module <code>defines.color</code></h1>
<h1>Module <code>modules.factoriostdlib.color</code></h1>
<p>A defines module for retrieving colors by name.</p>
<p>
Extends the Factorio defines table.</p>
@@ -96,6 +93,14 @@
<td class="name" nowrap><a href="#Color.from_hex">Color.from_hex (hex[, alpha=1])</a></td>
<td class="summary">Get a color table with a hexadecimal string.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Color.to_rgb">Color.to_rgb (color)</a></td>
<td class="summary">Converts a color in the color table format to rgb</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Color.to_hex">Color.to_hex (color)</a></td>
<td class="summary">Converts a color in the color table format to hex</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
@@ -109,6 +114,10 @@
</tr>
<tr>
<td class="name" nowrap><a href="#defines.lightcolor">defines.lightcolor</a></td>
<td class="summary">Returns a lighter color of a named color</td>
</tr>
<tr>
<td class="name" nowrap><a href="#defines.textcolor">defines.textcolor</a></td>
<td class="summary">Returns a lighter color of a named color.</td>
</tr>
</table>
@@ -137,7 +146,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="../modules/defines.color.html#defines.color">defines.color</a> or <span class="type">Concepts.Color</span></span>
<span class="types"><a class="type" href="../modules/modules.factoriostdlib.color.html#defines.color">defines.color</a> or <span class="type">Concepts.Color</span></span>
the color to configure
(<em>default</em> white)
</li>
@@ -151,8 +160,8 @@
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">Concepts.Color</span></span>
a color table that has the specified value for the alpha channel
<span class="types"><span class="type">a</span></span>
color table that has the specified value for the alpha channel
</ol>
@@ -178,8 +187,8 @@
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">Concepts.Color</span></span>
a converted color &mdash; { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] }
<span class="types"><span class="type">a</span></span>
converted color &mdash; { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] }
</ol>
@@ -254,8 +263,62 @@
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">Concepts.Color</span></span>
a color table with RGB converted from Hex and with alpha
<span class="types"><span class="type">a</span></span>
color table with RGB converted from Hex and with alpha
</ol>
</dd>
<dt>
<a name = "Color.to_rgb"></a>
<strong>Color.to_rgb (color)</strong>
</dt>
<dd>
Converts a color in the color table format to rgb
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the color to convert
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the color as rgb
</ol>
</dd>
<dt>
<a name = "Color.to_hex"></a>
<strong>Color.to_hex (color)</strong>
</dt>
<dd>
Converts a color in the color table format to hex
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">color</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
the color to convert
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
the color as hex
</ol>
@@ -277,90 +340,67 @@
<h3>Fields:</h3>
<ul>
<li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=1.00,g=1.00,b=1.00}
</li>
<li><span class="parameter">black</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.00,g=0.00,b=0.00}
</li>
<li><span class="parameter">darkgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.25,g=0.25,b=0.25}
</li>
<li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.50,g=0.50,b=0.50}
</li>
<li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.75,g=0.75,b=0.75}
</li>
<li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=1.00,g=0.00,b=0.00}
</li>
<li><span class="parameter">darkred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.50,g=0.00,b=0.00}
</li>
<li><span class="parameter">lightred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=1.00,g=0.50,b=0.50}
</li>
<li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.00,g=1.00,b=0.00}
</li>
<li><span class="parameter">darkgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.00,g=0.50,b=0.00}
</li>
<li><span class="parameter">lightgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.50,g=1.00,b=0.50}
</li>
<li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.00,g=0.00,b=1.00}
</li>
<li><span class="parameter">darkblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.00,g=0.00,b=0.50}
</li>
<li><span class="parameter">lightblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.50,g=0.50,b=1.00}
</li>
<li><span class="parameter">orange</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=1.00,g=0.55,b=0.10}
</li>
<li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=1.00,g=1.00,b=0.00}
</li>
<li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=1.00,g=0.00,b=1.00}
</li>
<li><span class="parameter">purple</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.60,g=0.10,b=0.60}
</li>
<li><span class="parameter">brown</span>
<span class="types"><span class="type">Concepts.Color</span></span>
{r=0.60,g=0.40,b=0.10}
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">color = defines.color.red</pre>
</ul>
</dd>
<dt>
@@ -374,80 +414,61 @@
<h3>Fields:</h3>
<ul>
<li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">lightblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">lightgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">lightred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">orange</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
defines.color.black
</li>
<li><span class="parameter">black</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">brown</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">darkblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">darkgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">darkgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">darkred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">purple</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
<li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
defines.color.white
</li>
</ul>
@@ -461,42 +482,69 @@
<strong>defines.lightcolor</strong>
</dt>
<dd>
Returns a lighter color of a named color.
Returns a lighter color of a named color
<h3>Fields:</h3>
<ul>
<li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightgrey
defines.color.lightgrey
</li>
<li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.darkgrey
defines.color.darkgrey
</li>
<li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.grey
defines.color.grey
</li>
<li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightred
defines.color.lightred
</li>
<li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightgreen
defines.color.lightgreen
</li>
<li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightblue
defines.color.lightblue
</li>
<li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.orange
defines.color.orange
</li>
<li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.purple
defines.color.purple
</li>
</ul>
</dd>
<dt>
<a name = "defines.textcolor"></a>
<strong>defines.textcolor</strong>
</dt>
<dd>
Returns a lighter color of a named color.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">info</span>
{r=0.21,g=0.95,b=1.00}
</li>
<li><span class="parameter">bg</span>
{r=0.00,g=0.00,b=0.00}
</li>
<li><span class="parameter">low</span>
{r=0.18,g=0.77,b=0.18}
</li>
<li><span class="parameter">med</span>
{r=1.00,g=0.89,b=0.26}
</li>
<li><span class="parameter">high</span>
{r=1.00,g=0.33,b=0.00}
</li>
<li><span class="parameter">crit</span>
{r=1.00,g=0.00,b=0.00}
</li>
</ul>
@@ -512,7 +560,7 @@
</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-05-29 20:19:50 </i>
<i style="float:right;">Last updated 2018-05-29 23:30:03 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -51,11 +51,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
</div>
@@ -78,7 +78,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -51,11 +51,11 @@
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><a href="../modules/FSM.html">FSM</a></li>
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/Table.html">Table</a></li>
<li><a href="../modules/Time.html">Time</a></li>
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
</ul>
</div>
@@ -78,7 +78,7 @@
</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-05-29 22:53:53 </i>
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -1,7 +1,6 @@
--- A defines module for retrieving colors by name.
-- Extends the Factorio defines table.
-- @usage require('stdlib/defines/color')
-- @module Color
-- @module StdLib.Color
-- @alias defines.color
-- defines table is automatically required in all mod loading stages.
@@ -79,7 +78,7 @@ defines.anticolor = {
red = colors.white -- defines.color.white
}
--- Returns a lighter color of a named color.
--- Returns a lighter color of a named color
-- @table defines.lightcolor
defines.lightcolor = {
white = colors.lightgrey, -- defines.color.lightgrey
@@ -196,6 +195,7 @@ function Color.from_hex(hex, alpha)
end
--added by cooldude2606
--- Converts a color in the color table format to rgb
-- @tparam table color the color to convert
-- @treturn table the color as rgb
@@ -208,6 +208,7 @@ function Color.to_rgb(color)
end
--added by cooldude2606
--- Converts a color in the color table format to hex
-- @tparam table color the color to convert
-- @treturn string the color as hex

View File

@@ -1,6 +1,5 @@
--- The game module.
-- @module Game
-- @usage local Game = require('stdlib/game')
-- @module StdLib.Game
local Game = { --luacheck: allow defined top
VALID_FILTER = function(v)

View File

@@ -1,5 +1,5 @@
--- Extends Lua 5.2 string.
-- @module String
-- @module StdLib.String
-- @alias string
-- luacheck: globals string (Allow mutating string)

View File

@@ -1,5 +1,5 @@
--- Extends Lua 5.2 table.
-- @module Table
-- @module StdLib.Table
-- @alias table
-- luacheck: globals table (Allow mutating global table)

View File

@@ -1,8 +1,7 @@
--- A defines module for retrieving the number of ticks in 1 unit of time.
-- Extends the Factorio defines table.
-- @module Time
-- @module StdLib.Time
-- @alias defines.time
-- @usage require('stdlib/defines/time')
-- defines table is automatically required in all mod loading stages.
-- luacheck: ignore 122/defines
@@ -31,6 +30,4 @@ defines.time = {
year = YEAR, -- the number of Factorio ticks in a year (365 days)
}
--- Allows index to deines.time though the Time module
--@table Time
return setmetatable({},{__index=defines.time})