Many Changes To Doc

This commit is contained in:
Cooldude2606
2018-05-29 22:56:54 +01:00
parent 9b80e8d8fe
commit 310d9599b8
31 changed files with 798 additions and 561 deletions

View File

@@ -160,8 +160,8 @@ function left._left.toggle(event)
else else
left.style.visible = false left.style.visible = false
end end
if open == false then player_return({'gui.cant-open-no-reason'},defines.text_color.crit,player) player.play_sound{path='utility/cannot_build'} if open == false then player_return({'gui.cant-open-no-reason'},defines.textcolor.crit,player) player.play_sound{path='utility/cannot_build'}
elseif open ~= true then player_return({'gui.cant-open',open},defines.text_color.crit,player) player.play_sound{path='utility/cannot_build'} end elseif open ~= true then player_return({'gui.cant-open',open},defines.textcolor.crit,player) player.play_sound{path='utility/cannot_build'} end
end end
-- draws the left guis when a player first joins, fake_event is just because i am lazy -- draws the left guis when a player first joins, fake_event is just because i am lazy

View File

@@ -82,7 +82,7 @@ local function run_custom_command(command)
local player_name = Game.get_player(command) and Game.get_player(command).name or 'server' local player_name = Game.get_player(command) and Game.get_player(command).name or 'server'
-- is the player allowed to use this command -- is the player allowed to use this command
if is_type(Ranking,'table') and Ranking._presets and Ranking._presets().meta.rank_count > 0 and not Ranking.get_rank(player_name):allowed(command.name) then if is_type(Ranking,'table') and Ranking._presets and Ranking._presets().meta.rank_count > 0 and not Ranking.get_rank(player_name):allowed(command.name) then
player_return({'commands.unauthorized'},defines.text_color.crit) player_return({'commands.unauthorized'},defines.textcolor.crit)
if game.player then game.player.play_sound{path='utility/cannot_build'} end if game.player then game.player.play_sound{path='utility/cannot_build'} end
game.write_file('commands.log', game.write_file('commands.log',
game.tick game.tick
@@ -96,7 +96,7 @@ local function run_custom_command(command)
-- gets the args for the command -- gets the args for the command
local args, valid = command_args(command,command_data) local args, valid = command_args(command,command_data)
if not valid then if not valid then
player_return({'commands.invalid-inputs',command.name,command_inputs(command_data)},defines.text_color.high) player_return({'commands.invalid-inputs',command.name,command_inputs(command_data)},defines.textcolor.high)
if game.player then game.player.play_sound{path='utility/deconstruct_big'} end if game.player then game.player.play_sound{path='utility/deconstruct_big'} end
game.write_file('commands.log', game.write_file('commands.log',
game.tick game.tick
@@ -110,7 +110,7 @@ local function run_custom_command(command)
-- runs the command -- runs the command
local success, err = pcall(command_calls[command.name],command,args) local success, err = pcall(command_calls[command.name],command,args)
if not success then error(err) end if not success then error(err) end
if err ~= commands.error and player_name ~= 'server' then player_return({'commands.command-ran'},defines.text_color.info) end if err ~= commands.error and player_name ~= 'server' then player_return({'commands.command-ran'},defines.textcolor.info) end
game.write_file('commands.log', game.write_file('commands.log',
game.tick game.tick
..' Player: "'..player_name..'"' ..' Player: "'..player_name..'"'

View File

@@ -121,7 +121,7 @@ end
-- @param[opt='server'] by_player the player who is giving the rank -- @param[opt='server'] by_player the player who is giving the rank
-- @param[opt=game.tick] tick the tick that the rank is being given on -- @param[opt=game.tick] tick the tick that the rank is being given on
function Ranking.give_rank(player,rank,by_player,tick) function Ranking.give_rank(player,rank,by_player,tick)
local print_colour = defines.text_color.info local print_colour = defines.textcolor.info
local tick = tick or game.tick local tick = tick or game.tick
local by_player_name = Game.get_player(by_player) and Game.get_player(by_player).name or game.player and game.player.name or is_type(by_player,'string') and by_player or 'server' local by_player_name = Game.get_player(by_player) and Game.get_player(by_player).name or game.player and game.player.name or is_type(by_player,'string') and by_player or 'server'
local rank = Ranking.get_rank(rank) or Ranking.get_rank(Ranking._presets().meta.default) local rank = Ranking.get_rank(rank) or Ranking.get_rank(Ranking._presets().meta.default)
@@ -154,7 +154,7 @@ function Ranking.give_rank(player,rank,by_player,tick)
if rank.group.name == 'Jail' and Ranking._presets().last_jail ~= player.name then if rank.group.name == 'Jail' and Ranking._presets().last_jail ~= player.name then
Sync.emit_embeded{ Sync.emit_embeded{
title='Player Jail', title='Player Jail',
color=Color.to_hex(defines.text_color.med), color=Color.to_hex(defines.textcolor.med),
description='There was a player jailed.', description='There was a player jailed.',
['Player:']=player.name, ['Player:']=player.name,
['By:']='<<inline>>'..by_player_name, ['By:']='<<inline>>'..by_player_name,

View File

@@ -122,7 +122,7 @@ function Server._thread_handler(event)
table.each(Server._threads().print_to,function(print_to,player_index,event) table.each(Server._threads().print_to,function(print_to,player_index,event)
if event.name == defines.events.on_tick then return true end if event.name == defines.events.on_tick then return true end
if print_to[event.name] then if print_to[event.name] then
player_return(event,defines.text_color.bg,player_index) player_return(event,defines.textcolor.bg,player_index)
end end
end,event) end,event)
local event_id = event.name local event_id = event.name

View File

@@ -93,7 +93,7 @@ end
-- set up error handle -- set up error handle
verbose('Set New Error Handle') verbose('Set New Error Handle')
_G.error_handle = function(err) _G.error_handle = function(err)
local color = _G.Color and Color.to_hex(defines.text_color.bg) or '0x0' local color = _G.Color and Color.to_hex(defines.textcolor.bg) or '0x0'
Sync.emit_embeded{title='SCRIPT ERROR',color=color,description='There was an error in the script @Developers ',Error=err} Sync.emit_embeded{title='SCRIPT ERROR',color=color,description='There was an error in the script @Developers ',Error=err}
end end

View File

@@ -91,15 +91,25 @@ end
-- @usage Manager.setVerbose[setting] -- returns the value of that setting -- @usage Manager.setVerbose[setting] -- returns the value of that setting
-- @usage tostring(Manager.setVerbose) -- returns a formated list of the current settings -- @usage tostring(Manager.setVerbose) -- returns a formated list of the current settings
Manager.setVerbose = setmetatable( Manager.setVerbose = setmetatable(
--- Different verbose settings used for setVerbose
-- @table Manager.verboseSettings
-- @tfield boolean selfInit called while the manager is being set up
-- @tfield boolean moduleLoad when a module is required by the manager
-- @tfield boolean moduleInit when and within the initation of a module
-- @tfield boolean moduleEnv during module runtime, this is a global option set within each module(module_verbose=true ln:1) for fine control
-- @tfield boolean eventRegistered when a module registers its event handlers
-- @tfield boolean errorCaught when an error is caught during runtime
-- @tfield function output can be: print || log || or other function
-- @field _output a constant value that can used to store output data
{ {
selfInit=true, -- called while the manager is being set up selfInit=true,
moduleLoad=false, -- when a module is required by the manager moduleLoad=false,
moduleInit=false, -- when and within the initation of a module moduleInit=false,
moduleEnv=false, -- during module runtime, this is a global option set within each module(module_verbose=true ln:1) for fine control moduleEnv=false,
eventRegistered=false, -- when a module registers its event handlers eventRegistered=false,
errorCaught=true, -- when an error is caught during runtime errorCaught=true,
output=Manager._verbose, -- can be: print || log || or other function output=Manager._verbose,
_output={} -- a constant value that can used to store output data _output={}
}, },
{ {
__metatable=false, __metatable=false,
@@ -442,7 +452,6 @@ Manager.event = setmetatable({
--- Sub set to Manger.event and acts as a coverter between event_name and event_id --- Sub set to Manger.event and acts as a coverter between event_name and event_id
-- @table Manager.event.names -- @table Manager.event.names
-- @usage Manager.event[event_name] -- @usage Manager.event[event_name]
-- @see Manager.event
rawset(Manager.event,'names',setmetatable({},{ rawset(Manager.event,'names',setmetatable({},{
__index=function(tbl,key) __index=function(tbl,key)
if type(key) == 'number' or tonumber(key) then if type(key) == 'number' or tonumber(key) then

View File

@@ -45,9 +45,9 @@
<li><a href="modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="modules/Color.html">Color</a></li> <li><a href="modules/Color.html">Color</a></li>
<li><a href="modules/Game.html">Game</a></li> <li><a href="modules/Game.html">Game</a></li>
<li><a href="modules/string.html">string</a></li> <li><a href="modules/String.html">String</a></li>
<li><a href="modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -120,15 +120,15 @@
<td class="summary">The game module.</td> <td class="summary">The game module.</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="modules/string.html">string</a></td> <td class="name" nowrap><a href="modules/String.html">String</a></td>
<td class="summary">Extends Lua 5.2 string.</td> <td class="summary">Extends Lua 5.2 string.</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="modules/table.html">table</a></td> <td class="name" nowrap><a href="modules/Table.html">Table</a></td>
<td class="summary">Extends Lua 5.2 table.</td> <td class="summary">Extends Lua 5.2 table.</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="modules/defines.time.html">defines.time</a></td> <td class="name" nowrap><a href="modules/Time.html">Time</a></td>
<td class="summary">A defines module for retrieving the number of ticks in 1 unit of time.</td> <td class="summary">A defines module for retrieving the number of ticks in 1 unit of time.</td>
</tr> </tr>
</table> </table>
@@ -148,7 +148,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -1,244 +1,303 @@
/* universal */ /* BEGIN RESET
body{background-color:#0F0F0F;color:#C8C8C8;font-family:'Lucida Grande',Arial,sans-serif} Copyright (c) 2010, Yahoo! Inc. All rights reserved.
a{text-decoration:none;border-style:none;outline:none!important} Code licensed under the BSD License:
a:link{color:#FF7200;text-decoration:none} http://developer.yahoo.com/yui/license.html
a:visited{color:#FF7200;text-decoration:none} version: 2.8.2r1
a:hover{color:#C8C8C8;text-decoration:none} */
a:active{color:#C8C8C8;text-decoration:none} html {
h1{font-size:2.5rem} color: #000;
h2{font-size:2.3rem} background: #FFF;
h3{font-size:2rem} }
h4{font-size:1.8rem} 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 {
h5{font-size:1.6rem} 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 {
/* table */ margin-left: 1em;
margin-right: 1em;
table,thead{text-align:left} font-family: arial, helvetica, geneva, sans-serif;
table,th,td{padding:2px} background-color: #ffffff; margin: 0px;
/* sidebar */
.sidebar {height: 100%}
.sidebar-custom {
border-right: 1px solid #2C2C2C;
padding-right: 1.4rem;
bottom: 0rem;
} }
@supports (-ms-ime-align:auto) { code, tt { font-family: monospace; font-size: 1.1em; }
.sidebar-custom { span.parameter { font-family:monospace; }
height: 99%; 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;
} }
.up-to-top { blockquote { margin-left: 3em; }
top: 1.5rem;
position: -webkit-sticky; ul { list-style-type: disc; }
position: sticky;
text-align: right; p.name {
margin-right: 0.2rem; font-family: "Andale Mono", monospace;
padding-top: 1em;
} }
.up-to-top a{padding:20px} pre {
.up-to-top a:link{color:#FF7200} background-color: rgb(245, 245, 245);
.up-to-top a:hover{color:#C8C8C8} border: 1px solid #C0C0C0; /* silver */
.icon-arrow-right-custom{margin-bottom:3px} padding: 10px;
.project-infobox{text-align:right} margin: 10px 0 10px 0;
.project-infobox .project-desc{font-style:italic} overflow: auto;
.nav-modules{text-align:right} font-family: "Andale Mono", monospace;
.nav-module-contents{text-align:right} }
pre.example {
font-size: .85em;
}
/* navigation */ table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
.nav .nav a{color:#FF7200} #container {
.nav .nav a:link{color:#FF7200} margin-left: 1em;
.nav .nav a:visited{color:#FF7200} margin-right: 1em;
.nav .nav a:hover{color:#C8C8C8;text-decoration:none} background-color: #f0f0f0;
.nav .nav-item.active>a:hover{color:#C8C8C8;text-decoration:none} }
.nav .nav-item.active{margin-left:0}
.nav .nav a:active{color:#C8C8C8}
#product {
text-align: center;
border-bottom: 1px solid #cccccc;
background-color: #ffffff;
}
/* main page module list */ #product big {
font-size: 2em;
}
.body-module-name {font-weight: 500} #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;
}
}
table.module_list { table.module_list {
border-spacing: 0; border-width: 1px;
display: table; border-style: solid;
border-color: #cccccc;
border-collapse: collapse; border-collapse: collapse;
margin-bottom: 2.0rem;
} }
table.module_list td { table.module_list td {
border-top: 1px solid #2C2C2C; border-width: 1px;
border-bottom: 1px solid #2C2C2C; padding: 3px;
padding: 3px 7px 3px 7px; border-style: solid;
border-color: #cccccc;
} }
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.module_list td.summary {vertical-align: top} table.function_list {
border-width: 1px;
.module_list p {margin:0px} border-style: solid;
border-color: #cccccc;
/* 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; border-collapse: collapse;
margin-bottom: 1.5rem;
} }
table.function_list td {
table.section-content-list td { border-width: 1px;
border-top: 1px solid #2C2C2C; padding: 3px;
border-bottom: 1px solid #2C2C2C; border-style: solid;
padding: 3px 7px 3px 7px; border-color: #cccccc;
} }
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
table.function_list td.summary { width: 100%; }
table.section-content-list td.name { ul.nowrap {
background-color: #0D0D0D; overflow:auto;
vertical-align: top;
white-space:nowrap; white-space:nowrap;
} }
table.section-content-list td.summary { dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
min-width: 200px; dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
vertical-align: top; dl.table h3, dl.function h3 {font-size: .95em;}
}
.section-content-list p {margin: 0px} /* 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; }
div.section-item-header .section-item-title { /* make the target distinct; helps when we're navigating to a function */
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace; a:target + * {
font-size: 1.5rem; background-color: #FF9;
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}
} }
/* tablets */ /* 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; }
@media screen and (min-width: 540px) and (max-width: 780px) {
.sidebar-footer {white-space: nowrap}
}

View File

@@ -53,9 +53,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><strong>Color</strong></li> <li><strong>Color</strong></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -111,6 +111,10 @@
<td class="name" nowrap><a href="#defines.lightcolor">defines.lightcolor</a></td> <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>
<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> </table>
<br/> <br/>
@@ -151,8 +155,8 @@
<h3>Returns:</h3> <h3>Returns:</h3>
<ol> <ol>
<span class="types"><span class="type">Concepts.Color</span></span> <span class="types"><span class="type">a</span></span>
a color table that has the specified value for the alpha channel color table that has the specified value for the alpha channel
</ol> </ol>
@@ -178,8 +182,8 @@
<h3>Returns:</h3> <h3>Returns:</h3>
<ol> <ol>
<span class="types"><span class="type">Concepts.Color</span></span> <span class="types"><span class="type">a</span></span>
a converted color &mdash; { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] } converted color &mdash; { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] }
</ol> </ol>
@@ -254,8 +258,8 @@
<h3>Returns:</h3> <h3>Returns:</h3>
<ol> <ol>
<span class="types"><span class="type">Concepts.Color</span></span> <span class="types"><span class="type">a</span></span>
a color table with RGB converted from Hex and with alpha color table with RGB converted from Hex and with alpha
</ol> </ol>
@@ -277,90 +281,67 @@
<h3>Fields:</h3> <h3>Fields:</h3>
<ul> <ul>
<li><span class="parameter">white</span> <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>
<li><span class="parameter">black</span> <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>
<li><span class="parameter">darkgrey</span> <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>
<li><span class="parameter">grey</span> <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>
<li><span class="parameter">lightgrey</span> <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>
<li><span class="parameter">red</span> <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>
<li><span class="parameter">darkred</span> <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>
<li><span class="parameter">lightred</span> <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>
<li><span class="parameter">green</span> <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>
<li><span class="parameter">darkgreen</span> <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>
<li><span class="parameter">lightgreen</span> <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>
<li><span class="parameter">blue</span> <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>
<li><span class="parameter">darkblue</span> <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>
<li><span class="parameter">lightblue</span> <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>
<li><span class="parameter">orange</span> <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>
<li><span class="parameter">yellow</span> <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>
<li><span class="parameter">pink</span> <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>
<li><span class="parameter">purple</span> <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>
<li><span class="parameter">brown</span> <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> </li>
</ul> </ul>
<h3>Usage:</h3>
<ul>
<pre class="example">color = defines.color.red</pre>
</ul>
</dd> </dd>
<dt> <dt>
@@ -374,79 +355,60 @@
<h3>Fields:</h3> <h3>Fields:</h3>
<ul> <ul>
<li><span class="parameter">green</span> <li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">grey</span> <li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">lightblue</span> <li><span class="parameter">lightblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">lightgreen</span> <li><span class="parameter">lightgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">lightgrey</span> <li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">lightred</span> <li><span class="parameter">lightred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">orange</span> <li><span class="parameter">orange</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">white</span> <li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">yellow</span> <li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.black defines.color.black
</li> </li>
<li><span class="parameter">black</span> <li><span class="parameter">black</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">blue</span> <li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">brown</span> <li><span class="parameter">brown</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">darkblue</span> <li><span class="parameter">darkblue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">darkgreen</span> <li><span class="parameter">darkgreen</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">darkgrey</span> <li><span class="parameter">darkgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">darkred</span> <li><span class="parameter">darkred</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">pink</span> <li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">purple</span> <li><span class="parameter">purple</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
<li><span class="parameter">red</span> <li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.white defines.color.white
</li> </li>
</ul> </ul>
@@ -467,35 +429,27 @@
<h3>Fields:</h3> <h3>Fields:</h3>
<ul> <ul>
<li><span class="parameter">white</span> <li><span class="parameter">white</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightgrey defines.color.lightgrey
</li> </li>
<li><span class="parameter">grey</span> <li><span class="parameter">grey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.darkgrey defines.color.darkgrey
</li> </li>
<li><span class="parameter">lightgrey</span> <li><span class="parameter">lightgrey</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.grey defines.color.grey
</li> </li>
<li><span class="parameter">red</span> <li><span class="parameter">red</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightred defines.color.lightred
</li> </li>
<li><span class="parameter">green</span> <li><span class="parameter">green</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightgreen defines.color.lightgreen
</li> </li>
<li><span class="parameter">blue</span> <li><span class="parameter">blue</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.lightblue defines.color.lightblue
</li> </li>
<li><span class="parameter">yellow</span> <li><span class="parameter">yellow</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.orange defines.color.orange
</li> </li>
<li><span class="parameter">pink</span> <li><span class="parameter">pink</span>
<span class="types"><span class="type">Concepts.Color</span></span>
defines.color.purple defines.color.purple
</li> </li>
</ul> </ul>
@@ -504,6 +458,41 @@
</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>
</dd> </dd>
</dl> </dl>
@@ -512,7 +501,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><strong>ExpGamingLib</strong></li> <li><strong>ExpGamingLib</strong></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -371,7 +371,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -53,9 +53,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -114,6 +114,10 @@
</table> </table>
<h2><a href="#Tables">Tables</a></h2> <h2><a href="#Tables">Tables</a></h2>
<table class="function_list"> <table class="function_list">
<tr>
<td class="name" nowrap><a href="#verboseSettings">verboseSettings</a></td>
<td class="summary">Different verbose settings used for setVerbose</td>
</tr>
<tr> <tr>
<td class="name" nowrap><a href="#Manager.event.names">Manager.event.names</a></td> <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> <td class="summary">Sub set to Manger.event and acts as a coverter between event_name and event_id</td>
@@ -335,6 +339,54 @@
<h2 class="section-header "><a name="Tables"></a>Tables</h2> <h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function"> <dl class="function">
<dt>
<a name = "verboseSettings"></a>
<strong>verboseSettings</strong>
</dt>
<dd>
Different verbose settings used for setVerbose
<h3>Fields:</h3>
<ul>
<li><span class="parameter">selfInit</span>
<span class="types"><span class="type">boolean</span></span>
called while the manager is being set up
</li>
<li><span class="parameter">moduleLoad</span>
<span class="types"><span class="type">boolean</span></span>
when a module is required by the manager
</li>
<li><span class="parameter">moduleInit</span>
<span class="types"><span class="type">boolean</span></span>
when and within the initation of a module
</li>
<li><span class="parameter">moduleEnv</span>
<span class="types"><span class="type">boolean</span></span>
during module runtime, this is a global option set within each module(module_verbose=true ln:1) for fine control
</li>
<li><span class="parameter">eventRegistered</span>
<span class="types"><span class="type">boolean</span></span>
when a module registers its event handlers
</li>
<li><span class="parameter">errorCaught</span>
<span class="types"><span class="type">boolean</span></span>
when an error is caught during runtime
</li>
<li><span class="parameter">output</span>
<span class="types"><span class="type">function</span></span>
can be: print || log || or other function
</li>
<li><span class="parameter">_output</span>
a constant value that can used to store output data
</li>
</ul>
</dd>
<dt> <dt>
<a name = "Manager.event.names"></a> <a name = "Manager.event.names"></a>
<strong>Manager.event.names</strong> <strong>Manager.event.names</strong>
@@ -346,9 +398,6 @@
<h3>See also:</h3>
<ul>
</ul>
<h3>Usage:</h3> <h3>Usage:</h3>
<ul> <ul>
@@ -363,7 +412,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><strong>Game</strong></li> <li><strong>Game</strong></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -224,7 +224,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

166
doc/modules/Time.html Normal file
View File

@@ -0,0 +1,166 @@
<!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="#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><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>
</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>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>
<table class="function_list">
<tr>
<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/>
<br/>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "defines.time"></a>
<strong>defines.time</strong>
</dt>
<dd>
Returns the number of ticks in a second, minute, hour, day, week, month, or year.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">second</span>
the number of Factorio ticks in a second
</li>
<li><span class="parameter">minute</span>
the number of Factorio ticks in a second
</li>
<li><span class="parameter">hour</span>
the number of Factorio ticks in an hour
</li>
<li><span class="parameter">day</span>
the number of Factorio ticks in an day
</li>
<li><span class="parameter">week</span>
the number of Factorio ticks in a week
</li>
<li><span class="parameter">month</span>
the number of Factorio ticks in a month (30 days)
</li>
<li><span class="parameter">year</span>
the number of Factorio ticks in a year (365 days)
</li>
</ul>
<h3>Usage:</h3>
<ul>
<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>
</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 22:53:53 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -129,7 +129,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -165,7 +165,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -283,7 +283,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -439,7 +439,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -186,7 +186,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -131,7 +131,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -122,7 +122,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -379,7 +379,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -564,7 +564,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -535,7 +535,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><strong>string</strong></li> <li><strong>String</strong></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -66,13 +66,9 @@
<div id="content"> <div id="content">
<h1>Module <code>string</code></h1> <h1>Module <code>String</code></h1>
<p>Extends Lua 5.2 string.</p> <p>Extends Lua 5.2 string.</p>
<p></p> <p></p>
<h3>See also:</h3>
<ul>
<a href="../modules/string.html#">string</a>
</ul>
<h2><a href="#Functions">Functions</a></h2> <h2><a href="#Functions">Functions</a></h2>
@@ -303,7 +299,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -52,9 +52,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><strong>table</strong></li> <li><strong>Table</strong></li>
<li><a href="../modules/defines.time.html">defines.time</a></li> <li><a href="../modules/Time.html">Time</a></li>
</ul> </ul>
<h2>Scripts</h2> <h2>Scripts</h2>
<ul class="nowrap"> <ul class="nowrap">
@@ -66,13 +66,9 @@
<div id="content"> <div id="content">
<h1>Module <code>table</code></h1> <h1>Module <code>Table</code></h1>
<p>Extends Lua 5.2 table.</p> <p>Extends Lua 5.2 table.</p>
<p></p> <p></p>
<h3>See also:</h3>
<ul>
<a href="../modules/table.html#">table</a>
</ul>
<h2><a href="#Functions">Functions</a></h2> <h2><a href="#Functions">Functions</a></h2>
@@ -172,7 +168,7 @@
<td class="summary">Returns a value in a form able to be read as a key</td> <td class="summary">Returns a value in a form able to be read as a key</td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap><a href="#to_string">to_string (tbl)</a></td> <td class="name" nowrap><a href="#tostring">tostring (tbl)</a></td>
<td class="summary">Returns a table in a form able to be read as a table</td> <td class="summary">Returns a table in a form able to be read as a table</td>
</tr> </tr>
<tr> <tr>
@@ -366,17 +362,11 @@
</ol> </ol>
<h3>See also:</h3>
<ul>
<a href="../modules/table.html#find">table.find</a>
</ul>
<h3>Usage:</h3> <h3>Usage:</h3>
<ul> <ul>
<li><pre class="example">a= { <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>} <li><pre class="example">a= { <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>} <span class="global">table</span>.any(a, <span class="keyword">function</span>(v) <span class="keyword">return</span> v % <span class="number">2</span> == <span class="number">0</span> <span class="keyword">end</span>) <span class="comment">--produces: true</span></pre></li>
<span class="global">table</span>.any(a, <span class="keyword">function</span>(v) <span class="keyword">return</span> v % <span class="number">2</span> == <span class="number">0</span> <span class="keyword">end</span>) <span class="comment">--produces: true</span></pre></li> <li><pre class="example">a = {<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>} <span class="global">table</span>.any(a, <span class="keyword">function</span>(v, k, x) <span class="keyword">return</span> k % <span class="number">2</span> == <span class="number">1</span> <span class="keyword">end</span>) <span class="comment">--produces: true</span></pre></li>
<li><pre class="example">a = {<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>}
<span class="global">table</span>.any(a, <span class="keyword">function</span>(v, k, x) <span class="keyword">return</span> k % <span class="number">2</span> == <span class="number">1</span> <span class="keyword">end</span>) <span class="comment">--produces: true</span></pre></li>
</ul> </ul>
</dd> </dd>
@@ -978,8 +968,8 @@ some_func(<span class="number">1</span>,<span class="number">2</span>) <span cla
</dd> </dd>
<dt> <dt>
<a name = "to_string"></a> <a name = "tostring"></a>
<strong>to_string (tbl)</strong> <strong>tostring (tbl)</strong>
</dt> </dt>
<dd> <dd>
Returns a table in a form able to be read as a table Returns a table in a form able to be read as a table
@@ -1138,7 +1128,7 @@ some_func(<span class="number">1</span>,<span class="number">2</span>) <span cla
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -53,9 +53,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
</div> </div>
@@ -78,7 +78,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </body>

View File

@@ -53,9 +53,9 @@
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li> <li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
<li><a href="../modules/Color.html">Color</a></li> <li><a href="../modules/Color.html">Color</a></li>
<li><a href="../modules/Game.html">Game</a></li> <li><a href="../modules/Game.html">Game</a></li>
<li><a href="../modules/string.html">string</a></li> <li><a href="../modules/String.html">String</a></li>
<li><a href="../modules/table.html">table</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/Time.html">Time</a></li>
</ul> </ul>
</div> </div>
@@ -78,7 +78,7 @@
</div> <!-- id="main" --> </div> <!-- id="main" -->
<div id="about"> <div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> <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-29 22:53:53 </i>
</div> <!-- id="about" --> </div> <!-- id="about" -->
</div> <!-- id="container" --> </div> <!-- id="container" -->
</body> </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=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 -- @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) function ExpLib.player_return(rtn,colour,player)
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 colour = ExpLib.is_type(colour) == 'table' and colour or defines.textcolor[colour] ~= defines.color.white and defines.textcolor[colour] or defines.color[colour]
local player = player or game.player local player = player or game.player
local function _return(callback,rtn) local function _return(callback,rtn)
if ExpLib.is_type(rtn,'table') then if ExpLib.is_type(rtn,'table') then

View File

@@ -12,26 +12,26 @@
defines = defines or {} --luacheck: ignore defines (This is used for testing locally) defines = defines or {} --luacheck: ignore defines (This is used for testing locally)
--- A table of colors allowing retrieval by color name. --- A table of colors allowing retrieval by color name.
-- @usage color = defines.color.red -- @table defines.color
-- @tfield Concepts.Color white -- @field white {r=1.00,g=1.00,b=1.00}
-- @tfield Concepts.Color black -- @field black {r=0.00,g=0.00,b=0.00}
-- @tfield Concepts.Color darkgrey -- @field darkgrey {r=0.25,g=0.25,b=0.25}
-- @tfield Concepts.Color grey -- @field grey {r=0.50,g=0.50,b=0.50}
-- @tfield Concepts.Color lightgrey -- @field lightgrey {r=0.75,g=0.75,b=0.75}
-- @tfield Concepts.Color red -- @field red {r=1.00,g=0.00,b=0.00}
-- @tfield Concepts.Color darkred -- @field darkred {r=0.50,g=0.00,b=0.00}
-- @tfield Concepts.Color lightred -- @field lightred {r=1.00,g=0.50,b=0.50}
-- @tfield Concepts.Color green -- @field green {r=0.00,g=1.00,b=0.00}
-- @tfield Concepts.Color darkgreen -- @field darkgreen {r=0.00,g=0.50,b=0.00}
-- @tfield Concepts.Color lightgreen -- @field lightgreen {r=0.50,g=1.00,b=0.50}
-- @tfield Concepts.Color blue -- @field blue {r=0.00,g=0.00,b=1.00}
-- @tfield Concepts.Color darkblue -- @field darkblue {r=0.00,g=0.00,b=0.50}
-- @tfield Concepts.Color lightblue -- @field lightblue {r=0.50,g=0.50,b=1.00}
-- @tfield Concepts.Color orange -- @field orange {r=1.00,g=0.55,b=0.10}
-- @tfield Concepts.Color yellow -- @field yellow {r=1.00,g=1.00,b=0.00}
-- @tfield Concepts.Color pink -- @field pink {r=1.00,g=0.00,b=1.00}
-- @tfield Concepts.Color purple -- @field purple {r=0.60,g=0.10,b=0.60}
-- @tfield Concepts.Color brown -- @field brown {r=0.60,g=0.40,b=0.10}
defines.color = { defines.color = {
white={r=1.00,g=1.00,b=1.00}, white={r=1.00,g=1.00,b=1.00},
black={r=0.00,g=0.00,b=0.00}, black={r=0.00,g=0.00,b=0.00},
@@ -54,77 +54,55 @@ defines.color = {
brown={r=0.60,g=0.40,b=0.10} brown={r=0.60,g=0.40,b=0.10}
} }
local colors = defines.color local colors = defines.color
--- Returns white for dark colors or black for lighter colors. --- Returns white for dark colors or black for lighter colors.
-- @tfield Concepts.Color green defines.color.black -- @table defines.anticolor
-- @tfield Concepts.Color grey defines.color.black
-- @tfield Concepts.Color lightblue defines.color.black
-- @tfield Concepts.Color lightgreen defines.color.black
-- @tfield Concepts.Color lightgrey defines.color.black
-- @tfield Concepts.Color lightred defines.color.black
-- @tfield Concepts.Color orange defines.color.black
-- @tfield Concepts.Color white defines.color.black
-- @tfield Concepts.Color yellow defines.color.black
-- @tfield Concepts.Color black defines.color.white
-- @tfield Concepts.Color blue defines.color.white
-- @tfield Concepts.Color brown defines.color.white
-- @tfield Concepts.Color darkblue defines.color.white
-- @tfield Concepts.Color darkgreen defines.color.white
-- @tfield Concepts.Color darkgrey defines.color.white
-- @tfield Concepts.Color darkred defines.color.white
-- @tfield Concepts.Color pink defines.color.white
-- @tfield Concepts.Color purple defines.color.white
-- @tfield Concepts.Color red defines.color.white
defines.anticolor = { defines.anticolor = {
green = colors.black, green = colors.black, -- defines.color.black
grey = colors.black, grey = colors.black, -- defines.color.black
lightblue = colors.black, lightblue = colors.black, -- defines.color.black
lightgreen = colors.black, lightgreen = colors.black, -- defines.color.black
lightgrey = colors.black, lightgrey = colors.black, -- defines.color.black
lightred = colors.black, lightred = colors.black, -- defines.color.black
orange = colors.black, orange = colors.black, -- defines.color.black
white = colors.black, white = colors.black, -- defines.color.black
yellow = colors.black, yellow = colors.black, -- defines.color.black
black = colors.white, black = colors.white, -- defines.color.white
blue = colors.white, blue = colors.white, -- defines.color.white
brown = colors.white, brown = colors.white, -- defines.color.white
darkblue = colors.white, darkblue = colors.white, -- defines.color.white
darkgreen = colors.white, darkgreen = colors.white, -- defines.color.white
darkgrey = colors.white, darkgrey = colors.white, -- defines.color.white
darkred = colors.white, darkred = colors.white, -- defines.color.white
pink = colors.white, pink = colors.white, -- defines.color.white
purple = colors.white, purple = colors.white, -- defines.color.white
red = colors.white red = colors.white -- defines.color.white
} }
--- Returns a lighter color of a named color. --- Returns a lighter color of a named color.
-- @tfield Concepts.Color white defines.color.lightgrey -- @table defines.lightcolor
-- @tfield Concepts.Color grey defines.color.darkgrey
-- @tfield Concepts.Color lightgrey defines.color.grey
-- @tfield Concepts.Color red defines.color.lightred
-- @tfield Concepts.Color green defines.color.lightgreen
-- @tfield Concepts.Color blue defines.color.lightblue
-- @tfield Concepts.Color yellow defines.color.orange
-- @tfield Concepts.Color pink defines.color.purple
defines.lightcolor = { defines.lightcolor = {
white = colors.lightgrey, white = colors.lightgrey, -- defines.color.lightgrey
grey = colors.darkgrey, grey = colors.darkgrey, -- defines.color.darkgrey
lightgrey = colors.grey, lightgrey = colors.grey, -- defines.color.grey
red = colors.lightred, red = colors.lightred, -- defines.color.lightred
green = colors.lightgreen, green = colors.lightgreen, -- defines.color.lightgreen
blue = colors.lightblue, blue = colors.lightblue, -- defines.color.lightblue
yellow = colors.orange, yellow = colors.orange, -- defines.color.orange
pink = colors.purple pink = colors.purple -- defines.color.purple
} }
-- added by cooldude2606 -- added by cooldude260
--- Returns a lighter color of a named color. --- Returns a lighter color of a named color.
-- @tfield Concepts.Color info -- @table defines.textcolor
-- @tfield Concepts.Color bg -- @field info {r=0.21,g=0.95,b=1.00}
-- @tfield Concepts.Color low -- @field bg {r=0.00,g=0.00,b=0.00}
-- @tfield Concepts.Color med -- @field low {r=0.18,g=0.77,b=0.18}
-- @tfield Concepts.Color high -- @field med {r=1.00,g=0.89,b=0.26}
-- @tfield Concepts.Color crit -- @field high {r=1.00,g=0.33,b=0.00}
defines.text_color = { -- @field crit {r=1.00,g=0.00,b=0.00}
defines.textcolor = {
info={r=0.21,g=0.95,b=1.00}, info={r=0.21,g=0.95,b=1.00},
bg={r=0.00,g=0.00,b=0.00}, bg={r=0.00,g=0.00,b=0.00},
low={r=0.18,g=0.77,b=0.18}, low={r=0.18,g=0.77,b=0.18},
@@ -152,7 +130,7 @@ local _mt = {
setmetatable(defines.color, _mt) setmetatable(defines.color, _mt)
setmetatable(defines.anticolor, _mt) setmetatable(defines.anticolor, _mt)
setmetatable(defines.text_color, _mt) setmetatable(defines.textcolor, _mt)
setmetatable(defines.lightcolor, _mt) setmetatable(defines.lightcolor, _mt)
local Color = {} --luacheck: allow defined top local Color = {} --luacheck: allow defined top
@@ -166,7 +144,7 @@ local Color = {} --luacheck: allow defined top
-- </ul> -- </ul>
-- @tparam[opt=white] defines.color|Concepts.Color color the color to configure -- @tparam[opt=white] defines.color|Concepts.Color color the color to configure
-- @tparam[opt=1] float alpha the alpha value (*[0 - 1]*) to set for the given color -- @tparam[opt=1] float alpha the alpha value (*[0 - 1]*) to set for the given color
-- @treturn Concepts.Color a color table that has the specified value for the alpha channel -- @treturn a color table that has the specified value for the alpha channel
function Color.set(color, alpha) function Color.set(color, alpha)
color = color or defines.color.white color = color or defines.color.white
Color.to_table(color) Color.to_table(color)
@@ -176,7 +154,7 @@ end
--- Converts a color in the array format to a color in the table format. --- Converts a color in the array format to a color in the table format.
-- @tparam table c_arr the color to convert -- @tparam table c_arr the color to convert
-- @treturn Concepts.Color a converted color &mdash; { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] } -- @treturn a converted color &mdash; { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] }
function Color.to_table(c_arr) function Color.to_table(c_arr)
if #c_arr > 0 then if #c_arr > 0 then
return {r = c_arr[1], g = c_arr[2], b = c_arr[3], a = c_arr[4]} return {r = c_arr[1], g = c_arr[2], b = c_arr[3], a = c_arr[4]}
@@ -202,7 +180,7 @@ end
-- Optionally provide the value for the alpha channel. -- Optionally provide the value for the alpha channel.
-- @tparam string hex hexadecimal color string (#ffffff, not #fff) -- @tparam string hex hexadecimal color string (#ffffff, not #fff)
-- @tparam[opt=1] float alpha the alpha value to set; such that ***[ 0 &#8924; value &#8924; 1 ]*** -- @tparam[opt=1] float alpha the alpha value to set; such that ***[ 0 &#8924; value &#8924; 1 ]***
-- @treturn Concepts.Color a color table with RGB converted from Hex and with alpha -- @treturn a color table with RGB converted from Hex and with alpha
function Color.from_hex(hex, alpha) function Color.from_hex(hex, alpha)
if not _G.Game then error('StdLib/Game not loaded') end if not _G.Game then error('StdLib/Game not loaded') end
_G.Game.fail_if_missing(hex, "missing color hex value") _G.Game.fail_if_missing(hex, "missing color hex value")

View File

@@ -69,11 +69,8 @@ end
--- Given a candidate search function, iterates over the table, calling the function --- Given a candidate search function, iterates over the table, calling the function
-- for each element in the table, and returns true if search function returned true. -- for each element in the table, and returns true if search function returned true.
-- Passes the index as second argument to the function. -- Passes the index as second argument to the function.
-- @see table.find -- @usage a= { 1, 2, 3, 4, 5} table.any(a, function(v) return v % 2 == 0 end) --produces: true
--- @usage a= { 1, 2, 3, 4, 5} -- @usage a = {1, 2, 3, 4, 5} table.any(a, function(v, k, x) return k % 2 == 1 end) --produces: true
---table.any(a, function(v) return v % 2 == 0 end) --produces: true
--- @usage a = {1, 2, 3, 4, 5}
---table.any(a, function(v, k, x) return k % 2 == 1 end) --produces: true
-- @tparam table tbl the table to be searched -- @tparam table tbl the table to be searched
-- @tparam function func the function to use to search for any matching element -- @tparam function func the function to use to search for any matching element
-- @param[opt] ... additional arguments passed to the function -- @param[opt] ... additional arguments passed to the function

View File

@@ -30,3 +30,7 @@ defines.time = {
month = MONTH, -- the number of Factorio ticks in a month (30 days) month = MONTH, -- the number of Factorio ticks in a month (30 days)
year = YEAR, -- the number of Factorio ticks in a year (365 days) 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})