Added Module: FactorioStdLib

This commit is contained in:
Cooldude2606
2018-05-29 22:00:25 +01:00
parent 0ec7bb919e
commit 3939b13759
31 changed files with 1013 additions and 533 deletions

View File

@@ -70,8 +70,8 @@ Manager.verbose = function(rtn,action)
local settings = Manager.setVerbose
local state = Manager.currentState
-- if ran in a module the the global module_name is present
if module_name then rtn='['..module_name..'] '..rtn
else rtn='[FSM] '..rtn end
if module_name then rtn='['..module_name..'] '..tostring(rtn)
else rtn='[FSM] '..tostring(rtn) end
-- module_verbose is a local override for a file, action is used in the manager to describe an extra type, state is the current state
-- if action is true then it will always trigger verbose
if module_verbose or action and (action == true or settings[action]) or settings[state] then

View File

@@ -42,8 +42,8 @@
<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><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>
@@ -108,11 +108,11 @@
<td class="summary">Factorio Softmod Manager</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/modules.expgaminglib.control.html">modules.expgaminglib.control</a></td>
<td class="summary">Loads a table into _G even when sandboxed; will not overwrite values or append to tables; will not work during runtime to avoid desyncs</td>
<td class="name" nowrap><a href="modules/ExpGamingLib.html">ExpGamingLib</a></td>
<td class="summary">Adds some common functions used though out all ExpGaming modules</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/defines.color.html">defines.color</a></td>
<td class="name" nowrap><a href="modules/Color.html">Color</a></td>
<td class="summary">A defines module for retrieving colors by name.</td>
</tr>
<tr>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -1,303 +1,244 @@
/* BEGIN RESET
/* universal */
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.com/yui/license.html
version: 2.8.2r1
*/
html {
color: #000;
background: #FFF;
}
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
margin: 0;
padding: 0;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
fieldset,img {
border: 0;
}
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
font-style: inherit;
font-weight: inherit;
}
del,ins {
text-decoration: none;
}
li {
margin-left: 20px;
}
caption,th {
text-align: left;
}
h1,h2,h3,h4,h5,h6 {
font-size: 100%;
font-weight: bold;
}
q:before,q:after {
content: '';
}
abbr,acronym {
border: 0;
font-variant: normal;
}
sup {
vertical-align: baseline;
}
sub {
vertical-align: baseline;
}
legend {
color: #000;
}
input,button,textarea,select,optgroup,option {
font-family: inherit;
font-size: inherit;
font-style: inherit;
font-weight: inherit;
}
input,button,textarea,select {*font-size:100%;
}
/* END RESET */
body{background-color:#0F0F0F;color:#C8C8C8;font-family:'Lucida Grande',Arial,sans-serif}
a{text-decoration:none;border-style:none;outline:none!important}
a:link{color:#FF7200;text-decoration:none}
a:visited{color:#FF7200;text-decoration:none}
a:hover{color:#C8C8C8;text-decoration:none}
a:active{color:#C8C8C8;text-decoration:none}
h1{font-size:2.5rem}
h2{font-size:2.3rem}
h3{font-size:2rem}
h4{font-size:1.8rem}
h5{font-size:1.6rem}
body {
margin-left: 1em;
margin-right: 1em;
font-family: arial, helvetica, geneva, sans-serif;
background-color: #ffffff; margin: 0px;
/* table */
table,thead{text-align:left}
table,th,td{padding:2px}
/* sidebar */
.sidebar {height: 100%}
.sidebar-custom {
border-right: 1px solid #2C2C2C;
padding-right: 1.4rem;
bottom: 0rem;
}
code, tt { font-family: monospace; font-size: 1.1em; }
span.parameter { font-family:monospace; }
span.parameter:after { content:":"; }
span.types:before { content:"("; }
span.types:after { content:")"; }
.type { font-weight: bold; font-style:italic }
body, p, td, th { font-size: .95em; line-height: 1.2em;}
p, ul { margin: 10px 0 0 0px;}
strong { font-weight: bold;}
em { font-style: italic;}
h1 {
font-size: 1.5em;
margin: 20px 0 20px 0;
}
h2, h3, h4 { margin: 15px 0 10px 0; }
h2 { font-size: 1.25em; }
h3 { font-size: 1.15em; }
h4 { font-size: 1.06em; }
a:link { font-weight: bold; color: #004080; text-decoration: none; }
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
a:link:hover { text-decoration: underline; }
hr {
color:#cccccc;
background: #00007f;
height: 1px;
}
blockquote { margin-left: 3em; }
ul { list-style-type: disc; }
p.name {
font-family: "Andale Mono", monospace;
padding-top: 1em;
}
pre {
background-color: rgb(245, 245, 245);
border: 1px solid #C0C0C0; /* silver */
padding: 10px;
margin: 10px 0 10px 0;
overflow: auto;
font-family: "Andale Mono", monospace;
}
pre.example {
font-size: .85em;
}
table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
#container {
margin-left: 1em;
margin-right: 1em;
background-color: #f0f0f0;
}
#product {
text-align: center;
border-bottom: 1px solid #cccccc;
background-color: #ffffff;
}
#product big {
font-size: 2em;
}
#main {
background-color: #f0f0f0;
border-left: 2px solid #cccccc;
}
#navigation {
float: left;
width: 14em;
vertical-align: top;
background-color: #f0f0f0;
overflow: visible;
}
#navigation h2 {
background-color:#e7e7e7;
font-size:1.1em;
color:#000000;
text-align: left;
padding:0.2em;
border-top:1px solid #dddddd;
border-bottom:1px solid #dddddd;
}
#navigation ul
{
font-size:1em;
list-style-type: none;
margin: 1px 1px 10px 1px;
}
#navigation li {
text-indent: -1em;
display: block;
margin: 3px 0px 0px 22px;
}
#navigation li li a {
margin: 0px 3px 0px -1em;
}
#content {
margin-left: 14em;
padding: 1em;
width: 700px;
border-left: 2px solid #cccccc;
border-right: 2px solid #cccccc;
background-color: #ffffff;
}
#about {
clear: both;
padding: 5px;
border-top: 2px solid #cccccc;
background-color: #ffffff;
}
@media print {
body {
font: 12pt "Times New Roman", "TimeNR", Times, serif;
}
a { font-weight: bold; color: #004080; text-decoration: underline; }
#main {
background-color: #ffffff;
border-left: 0px;
}
#container {
margin-left: 2%;
margin-right: 2%;
background-color: #ffffff;
}
#content {
padding: 1em;
background-color: #ffffff;
}
#navigation {
display: none;
}
pre.example {
font-family: "Andale Mono", monospace;
font-size: 10pt;
page-break-inside: avoid;
@supports (-ms-ime-align:auto) {
.sidebar-custom {
height: 99%;
}
}
.up-to-top {
top: 1.5rem;
position: -webkit-sticky;
position: sticky;
text-align: right;
margin-right: 0.2rem;
}
.up-to-top a{padding:20px}
.up-to-top a:link{color:#FF7200}
.up-to-top a:hover{color:#C8C8C8}
.icon-arrow-right-custom{margin-bottom:3px}
.project-infobox{text-align:right}
.project-infobox .project-desc{font-style:italic}
.nav-modules{text-align:right}
.nav-module-contents{text-align:right}
/* navigation */
.nav .nav a{color:#FF7200}
.nav .nav a:link{color:#FF7200}
.nav .nav a:visited{color:#FF7200}
.nav .nav a:hover{color:#C8C8C8;text-decoration:none}
.nav .nav-item.active>a:hover{color:#C8C8C8;text-decoration:none}
.nav .nav-item.active{margin-left:0}
.nav .nav a:active{color:#C8C8C8}
/* main page module list */
.body-module-name {font-weight: 500}
table.module_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-spacing: 0;
display: table;
border-collapse: collapse;
margin-bottom: 2.0rem;
}
table.module_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
border-top: 1px solid #2C2C2C;
border-bottom: 1px solid #2C2C2C;
padding: 3px 7px 3px 7px;
}
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.module_list td.summary { width: 100%; }
table.module_list td.name {
vertical-align: top;
min-width: 125px;
background-color: #0D0D0D;
}
table.function_list {
border-width: 1px;
border-style: solid;
border-color: #cccccc;
table.module_list td.summary {vertical-align: top}
.module_list p {margin:0px}
/* section */
.module-see-also li {
margin-top: 0.5rem;
}
.section-title a:link{color:#C8C8C8}
.section-title a:visited{color:#C8C8C8}
.section-title a:hover{color:#FF7200}
.section-title a:active{color:#FF7200}
.section-body-container dd {
margin: 1.0rem 0 1.5rem 0;
}
table.section-content-list {
border-spacing: 0;
display: table;
border-collapse: collapse;
}
table.function_list td {
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.function_list td.summary { width: 100%; }
ul.nowrap {
overflow:auto;
white-space:nowrap;
margin-bottom: 1.5rem;
}
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
dl.table h3, dl.function h3 {font-size: .95em;}
table.section-content-list td {
border-top: 1px solid #2C2C2C;
border-bottom: 1px solid #2C2C2C;
padding: 3px 7px 3px 7px;
}
/* stop sublists from having initial vertical space */
ul ul { margin-top: 0px; }
ol ul { margin-top: 0px; }
ol ol { margin-top: 0px; }
ul ol { margin-top: 0px; }
table.section-content-list td.name {
background-color: #0D0D0D;
vertical-align: top;
white-space: nowrap;
}
/* make the target distinct; helps when we're navigating to a function */
a:target + * {
background-color: #FF9;
table.section-content-list td.summary {
min-width: 200px;
vertical-align: top;
}
.section-content-list p {margin: 0px}
div.section-item-header .section-item-title {
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 1.5rem;
margin-left: 3px;
}
.section-title:target {
padding-left: 7px;
border-left: 5px solid #FF7200;
text-decoration: none;
}
.section-item-title:target {
padding: 3px 5px 3px 5px;
background-color: #FF7200;
color: #000000;
text-decoration: none;
}
.section-item-body {margin-left: 4rem}
/*.section-subitem-li {
padding-left: 1.28571429em;
text-indent: -1.28571429em;
}*/
/*.section-subitem-module-field-li {
margin-left: -1.28571429em;
padding-left: 1.28571429em;
text-indent: -1.28571429em;
}*/
/* example pages */
pre.code.example{margin:0 0 1em}
pre.code.example code h2{display:none}
pre.code.example code pre{margin:0}
/* usage code */
code{background-color:#181818;color:#C8C8C8;font-size:1.3rem}
pre.code code{background-color:#282828;color:#C8C8C8;font-size:1.3rem}
pre.code .comment{color:#998d70}
pre.code .constant{color:#a8660d}
pre.code .escape{color:#844631}
pre.code .keyword{color:#c43724;font-weight:700}
pre.code .library{color:#0e7c6b}
pre.code .marker{color:#512b1e;background:#fedc56;font-weight:700}
pre.code .string{color:#99ca3c}
pre.code .number{color:#f8660d}
pre.code .operator{color:#2239a8;font-weight:700}
pre.code .preprocessor,pre .prepro{color:#a33243}
pre.code .global{color:#5798da}
pre.code .user-keyword{color:purple}
pre.code .prompt{color:#998d70}
pre.code .url{color:#272fc2;text-decoration:underline}
/* footer */
.footer{height:65px}
.sidebar-footer{text-align:left;padding-right:33px}
.content-footer{text-align:right}
/* misc */
.types {font-weight:bold;font-style:italic}
.divider[data-content]::after,.divider-vert[data-content]::after{background:#262626;color:#C8C8C8}
.divider-custom{border-width:1px;border-color:#585959}
/* fragment hashtag */
.fragment-hashtag{color:#3C3C3C}
a.fragment-hashtag{color:#3C3C3C}
a.fragment-hashtag:hover{color:#FF7200}
/* mobile */
@media screen and (max-width: 540px) {
.up-to-top {display: none}
.sidebar-custom {
border-right: 1px solid #2C2C2C;
padding-right: 1.4rem;
bottom: 0rem;
margin-right: 0px;
}
.sidebar-footer {
text-align: right;
padding-right: 10px;
white-space: nowrap;
}
table.function_list td.name {
background-color: #0D0D0D;
vertical-align: top;
white-space: normal;
}
.function-item-spec-body-wrap {margin-left: 1.5rem}
}
/* styles for prettification of source */
pre .comment { color: #558817; }
pre .constant { color: #a8660d; }
pre .escape { color: #844631; }
pre .keyword { color: #aa5050; font-weight: bold; }
pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #8080ff; }
pre .number { color: #f8660d; }
pre .operator { color: #2239a8; font-weight: bold; }
pre .preprocessor, pre .prepro { color: #a33243; }
pre .global { color: #800080; }
pre .user-keyword { color: #800080; }
pre .prompt { color: #558817; }
pre .url { color: #272fc2; text-decoration: underline; }
/* tablets */
@media screen and (min-width: 540px) and (max-width: 780px) {
.sidebar-footer {white-space: nowrap}
}

519
doc/modules/Color.html Normal file
View File

@@ -0,0 +1,519 @@
<!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>
<li><a href="#Tables">Tables</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/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/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>
<li><a href="../scripts/index.lua.html">index.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>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>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#set">set ([color=white[, alpha=1]])</a></td>
<td class="summary">Set a value for the alpha channel in the given color table.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#to_table">to_table (c_arr)</a></td>
<td class="summary">Converts a color in the array format to a color in the table format.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#from_rgb">from_rgb ([r=0[, g=0[, b=0[, a=255]]]])</a></td>
<td class="summary">Converts a color in the rgb format to a color table</td>
</tr>
<tr>
<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>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#defines.color">defines.color</a></td>
<td class="summary">A table of colors allowing retrieval by color name.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#defines.anticolor">defines.anticolor</a></td>
<td class="summary">Returns white for dark colors or black for lighter colors.</td>
</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>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "set"></a>
<strong>set ([color=white[, alpha=1]])</strong>
</dt>
<dd>
Set a value for the alpha channel in the given color table.
`color.a` represents the alpha channel in the given color table.
<ul>
<li>If ***alpha*** is given, set `color.a` to it.
<li>If ***alpha*** is not given, and if the given color table does not have a value for `color.a`, set `color.a` to 1.
<li>If ***alpha*** is not given, and if the given color table already has a value for `color.a`, then leave `color.a` alone.
</ul>
<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>
the color to configure
(<em>default</em> white)
</li>
<li><span class="parameter">alpha</span>
<span class="types"><span class="type">float</span></span>
the alpha value (*[0 - 1]*) to set for the given color
(<em>default</em> 1)
</li>
</ul>
<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
</ol>
</dd>
<dt>
<a name = "to_table"></a>
<strong>to_table (c_arr)</strong>
</dt>
<dd>
Converts a color in the array format to a color in the table format.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">c_arr</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"><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] }
</ol>
</dd>
<dt>
<a name = "from_rgb"></a>
<strong>from_rgb ([r=0[, g=0[, b=0[, a=255]]]])</strong>
</dt>
<dd>
Converts a color in the rgb format to a color table
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">r</span>
<span class="types"><span class="type">int</span></span>
0-255 red
(<em>default</em> 0)
</li>
<li><span class="parameter">g</span>
<span class="types"><span class="type">int</span></span>
0-255 green
(<em>default</em> 0)
</li>
<li><span class="parameter">b</span>
<span class="types"><span class="type">int</span></span>
0-255 blue
(<em>default</em> 0)
</li>
<li><span class="parameter">a</span>
<span class="types"><span class="type">int</span></span>
0-255 alpha
(<em>default</em> 255)
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><span class="type">Concepts.Color</span></span>
</ol>
</dd>
<dt>
<a name = "from_hex"></a>
<strong>from_hex (hex[, alpha=1])</strong>
</dt>
<dd>
Get a color table with a hexadecimal string.
Optionally provide the value for the alpha channel.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">hex</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
hexadecimal color string (#ffffff, not #fff)
</li>
<li><span class="parameter">alpha</span>
<span class="types"><span class="type">float</span></span>
the alpha value to set; such that ***[ 0 &#8924; value &#8924; 1 ]***
(<em>default</em> 1)
</li>
</ul>
<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
</ol>
</dd>
</dl>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "defines.color"></a>
<strong>defines.color</strong>
</dt>
<dd>
A table of colors allowing retrieval by color name.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">black</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">darkgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">darkred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">lightred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">darkgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">lightgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">darkblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">lightblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">orange</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">purple</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
<li><span class="parameter">brown</span>
<span class="types"><span class="type">Concepts.Color</span></span>
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">color = defines.color.red</pre>
</ul>
</dd>
<dt>
<a name = "defines.anticolor"></a>
<strong>defines.anticolor</strong>
</dt>
<dd>
Returns white for dark colors or black for lighter colors.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">lightblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">lightgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">lightred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">orange</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black
</li>
<li><span class="parameter">black</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">brown</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">darkblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">darkgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">darkgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">darkred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">purple</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
<li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white
</li>
</ul>
</dd>
<dt>
<a name = "defines.lightcolor"></a>
<strong>defines.lightcolor</strong>
</dt>
<dd>
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
</li>
<li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.darkgrey
</li>
<li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.grey
</li>
<li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightred
</li>
<li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightgreen
</li>
<li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightblue
</li>
<li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.orange
</li>
<li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.purple
</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-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@@ -49,8 +49,8 @@
<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><strong>modules.expgaminglib.control</strong></li>
<li><a href="../modules/defines.color.html">defines.color</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>
@@ -66,44 +66,47 @@
<div id="content">
<h1>Module <code>modules.expgaminglib.control</code></h1>
<p>Loads a table into _G even when sandboxed; will not overwrite values or append to tables; will not work during runtime to avoid desyncs</p>
<h1>Module <code>ExpGamingLib</code></h1>
<p>Adds some common functions used though out all ExpGaming modules</p>
<p></p>
<h3>Usage:</h3>
<h3>Info:</h3>
<ul>
<pre class="example">unpack_to_G{key1=&apos;foo&apos;,key2=&apos;bar&apos;}
</pre>
<li><strong>Author</strong>: Cooldude2606</li>
</ul>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#ExpLib.get_env">ExpLib.get_env ()</a></td>
<td class="name" nowrap><a href="#unpack_to_G">unpack_to_G (tbl)</a></td>
<td class="summary">Loads a table into _G even when sandboxed; will not overwrite values or append to tables; will not work during runtime to avoid desyncs</td>
</tr>
<tr>
<td class="name" nowrap><a href="#get_env">get_env ()</a></td>
<td class="summary">Used to get the current ENV with all _G keys removed; useful when saving function to global</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ExpLib.is_type">ExpLib.is_type (v[, test_type=nil])</a></td>
<td class="name" nowrap><a href="#is_type">is_type (v[, test_type=nil])</a></td>
<td class="summary">Compear types faster for faster valadation of prams</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ExpLib.player_return">ExpLib.player_return (rtn[, colour=defines.colour.white[, player=game.player]])</a></td>
<td class="name" nowrap><a href="#player_return">player_return (rtn[, colour=defines.colour.white[, player=game.player]])</a></td>
<td class="summary">Will return a value of any type to the player/server console, allows colour for in-game players</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ExpLib.tick_to_hour">ExpLib.tick_to_hour (tick)</a></td>
<td class="name" nowrap><a href="#tick_to_hour">tick_to_hour (tick)</a></td>
<td class="summary">Convert ticks to hours</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ExpLib.tick_to_min">ExpLib.tick_to_min (tick)</a></td>
<td class="name" nowrap><a href="#tick_to_min">tick_to_min (tick)</a></td>
<td class="summary">Convert ticks to minutes</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ExpLib.tick_to_display_format">ExpLib.tick_to_display_format (tick)</a></td>
<td class="name" nowrap><a href="#tick_to_display_format">tick_to_display_format (tick)</a></td>
<td class="summary">Converts a tick into a clean format for end user</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ExpLib.gui_tree">ExpLib.gui_tree (root)</a></td>
<td class="name" nowrap><a href="#gui_tree">gui_tree (root)</a></td>
<td class="summary">Used as a way to view the structure of a gui, used for debuging</td>
</tr>
</table>
@@ -116,8 +119,33 @@
<dl class="function">
<dt>
<a name = "ExpLib.get_env"></a>
<strong>ExpLib.get_env ()</strong>
<a name = "unpack_to_G"></a>
<strong>unpack_to_G (tbl)</strong>
</dt>
<dd>
Loads a table into _G even when sandboxed; will not overwrite values or append to tables; will not work during runtime to avoid desyncs
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">tbl</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
table to be unpacked
</li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">unpack_to_G{key1=<span class="string">'foo'</span>,key2=<span class="string">'bar'</span>}</pre>
</ul>
</dd>
<dt>
<a name = "get_env"></a>
<strong>get_env ()</strong>
</dt>
<dd>
Used to get the current ENV with all _G keys removed; useful when saving function to global
@@ -140,8 +168,8 @@
</dd>
<dt>
<a name = "ExpLib.is_type"></a>
<strong>ExpLib.is_type (v[, test_type=nil])</strong>
<a name = "is_type"></a>
<strong>is_type (v[, test_type=nil])</strong>
</dt>
<dd>
Compear types faster for faster valadation of prams
@@ -176,8 +204,8 @@
</dd>
<dt>
<a name = "ExpLib.player_return"></a>
<strong>ExpLib.player_return (rtn[, colour=defines.colour.white[, player=game.player]])</strong>
<a name = "player_return"></a>
<strong>player_return (rtn[, colour=defines.colour.white[, player=game.player]])</strong>
</dt>
<dd>
Will return a value of any type to the player/server console, allows colour for in-game players
@@ -212,8 +240,8 @@
</dd>
<dt>
<a name = "ExpLib.tick_to_hour"></a>
<strong>ExpLib.tick_to_hour (tick)</strong>
<a name = "tick_to_hour"></a>
<strong>tick_to_hour (tick)</strong>
</dt>
<dd>
Convert ticks to hours
@@ -243,8 +271,8 @@
</dd>
<dt>
<a name = "ExpLib.tick_to_min"></a>
<strong>ExpLib.tick_to_min (tick)</strong>
<a name = "tick_to_min"></a>
<strong>tick_to_min (tick)</strong>
</dt>
<dd>
Convert ticks to minutes
@@ -274,8 +302,8 @@
</dd>
<dt>
<a name = "ExpLib.tick_to_display_format"></a>
<strong>ExpLib.tick_to_display_format (tick)</strong>
<a name = "tick_to_display_format"></a>
<strong>tick_to_display_format (tick)</strong>
</dt>
<dd>
Converts a tick into a clean format for end user
@@ -306,8 +334,8 @@
</dd>
<dt>
<a name = "ExpLib.gui_tree"></a>
<strong>ExpLib.gui_tree (root)</strong>
<a name = "gui_tree"></a>
<strong>gui_tree (root)</strong>
</dt>
<dd>
Used as a way to view the structure of a gui, used for debuging
@@ -343,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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -33,7 +33,7 @@
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Fields">Fields</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>
@@ -50,8 +50,8 @@
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
<li><strong>FSM</strong></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><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>
@@ -73,7 +73,6 @@
<h3>Usage:</h3>
<ul>
<pre class="example">Manager = require(&quot;FactorioSoftmodManager&quot;)
Used to load all other modules that are indexed in index.lua
</pre>
</ul>
<h3>Info:</h3>
@@ -92,27 +91,31 @@
<td class="name" nowrap><a href="#verbose">verbose (rtn, action)</a></td>
<td class="summary">Used to call the output of the verbose when the current state allows it</td>
</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#setVerbose">setVerbose</a></td>
<td class="name" nowrap><a href="#setVerbose">setVerbose (settings)</a></td>
<td class="summary">Main logic for allowing verbose at different stages though out the script</td>
</tr>
<tr>
<td class="name" nowrap><a href="#sandbox">sandbox</a></td>
<td class="name" nowrap><a href="#sandbox">sandbox (callback[, env])</a></td>
<td class="summary">Creates a sand box envorment and runs a callback in that sand box; provents global pollution</td>
</tr>
<tr>
<td class="name" nowrap><a href="#loadModules">loadModules</a></td>
<td class="name" nowrap><a href="#loadModules">loadModules ()</a></td>
<td class="summary">Loads the modules that are present in the index list</td>
</tr>
<tr>
<td class="name" nowrap><a href="#error">error</a></td>
<td class="name" nowrap><a href="#error">error (err, callback)</a></td>
<td class="summary">A more detailed replacement for the lua error function to allow for handlers to be added; repleaces default error so error can be used instead of Manager.error</td>
</tr>
<tr>
<td class="name" nowrap><a href="#names">names</a></td>
<td class="name" nowrap><a href="#event">event (event_name, callback)</a></td>
<td class="summary">Event handler that modules can use, each module can register one function per event</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Manager.event.names">Manager.event.names</a></td>
<td class="summary">Sub set to Manger.event and acts as a coverter between event_name and event_id</td>
</tr>
</table>
@@ -178,20 +181,17 @@
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
<dl class="function">
<dt>
<a name = "setVerbose"></a>
<strong>setVerbose</strong>
<strong>setVerbose (settings)</strong>
</dt>
<dd>
Main logic for allowing verbose at different stages though out the script
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">table</span>
<li><span class="parameter">settings</span>
<span class="types"><span class="type">newTbl</span></span>
the table that will be searched for settings to be updated
</li>
@@ -210,19 +210,20 @@
</dd>
<dt>
<a name = "sandbox"></a>
<strong>sandbox</strong>
<strong>sandbox (callback[, env])</strong>
</dt>
<dd>
Creates a sand box envorment and runs a callback in that sand box; provents global pollution
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">function</span>
<span class="types"><span class="type">callback</span></span>
<li><span class="parameter">callback</span>
<span class="types"><span class="type">function</span></span>
the function that will be ran in the sandbox
</li>
<li><span class="parameter">any</span>
other params that the function will use
<li><span class="parameter">env</span>
any other params that the function will use
(<em>optional</em>)
</li>
</ul>
@@ -240,7 +241,7 @@
</dd>
<dt>
<a name = "loadModules"></a>
<strong>loadModules</strong>
<strong>loadModules ()</strong>
</dt>
<dd>
Loads the modules that are present in the index list
@@ -261,24 +262,21 @@
</dd>
<dt>
<a name = "error"></a>
<strong>error</strong>
<strong>error (err, callback)</strong>
</dt>
<dd>
A more detailed replacement for the lua error function to allow for handlers to be added; repleaces default error so error can be used instead of Manager.error
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">string</span>
<span class="types"><span class="type">name</span></span>
|| fucntion the name that is given to the callback || the callback that will be used
<li><span class="parameter">err</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">fucntion</span></span>
the string to be passed to handlers; if a function it will register a handler
</li>
<li><span class="parameter">string</span>
<span class="types"><span class="type">name</span></span>
|| fucntion the name that is given to the callback || the callback that will be used
</li>
<li><span class="parameter">function</span>
<span class="types"><span class="type">callback</span></span>
if name is given as a string this will be the callback used
<li><span class="parameter">callback</span>
<span class="types"><span class="type">function</span></span>
if given the err param will be used to given the handler a name
</li>
</ul>
@@ -298,18 +296,53 @@
</dd>
<dt>
<a name = "names"></a>
<strong>names</strong>
<a name = "event"></a>
<strong>event (event_name, callback)</strong>
</dt>
<dd>
Event handler that modules can use, each module can register one function per event
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">event_name</span>
<span class="types"><span class="type">int</span> or <a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
that referes to an event
</li>
<li><span class="parameter">callback</span>
<span class="types"><span class="type">function</span></span>
the function that will be set for that event
</li>
</ul>
<h3>Usage:</h3>
<ul>
<li><pre class="example">Manager.event[event_name] = callback <span class="comment">-- sets the callback for that event</span></pre></li>
<li><pre class="example">Manager.event[event_name] = <span class="keyword">nil</span> <span class="comment">-- clears the callback for that event</span></pre></li>
<li><pre class="example">Manager.event(event_name,callback) <span class="comment">-- sets the callback for that event</span></pre></li>
<li><pre class="example">Manager.event[event_name] <span class="comment">-- returns the callback for that event or the event id if not registered</span></pre></li>
<li><pre class="example">Manager.event(event_name) <span class="comment">-- runs all the call backs for that event</span></pre></li>
<li><pre class="example">Manager.event() <span class="comment">-- returns the stop value for the event proccessor, if returned during an event will stop all other callbacks</span></pre></li>
<li><pre class="example">#Manager.event <span class="comment">-- returns the number of callbacks that are registered</span></pre></li>
<li><pre class="example"><span class="global">pairs</span>(Manager.events) <span class="comment">-- returns event_id,table of callbacks</span></pre></li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "Manager.event.names"></a>
<strong>Manager.event.names</strong>
</dt>
<dd>
Sub set to Manger.event and acts as a coverter between event_name and event_id
<ul>
<li><span class="parameter">names</span>
</li>
</ul>
@@ -319,7 +352,7 @@
<h3>Usage:</h3>
<ul>
<pre class="example">Manager.event[event_name] <span class="comment">-- see above, can not be accessed via Manager.event.names</span></pre>
<pre class="example">Manager.event[event_name]</pre>
</ul>
</dd>
@@ -330,7 +363,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:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -224,7 +224,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:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,7 +50,7 @@
<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/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>
@@ -512,7 +512,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:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:19:50 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -141,7 +141,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:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<li><strong>expcore.server</strong></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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
<li><strong>expcore.sync</strong></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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -303,7 +303,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:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -49,8 +49,8 @@
<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><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>
@@ -1138,7 +1138,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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,8 +50,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -50,8 +50,8 @@
<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><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>
@@ -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 20:15:05 </i>
<i style="float:right;">Last updated 2018-05-29 20:54:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

View File

@@ -63,7 +63,7 @@ end
-- @tparam[opt=defines.colour.white] ?defines.color|string colour the colour of the text for the player, ingroned when printing to console
-- @tparam[opt=game.player] LuaPlayer player the player that return will go to, if no game.player then returns to server
function ExpLib.player_return(rtn,colour,player)
local colour = ExpLib.is_type(colour) == 'table' and colour or defines.color[colour]
local colour = ExpLib.is_type(colour) == 'table' and colour or defines.text_color[colour] ~= defines.color.white and defines.text_color[colour] or defines.color[colour]
local player = player or game.player
local function _return(callback,rtn)
if ExpLib.is_type(rtn,'table') then

View File

@@ -32,9 +32,7 @@ defines = defines or {} --luacheck: ignore defines (This is used for testing loc
-- @tfield Concepts.Color pink
-- @tfield Concepts.Color purple
-- @tfield Concepts.Color brown
defines.color = {}
local colors = {
defines.color = {
white = {r = 1.00, g = 1.00, b = 1.00},
black = {r = 0.00, g = 0.00, b = 0.00},
darkgrey = {r = 0.25, g = 0.25, b = 0.25},
@@ -55,7 +53,7 @@ local colors = {
purple = {r = 0.60, g = 0.10, b = 0.60},
brown = {r = 0.60, g = 0.40, b = 0.10}
}
local colors = defines.color
--- Returns white for dark colors or black for lighter colors.
-- @tfield Concepts.Color green defines.color.black
-- @tfield Concepts.Color grey defines.color.black
@@ -76,9 +74,7 @@ local colors = {
-- @tfield Concepts.Color pink defines.color.white
-- @tfield Concepts.Color purple defines.color.white
-- @tfield Concepts.Color red defines.color.white
defines.anticolor = {}
local anticolors = {
defines.anticolor = {
green = colors.black,
grey = colors.black,
lightblue = colors.black,
@@ -109,8 +105,7 @@ local anticolors = {
-- @tfield Concepts.Color blue defines.color.lightblue
-- @tfield Concepts.Color yellow defines.color.orange
-- @tfield Concepts.Color pink defines.color.purple
defines.lightcolor = {}
local lightcolors = {
defines.lightcolor = {
white = colors.lightgrey,
grey = colors.darkgrey,
lightgrey = colors.grey,
@@ -129,8 +124,7 @@ local lightcolors = {
-- @tfield Concepts.Color med
-- @tfield Concepts.Color high
-- @tfield Concepts.Color crit
defines.text_color = {}
local text_color = {
defines.text_color = {
info = {r = 0.21, g = 0.95, b = 1.00},
bg = {r = 0.00, g = 0.00, b = 0.00},
low = {r = 0.18, g = 0.77, b = 0.18},
@@ -139,76 +133,27 @@ local text_color = {
crit = {r = 1.00, g = 0.00, b = 0.00}
}
-- metatable remade by cooldude
local _mt = {
color = {
__index = function(_, c)
return colors[c]
and { r = colors[c]['r'], g=colors[c]['g'], b=colors[c]['b'], a = colors[c]['a'] }
or { r = 1, g = 1, b = 1, a = 1 }
end,
__pairs = function()
local k = nil
local c = colors
return function()
local v
k, v = next(c, k)
return k, (v and {r = v['r'], g = v['g'], b = v['b'], a = v['a']}) or nil
end
end
},
anticolor = {
__index = function(_, c)
return anticolors[c]
and { r = anticolors[c]['r'], g=anticolors[c]['g'], b=anticolors[c]['b'], a = anticolors[c]['a'] }
or { r = 1, g = 1, b = 1, a = 1 }
end,
__pairs = function()
local k = nil
local c = anticolors
return function()
local v
k, v = next(c, k)
return k, (v and {r = v['r'], g = v['g'], b = v['b'], a = v['a']}) or nil
end
end
},
lightcolor = {
__index = function(_, c)
return lightcolors[c]
and { r = lightcolors[c]['r'], g=lightcolors[c]['g'], b=lightcolors[c]['b'], a = lightcolors[c]['a'] }
or { r = 1, g = 1, b = 1, a = 1 }
end,
__pairs = function()
local k = nil
local c = lightcolors
return function()
local v
k, v = next(c, k)
return k, (v and {r = v['r'], g = v['g'], b = v['b'], a = v['a']}) or nil
end
end
},
text_color = { -- added by cooldude2606
__index = function(_, c)
return text_color[c]
and { r = text_color[c]['r'], g=text_color[c]['g'], b=text_color[c]['b'], a = text_color[c]['a'] }
or { r = 1, g = 1, b = 1, a = 1 }
end,
__pairs = function()
local k = nil
local c = text_color
return function()
local v
k, v = next(c, k)
return k, (v and {r = v['r'], g = v['g'], b = v['b'], a = v['a']}) or nil
end
end
}
__index=function(tbl,key)
return rawget(tbl,tostring(key):lower()) or rawget(defines.color,'white')
end,
__pairs=function(tbl)
return function()
local v
k, v = next(tbl, k)
return k, (v and {r = v['r'], g = v['g'], b = v['b'], a = v['a']}) or nil
end, tbl, nil
end,
__eq=function(tbl1,tbl2)
return tbl1.r == tbl2.r and tbl1.g == tbl2.g and tbl1.b == tbl2.b and tbl1.a == tbl2.a
end
}
setmetatable(defines.color, _mt.color)
setmetatable(defines.anticolor, _mt.anticolor)
setmetatable(defines.text_color, _mt.text_color)
setmetatable(defines.lightcolor, _mt.lightcolor)
setmetatable(defines.color, _mt)
setmetatable(defines.anticolor, _mt)
setmetatable(defines.text_color, _mt)
setmetatable(defines.lightcolor, _mt)
local Color = {} --luacheck: allow defined top

View File

@@ -1,36 +0,0 @@
--[[
Explosive Gaming
This file can be used with permission but this and the credit below must remain in the file.
Contact a member of management on our discord to seek permission to use our code.
Any changes that you may make to the code are yours but that does not make the script yours.
Discord: https://discord.gg/r6dC2uK
]]
--[[
StdLib
This file allow you to only require this one file to return the diffent libarys.
This file will return a function which can be used to access only the part you want.
Pass a table with the names of the objects you want and it will be return in that order
]]
local StdLib = {}
require('table')
require('string')
require('time')
StdLib.Color = require('color')
StdLib.Game = require('game')
StdLib.Event = require('event')
return function(rtn)
local _return = {}
for _,name in pairs(rtn) do
if StdLib[name] then
verbose('StdLib Extraction: '..name)
table.insert(_return,StdLib[name])
end
end
return unpack(_return)
end

View File

@@ -6,7 +6,51 @@
"version": "0.8.0",
"location": "nil",
"submodules": {
"Color": {
"name": "Color",
"module": "Color",
"description": "A defines module for retrieving colors by name.",
"keywords": ["Standard Library","Lib","StdLib","Color","Extends"],
"version": "0.8.0",
"location": "color",
"dependencies": {}
},
"Game": {
"name": "Game",
"module": "game",
"description": "The game module.",
"keywords": ["Standard Library","Lib","StdLib","Game","Extends"],
"version": "0.8.0",
"location": "game",
"dependencies": {}
},
"String": {
"name": "String",
"module": "string",
"description": "Extends Lua 5.2 string.",
"keywords": ["Standard Library","Lib","StdLib","String","Extends"],
"version": "0.8.0",
"location": "string",
"dependencies": {}
},
"Table": {
"name": "Table",
"module": "table",
"description": "Extends Lua 5.2 table.",
"keywords": ["Standard Library","Lib","StdLib","Table","Extends"],
"version": "0.8.0",
"location": "table",
"dependencies": {}
},
"Time": {
"name": "Time",
"module": "Time",
"description": "A defines module for retrieving the number of ticks in 1 unit of time.",
"keywords": ["Standard Library","Lib","StdLib","Time","Extends"],
"version": "0.8.0",
"location": "time",
"dependencies": {}
}
},
"author": "Afforess",
"contact": "https://github.com/Afforess/Factorio-Stdlib/issues",

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
--- A defines module for retrieving the number of ticks in 1 unit of time.
-- Extends the Factorio defines table.
-- @module defines.time
-- @module Time
-- @alias defines.time
-- @usage require('stdlib/defines/time')
-- defines table is automatically required in all mod loading stages.

View File

@@ -2,4 +2,9 @@
-- @script index.lua
return {
['ExpLib']='/modules/ExpGamingLib/control',
['Game']='/modules/FactorioStdLib/game',
['Time']='/modules/FactorioStdLib/time',
['Color']='/modules/FactorioStdLib/color',
['table']='/modules/FactorioStdLib/table',
['string']='/modules/FactorioStdLib/string',
}