mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-29 20:16:38 +09:00
Added production to control
This commit is contained in:
Cooldude2606
@@ -5,15 +5,25 @@ title = 'ExpGaming Scenario'
|
||||
description = 'Explosive Gaming\'s server scenario for 0.17'
|
||||
|
||||
convert_opt = true
|
||||
sort = true
|
||||
sort = false
|
||||
not_luadoc = true
|
||||
no_lua_ref = true
|
||||
template_escape = ">"
|
||||
topics = {"../README.md", "../LICENSE"}
|
||||
style = '../doc'
|
||||
template = '../doc'
|
||||
no_space_before_args = true
|
||||
|
||||
new_type("core", "Core", true)
|
||||
new_type("addon", "Addons", true)
|
||||
new_type("commands", "Commands", true)
|
||||
new_type("control", "Control", true)
|
||||
new_type("gui", "Guis", true)
|
||||
new_type("config", "Configs", true)
|
||||
|
||||
new_type("dep", "Dependencies", false)
|
||||
new_type("event", "Events", false, "Event Parameters")
|
||||
new_type("command", "Commands", false, "Command Parameters")
|
||||
|
||||
local api_url = "http://lua-api.factorio.com/latest/%s.html%s"
|
||||
|
||||
|
||||
1169
doc/control/Jail.html
Normal file
1169
doc/control/Jail.html
Normal file
File diff suppressed because it is too large
Load Diff
1284
doc/control/Production.html
Normal file
1284
doc/control/Production.html
Normal file
File diff suppressed because it is too large
Load Diff
1033
doc/control/Reports.html
Normal file
1033
doc/control/Reports.html
Normal file
File diff suppressed because it is too large
Load Diff
1426
doc/control/Warnings.html
Normal file
1426
doc/control/Warnings.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -34,8 +34,6 @@
|
||||
<!-- project full description -->
|
||||
</div>
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
</div>
|
||||
<!-- sidebar end -->
|
||||
@@ -44,6 +42,29 @@
|
||||
<div class="column col-9 col-sm-12">
|
||||
|
||||
<!-- module list on the main page start -->
|
||||
<h2>Control</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name"><a href="control/Jail.html">Jail</a></td>
|
||||
<td class="summary"><span>Control Module - Jail
|
||||
- Adds a way to jail players and temp ban players.</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="control/Production.html">Production</a></td>
|
||||
<td class="summary"><span>Control Module - Production
|
||||
- Common functions used to track production of items</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="control/Reports.html">Reports</a></td>
|
||||
<td class="summary"><span>Control Module - Reports
|
||||
- Adds a way to report players and store report messages.</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="control/Warnings.html">Warnings</a></td>
|
||||
<td class="summary"><span>Control Module - Warnings
|
||||
- Adds a way to give and remove warnings to players.</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2>Modules</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
@@ -274,21 +295,6 @@
|
||||
<td class="name"><a href="modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></td>
|
||||
<td class="summary"><span>Displays the amount of dmg that is done by players to entities
|
||||
also shows player health when a player is attacked</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="modules/Jail.html">Jail</a></td>
|
||||
<td class="summary"><span>Control Module - Jail
|
||||
- Adds a way to jail players and temp ban players.</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="modules/Reports.html">Reports</a></td>
|
||||
<td class="summary"><span>Control Module - Reports
|
||||
- Adds a way to report players and store report messages.</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="modules/Warnings.html">Warnings</a></td>
|
||||
<td class="summary"><span>Control Module - Warnings
|
||||
- Adds a way to give and remove warnings to players.</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="modules/modules.gui.player-list.html">modules.gui.player-list</a></td>
|
||||
@@ -380,7 +386,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
26
doc/ldoc.ltp
26
doc/ldoc.ltp
@@ -73,7 +73,22 @@
|
||||
|
||||
> if module then
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
> if module and module.type ~= "topic" then
|
||||
> if module and not ldoc.no_summary and #module.items > 0 then
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
> for kind,items in module.kinds() do
|
||||
<li class="nav-item"><a href="#$(no_spaces(kind))"><span class="fragment-hashtag">#</span> $(kind)</a></li>
|
||||
> end
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
> end
|
||||
> end
|
||||
> if not ldoc.no_summary then
|
||||
> local this_mod = module and module.name
|
||||
> for kind, mods, type in ldoc.kinds() do
|
||||
@@ -111,13 +126,15 @@
|
||||
> end
|
||||
|
||||
> end
|
||||
|
||||
</div>
|
||||
> if module and module.type ~= "topic" then
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
> if module and module.type ~= "topic" then
|
||||
> if module and not ldoc.no_summary and #module.items > 0 then
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>$(display_name(module))</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
> for kind,items in module.kinds() do
|
||||
<li class="nav-item"><a href="#$(no_spaces(kind))"><span class="fragment-hashtag">#</span> $(kind)</a></li>
|
||||
@@ -127,9 +144,6 @@
|
||||
</ul>
|
||||
> end
|
||||
> end
|
||||
</div>
|
||||
> if module and module.type ~= "topic" then
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
> end
|
||||
|
||||
@@ -35,14 +35,23 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Dependencies"><span class="fragment-hashtag">#</span> Dependencies</a></li>
|
||||
<li class="nav-item"><a href="#Events"><span class="fragment-hashtag">#</span> Events</a></li>
|
||||
<li class="nav-item"><a href="#Jail_functions"><span class="fragment-hashtag">#</span> Jail functions </a></li>
|
||||
<li class="nav-item"><a href="#Temp_ban_functions"><span class="fragment-hashtag">#</span> Temp ban functions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -89,6 +98,7 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.advanced-start.html"><span class="module-name-item">modules.addons.advanced-start</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.chat-popups.html"><span class="module-name-item">modules.addons.chat-popups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.damage-popups.html"><span class="module-name-item">modules.addons.damage-popups</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.player-list.html"><span class="module-name-item">modules.gui.player-list</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.rocket-info.html"><span class="module-name-item">modules.gui.rocket-info</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.science-info.html"><span class="module-name-item">modules.gui.science-info</span></a></div></li>
|
||||
@@ -109,6 +119,16 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,20 +138,20 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>Jail</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Dependencies"><span class="fragment-hashtag">#</span> Dependencies</a></li>
|
||||
<li class="nav-item"><a href="#Events"><span class="fragment-hashtag">#</span> Events</a></li>
|
||||
<li class="nav-item"><a href="#Jail_functions"><span class="fragment-hashtag">#</span> Jail functions </a></li>
|
||||
<li class="nav-item"><a href="#Temp_ban_functions"><span class="fragment-hashtag">#</span> Temp ban functions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -159,6 +179,9 @@
|
||||
<!-- module usage start -->
|
||||
<h3>Usage</h3>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">-- import the module from the control modules
|
||||
</span> <span class="keyword">local</span> Jail = <span class="global">require</span> <span class="string">'modules.control.jail'</span>
|
||||
|
||||
<span class="comment">-- This will move 'MrBiter' to the jail role and remove all other roles from them
|
||||
</span> <span class="comment">-- the player name and reason are only so they can be included in the event for user feedback
|
||||
</span> Jail.jail_player(<span class="string">'MrBiter'</span>,<span class="string">'Cooldude2606'</span>,<span class="string">'Likes biters too much'</span>)
|
||||
@@ -177,6 +200,30 @@
|
||||
<!-- module section list start -->
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Dependencies">Dependencies</a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#expcore.roles">expcore.roles</a></td>
|
||||
<td class="summary">Allows moving players into the jail role</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#utils.game">utils.game</a></td>
|
||||
<td class="summary">Allows accessing a player from any value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#utils.global">utils.global</a></td>
|
||||
<td class="summary">Allows storing data in the global table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#expcore.common">expcore.common</a></td>
|
||||
<td class="summary">Use of move_items to clear inventroies</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Events">Events</a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
@@ -186,14 +233,14 @@
|
||||
<td class="summary">When a player is assigned to jail</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_player_temp_banned">on_player_temp_banned</a></td>
|
||||
<td class="summary">When a player is temp banned</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_player_unjailed">on_player_unjailed</a></td>
|
||||
<td class="summary">When a player is unassigned from jail</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_player_temp_banned">on_player_temp_banned</a></td>
|
||||
<td class="summary">When a player is temp banned</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_player_untemp_banned">on_player_untemp_banned</a></td>
|
||||
<td class="summary">When a temp ban is removed from a player</td>
|
||||
</tr>
|
||||
@@ -244,6 +291,117 @@
|
||||
<br />
|
||||
|
||||
<!-- section start -->
|
||||
<h3><span id="Dependencies" class="section-title"><a href="#Dependencies">Dependencies</a></span></h3>
|
||||
<dl class="section-body-container">
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#expcore.roles" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="expcore.roles">expcore.roles</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Allows moving players into the jail role</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#utils.game" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="utils.game">utils.game</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Allows accessing a player from any value</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#utils.global" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="utils.global">utils.global</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Allows storing data in the global table</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#expcore.common" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="expcore.common">expcore.common</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Use of move_items to clear inventroies</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3><span id="Events" class="section-title"><a href="#Events">Events</a></span></h3>
|
||||
<dl class="section-body-container">
|
||||
<dt>
|
||||
@@ -321,6 +479,72 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_player_unjailed" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_player_unjailed">on_player_unjailed</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">When a player is unassigned from jail</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Event Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player_index</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the index of the player who was unjailed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>by_player_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the player who unjailed the other player
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -403,72 +627,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_player_unjailed" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_player_unjailed">on_player_unjailed</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">When a player is unassigned from jail</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Event Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player_index</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the index of the player who was unjailed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>by_player_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the player who unjailed the other player
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -1003,7 +1161,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 22:35:58 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
1281
doc/modules/Production.html
Normal file
1281
doc/modules/Production.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -36,13 +36,22 @@
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Events"><span class="fragment-hashtag">#</span> Events</a></li>
|
||||
<li class="nav-item"><a href="#Dependencies"><span class="fragment-hashtag">#</span> Dependencies</a></li>
|
||||
<li class="nav-item"><a href="#Get_functions"><span class="fragment-hashtag">#</span> Get functions </a></li>
|
||||
<li class="nav-item"><a href="#Set_functions"><span class="fragment-hashtag">#</span> Set functions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -89,6 +98,10 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.advanced-start.html"><span class="module-name-item">modules.addons.advanced-start</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.chat-popups.html"><span class="module-name-item">modules.addons.chat-popups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.damage-popups.html"><span class="module-name-item">modules.addons.damage-popups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.player-list.html"><span class="module-name-item">modules.gui.player-list</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.rocket-info.html"><span class="module-name-item">modules.gui.rocket-info</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.science-info.html"><span class="module-name-item">modules.gui.science-info</span></a></div></li>
|
||||
@@ -118,20 +131,20 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>Reports</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Events"><span class="fragment-hashtag">#</span> Events</a></li>
|
||||
<li class="nav-item"><a href="#Dependencies"><span class="fragment-hashtag">#</span> Dependencies</a></li>
|
||||
<li class="nav-item"><a href="#Get_functions"><span class="fragment-hashtag">#</span> Get functions </a></li>
|
||||
<li class="nav-item"><a href="#Set_functions"><span class="fragment-hashtag">#</span> Set functions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -159,6 +172,9 @@
|
||||
<!-- module usage start -->
|
||||
<h3>Usage</h3>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">-- import the module from the control modules
|
||||
</span> <span class="keyword">local</span> Reports = <span class="global">require</span> <span class="string">'modules.control.reports'</span>
|
||||
|
||||
<span class="comment">-- This will place a report on "MrBiter" (must be a valid player) the report will have been made
|
||||
</span> <span class="comment">-- by "Cooldude2606" (must be the player name) with the reason 'Liking biters too much' this can be
|
||||
</span> <span class="comment">-- seen by using Reports.get_report.
|
||||
@@ -197,26 +213,42 @@
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Dependencies">Dependencies</a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#utils.game">utils.game</a></td>
|
||||
<td class="summary">Allows getting player from any value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#utils.global">utils.global</a></td>
|
||||
<td class="summary">Allows storing of data in global table</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Get_functions">Get functions </a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#count_reports">count_reports (player[, custom_count])</a></td>
|
||||
<td class="summary">Counts the number of reports that a player has aganist them</td>
|
||||
<td class="name"><a href="#get_reports">get_reports (player)</a></td>
|
||||
<td class="summary">Gets a list of all reports that a player has against them</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#get_report">get_report (player, by_player_name)</a></td>
|
||||
<td class="summary">Gets a single report against a player given the name of the player who made the report</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#get_reports">get_reports (player)</a></td>
|
||||
<td class="summary">Gets a list of all reports that a player has against them</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#is_reported">is_reported (player[, by_player_name])</a></td>
|
||||
<td class="summary">Checks if a player is reported, option to get if reported by a certain player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#count_reports">count_reports (player[, custom_count])</a></td>
|
||||
<td class="summary">Counts the number of reports that a player has aganist them</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
@@ -226,16 +258,16 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#remove_all">remove_all (player)</a></td>
|
||||
<td class="summary">Removes all reports from a player</td>
|
||||
<td class="name"><a href="#report_player">report_player (player, by_player_name[, reason='Non given.'])</a></td>
|
||||
<td class="summary">Adds a report to a player, each player can only report another player once</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#remove_report">remove_report (player, reported_by_name)</a></td>
|
||||
<td class="summary">Removes a report from a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#report_player">report_player (player, by_player_name[, reason='Non given.'])</a></td>
|
||||
<td class="summary">Adds a report to a player, each player can only report another player once</td>
|
||||
<td class="name"><a href="#remove_all">remove_all (player)</a></td>
|
||||
<td class="summary">Removes all reports from a player</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -411,19 +443,76 @@
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3><span id="Get_functions" class="section-title"><a href="#Get_functions">Get functions </a></span></h3>
|
||||
<h3><span id="Dependencies" class="section-title"><a href="#Dependencies">Dependencies</a></span></h3>
|
||||
<dl class="section-body-container">
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#count_reports" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="count_reports">count_reports (player[, custom_count])</span>
|
||||
<a href="#utils.game" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="utils.game">utils.game</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Counts the number of reports that a player has aganist them</p>
|
||||
<p class="section-item-summary">Allows getting player from any value</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#utils.global" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="utils.global">utils.global</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Allows storing of data in global table</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3><span id="Get_functions" class="section-title"><a href="#Get_functions">Get functions </a></span></h3>
|
||||
<dl class="section-body-container">
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#get_reports" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="get_reports">get_reports (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets a list of all reports that a player has against them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -443,28 +532,11 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to count the reports for
|
||||
the player to get the report for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>custom_count</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
when given this function will be used to count the reports
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
@@ -473,8 +545,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of reports that the user has</span>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">a list of all reports, key is by player name, value is reason</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -553,63 +625,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#get_reports" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="get_reports">get_reports (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets a list of all reports that a player has against them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to get the report for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">a list of all reports, key is by player name, value is reason</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -684,6 +699,80 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#count_reports" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="count_reports">count_reports (player[, custom_count])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Counts the number of reports that a player has aganist them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to count the reports for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>custom_count</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
when given this function will be used to count the reports
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of reports that the user has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -697,136 +786,6 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#remove_all" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="remove_all">remove_all (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes all reports from a player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to remove the reports from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">whether the reports were removed successfully</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#remove_report" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="remove_report">remove_report (player, reported_by_name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a report from a player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to remove the report from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>reported_by_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the player that made the report
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">whether the report was removed successfully</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#report_player" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="report_player">report_player (player, by_player_name[, reason='Non given.'])</span>
|
||||
</div>
|
||||
@@ -907,6 +866,136 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#remove_report" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="remove_report">remove_report (player, reported_by_name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a report from a player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to remove the report from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>reported_by_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the player that made the report
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">whether the report was removed successfully</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#remove_all" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="remove_all">remove_all (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes all reports from a player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to remove the reports from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">whether the reports were removed successfully</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -929,7 +1018,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 22:15:42 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -36,13 +36,20 @@
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Events"><span class="fragment-hashtag">#</span> Events</a></li>
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -89,6 +96,10 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.advanced-start.html"><span class="module-name-item">modules.addons.advanced-start</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.chat-popups.html"><span class="module-name-item">modules.addons.chat-popups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.damage-popups.html"><span class="module-name-item">modules.addons.damage-popups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.player-list.html"><span class="module-name-item">modules.gui.player-list</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.rocket-info.html"><span class="module-name-item">modules.gui.rocket-info</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.science-info.html"><span class="module-name-item">modules.gui.science-info</span></a></div></li>
|
||||
@@ -118,19 +129,18 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>Warnings</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Events"><span class="fragment-hashtag">#</span> Events</a></li>
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -182,14 +192,6 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_script_warning_added">on_script_warning_added</a></td>
|
||||
<td class="summary">When a warning is added to a player, by the script</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_script_warning_removed">on_script_warning_removed</a></td>
|
||||
<td class="summary">When a warning is remnoved from a player, by the script</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_warning_added">on_warning_added</a></td>
|
||||
<td class="summary">When a warning is added to a player</td>
|
||||
</tr>
|
||||
@@ -197,6 +199,14 @@
|
||||
<td class="name"><a href="#on_warning_removed">on_warning_removed</a></td>
|
||||
<td class="summary">When a warning is removed from a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_script_warning_added">on_script_warning_added</a></td>
|
||||
<td class="summary">When a warning is added to a player, by the script</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#on_script_warning_removed">on_script_warning_removed</a></td>
|
||||
<td class="summary">When a warning is remnoved from a player, by the script</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
@@ -206,44 +216,44 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#add_script_warning">add_script_warning (player[, reason='Non given.'])</a></td>
|
||||
<td class="summary">Adds a script warning to a player, this may add a full warning if max script warnings is met</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#add_warning">add_warning (player, by_player_name[, reason='Non given.'])</a></td>
|
||||
<td class="summary">Adds a warning to a player, when a warning is added a set action is done based on the number of warnings and the config file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#clear_script_warnings">clear_script_warnings (player)</a></td>
|
||||
<td class="summary">Removes all script warnings from a player, emits event for each warning removed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#clear_warnings">clear_warnings (player, by_player_name)</a></td>
|
||||
<td class="summary">Removes all warnings from a player, will trigger remove event for each warning</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#count_script_warnings">count_script_warnings (player)</a></td>
|
||||
<td class="summary">Gets the number of script warnings that a player has on them</td>
|
||||
<td class="name"><a href="#get_warnings">get_warnings (player)</a></td>
|
||||
<td class="summary">Gets an array of warnings that the player has, always returns a list even if emtpy</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#count_warnings">count_warnings (player)</a></td>
|
||||
<td class="summary">Gets the number of warnings that a player has on them</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#add_warning">add_warning (player, by_player_name[, reason='Non given.'])</a></td>
|
||||
<td class="summary">Adds a warning to a player, when a warning is added a set action is done based on the number of warnings and the config file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#remove_warning">remove_warning (player, by_player_name)</a></td>
|
||||
<td class="summary">Removes a warning from a player, always removes the earlyist warning, fifo</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#clear_warnings">clear_warnings (player, by_player_name)</a></td>
|
||||
<td class="summary">Removes all warnings from a player, will trigger remove event for each warning</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#get_script_warnings">get_script_warnings (player)</a></td>
|
||||
<td class="summary">Gets an array of all the script warnings that a player has</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#get_warnings">get_warnings (player)</a></td>
|
||||
<td class="summary">Gets an array of warnings that the player has, always returns a list even if emtpy</td>
|
||||
<td class="name"><a href="#count_script_warnings">count_script_warnings (player)</a></td>
|
||||
<td class="summary">Gets the number of script warnings that a player has on them</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#add_script_warning">add_script_warning (player[, reason='Non given.'])</a></td>
|
||||
<td class="summary">Adds a script warning to a player, this may add a full warning if max script warnings is met</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#remove_script_warning">remove_script_warning (player)</a></td>
|
||||
<td class="summary">Removes a script warning from a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#remove_warning">remove_warning (player, by_player_name)</a></td>
|
||||
<td class="summary">Removes a warning from a player, always removes the earlyist warning, fifo</td>
|
||||
<td class="name"><a href="#clear_script_warnings">clear_script_warnings (player)</a></td>
|
||||
<td class="summary">Removes all script warnings from a player, emits event for each warning removed</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -257,154 +267,6 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_script_warning_added" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_script_warning_added">on_script_warning_added</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">When a warning is added to a player, by the script</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Event Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player_index</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the index of the player who recived the warning
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>reason</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the reason that the player was given a warning
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>warning_count</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the new number of warnings that the player has
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_script_warning_removed" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_script_warning_removed">on_script_warning_removed</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">When a warning is remnoved from a player, by the script</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Event Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player_index</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the index of the player who is having the warning removed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>warning_count</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the new number of warnings that the player has
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_warning_added" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_warning_added">on_warning_added</span>
|
||||
</div>
|
||||
@@ -570,6 +432,154 @@
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>warning_count</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the new number of warnings that the player has
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_script_warning_added" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_script_warning_added">on_script_warning_added</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">When a warning is added to a player, by the script</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Event Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player_index</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the index of the player who recived the warning
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>reason</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the reason that the player was given a warning
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>warning_count</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the new number of warnings that the player has
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#on_script_warning_removed" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="on_script_warning_removed">on_script_warning_removed</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">When a warning is remnoved from a player, by the script</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Event Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player_index</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the index of the player who is having the warning removed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>warning_count</em></strong>
|
||||
@@ -604,14 +614,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#add_script_warning" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="add_script_warning">add_script_warning (player[, reason='Non given.'])</span>
|
||||
<a href="#get_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="get_warnings">get_warnings (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a script warning to a player, this may add a full warning if max script warnings is met</p>
|
||||
<p class="section-item-summary">Gets an array of warnings that the player has, always returns a list even if emtpy</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -631,25 +641,65 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to add a script warning to
|
||||
the player to get the warning for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">an array of all the warnings on this player, contains tick, by_player_name and reason</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#count_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="count_warnings">count_warnings (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets the number of warnings that a player has on them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>reason</em></strong>
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the reason that the player is being warned
|
||||
the player to count the warnings for
|
||||
|
||||
(<em>default</em>: 'Non given.')
|
||||
</li>
|
||||
|
||||
|
||||
@@ -662,7 +712,7 @@
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of script warnings that the player has</span>
|
||||
<span class="return-text">the number of warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -768,14 +818,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#clear_script_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="clear_script_warnings">clear_script_warnings (player)</span>
|
||||
<a href="#remove_warning" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="remove_warning">remove_warning (player, by_player_name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes all script warnings from a player, emits event for each warning removed</p>
|
||||
<p class="section-item-summary">Removes a warning from a player, always removes the earlyist warning, fifo</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -795,7 +845,23 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to clear the script warnings from
|
||||
the player to remove a warning from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>by_player_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the player who is doing the action
|
||||
|
||||
</li>
|
||||
|
||||
@@ -805,6 +871,13 @@
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
@@ -881,120 +954,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#count_script_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="count_script_warnings">count_script_warnings (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets the number of script warnings that a player has on them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to count the script warnings of
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of script warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#count_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="count_warnings">count_warnings (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets the number of warnings that a player has on them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to count the warnings for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -1062,14 +1021,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#get_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="get_warnings">get_warnings (player)</span>
|
||||
<a href="#count_script_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="count_script_warnings">count_script_warnings (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets an array of warnings that the player has, always returns a list even if emtpy</p>
|
||||
<p class="section-item-summary">Gets the number of script warnings that a player has on them</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -1089,7 +1048,7 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to get the warning for
|
||||
the player to count the script warnings of
|
||||
|
||||
</li>
|
||||
|
||||
@@ -1102,8 +1061,82 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">an array of all the warnings on this player, contains tick, by_player_name and reason</span>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of script warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#add_script_warning" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="add_script_warning">add_script_warning (player[, reason='Non given.'])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a script warning to a player, this may add a full warning if max script warnings is met</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to add a script warning to
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>reason</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the reason that the player is being warned
|
||||
|
||||
(<em>default</em>: 'Non given.')
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of script warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -1176,14 +1209,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#remove_warning" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="remove_warning">remove_warning (player, by_player_name)</span>
|
||||
<a href="#clear_script_warnings" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="clear_script_warnings">clear_script_warnings (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a warning from a player, always removes the earlyist warning, fifo</p>
|
||||
<p class="section-item-summary">Removes all script warnings from a player, emits event for each warning removed</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -1203,23 +1236,7 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to remove a warning from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>by_player_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the player who is doing the action
|
||||
the player to clear the script warnings from
|
||||
|
||||
</li>
|
||||
|
||||
@@ -1229,13 +1246,6 @@
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of warnings that the player has</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
@@ -1261,7 +1271,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 22:15:42 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -173,7 +181,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -174,7 +182,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -172,7 +180,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -172,7 +180,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -171,7 +179,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -174,7 +182,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -173,7 +181,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>config.rockets</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -166,13 +182,13 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#show_progress">show_progress</a></td>
|
||||
<td class="summary">The data and buttons in the build progress section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#show_stats">show_stats</a></td>
|
||||
<td class="summary">The data that will show in the stats section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#show_progress">show_progress</a></td>
|
||||
<td class="summary">The data and buttons in the build progress section</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
@@ -185,14 +201,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#show_progress" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="show_progress">show_progress</span>
|
||||
<a href="#show_stats" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="show_stats">show_stats</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">The data and buttons in the build progress section</p>
|
||||
<p class="section-item-summary">The data that will show in the stats section</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -212,14 +228,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#show_stats" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="show_stats">show_stats</span>
|
||||
<a href="#show_progress" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="show_progress">show_progress</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">The data that will show in the stats section</p>
|
||||
<p class="section-item-summary">The data and buttons in the build progress section</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -251,7 +267,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -173,7 +181,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -174,7 +182,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.concepts.center</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,49 +183,49 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:draw_frame">CenterFrames._prototype:draw_frame (player)</a></td>
|
||||
<td class="summary">Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:event_handler">CenterFrames._prototype:event_handler ([action=update])</a></td>
|
||||
<td class="summary">Creates an event handler that will trigger one of its functions, use with Event.add</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:redraw_frame">CenterFrames._prototype:redraw_frame (player)</a></td>
|
||||
<td class="summary">Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:set_auto_focus">CenterFrames._prototype:set_auto_focus ([state=true])</a></td>
|
||||
<td class="summary">Sets the frame to be the current active gui when opened and closes all other frames</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:toggle_frame">CenterFrames._prototype:toggle_frame (player)</a></td>
|
||||
<td class="summary">Toggles if the frame is open, if open it will close it and if closed it will open it</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.clear_flow">CenterFrames.clear_flow (player)</a></td>
|
||||
<td class="summary">Clears the center flow for a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.draw_frame">CenterFrames.draw_frame (player, name)</a></td>
|
||||
<td class="summary">Draws the center frame for a player, if already open then will do nothing</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.get_flow">CenterFrames.get_flow (player)</a></td>
|
||||
<td class="name"><a href="#CenterFrames.get_flow">CenterFrames.get_flow(player)</a></td>
|
||||
<td class="summary">Gets the center flow for a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.new_frame">CenterFrames.new_frame (permision_name)</a></td>
|
||||
<td class="summary">Creates a new center frame define</td>
|
||||
<td class="name"><a href="#CenterFrames.clear_flow">CenterFrames.clear_flow(player)</a></td>
|
||||
<td class="summary">Clears the center flow for a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.redraw_frame">CenterFrames.redraw_frame (player, name)</a></td>
|
||||
<td class="name"><a href="#CenterFrames.draw_frame">CenterFrames.draw_frame(player, name)</a></td>
|
||||
<td class="summary">Draws the center frame for a player, if already open then will do nothing</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.redraw_frame">CenterFrames.redraw_frame(player, name)</a></td>
|
||||
<td class="summary">Draws the center frame for a player, if already open then will destroy it and redraw</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.toggle_frame">CenterFrames.toggle_frame (player, name[, state])</a></td>
|
||||
<td class="name"><a href="#CenterFrames.toggle_frame">CenterFrames.toggle_frame(player, name[, state])</a></td>
|
||||
<td class="summary">Toggles if the frame is currently open or not, will open if closed and close if open</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames.new_frame">CenterFrames.new_frame(permision_name)</a></td>
|
||||
<td class="summary">Creates a new center frame define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:set_auto_focus">CenterFrames._prototype:set_auto_focus([state=true])</a></td>
|
||||
<td class="summary">Sets the frame to be the current active gui when opened and closes all other frames</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:draw_frame">CenterFrames._prototype:draw_frame(player)</a></td>
|
||||
<td class="summary">Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:redraw_frame">CenterFrames._prototype:redraw_frame(player)</a></td>
|
||||
<td class="summary">Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:toggle_frame">CenterFrames._prototype:toggle_frame(player)</a></td>
|
||||
<td class="summary">Toggles if the frame is open, if open it will close it and if closed it will open it</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#CenterFrames._prototype:event_handler">CenterFrames._prototype:event_handler([action=update])</a></td>
|
||||
<td class="summary">Creates an event handler that will trigger one of its functions, use with Event.add</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
@@ -222,14 +238,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:draw_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:draw_frame">CenterFrames._prototype:draw_frame (player)</span>
|
||||
<a href="#CenterFrames.get_flow" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.get_flow">CenterFrames.get_flow(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)</p>
|
||||
<p class="section-item-summary">Gets the center flow for a player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -249,7 +265,7 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to draw the frame for
|
||||
the player to get the flow for
|
||||
|
||||
</li>
|
||||
|
||||
@@ -263,223 +279,7 @@
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the new frame that was drawn</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:event_handler" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:event_handler">CenterFrames._prototype:event_handler ([action=update])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates an event handler that will trigger one of its functions, use with Event.add</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>action</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the action to take on this event
|
||||
|
||||
(<em>default</em>: update)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:redraw_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:redraw_frame">CenterFrames._prototype:redraw_frame (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to draw the frame for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the new frame that was drawn</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:set_auto_focus" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:set_auto_focus">CenterFrames._prototype:set_auto_focus ([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the frame to be the current active gui when opened and closes all other frames</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
when true will auto close other frames and set this frame as player.opened
|
||||
|
||||
(<em>default</em>: true)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:toggle_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:toggle_frame">CenterFrames._prototype:toggle_frame (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Toggles if the frame is open, if open it will close it and if closed it will open it</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to draw the frame for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">with the gui frame is now open</span>
|
||||
<span class="return-text">the center flow</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -496,7 +296,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.clear_flow" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.clear_flow">CenterFrames.clear_flow (player)</span>
|
||||
<span class="section-item-title" id="CenterFrames.clear_flow">CenterFrames.clear_flow(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -546,7 +346,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.draw_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.draw_frame">CenterFrames.draw_frame (player, name)</span>
|
||||
<span class="section-item-title" id="CenterFrames.draw_frame">CenterFrames.draw_frame(player, name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -608,120 +408,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.get_flow" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.get_flow">CenterFrames.get_flow (player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets the center flow for a player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to get the flow for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the center flow</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.new_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.new_frame">CenterFrames.new_frame (permision_name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new center frame define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>permision_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name that can be used with the permision system
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new center frame define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -733,7 +419,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.redraw_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.redraw_frame">CenterFrames.redraw_frame (player, name)</span>
|
||||
<span class="section-item-title" id="CenterFrames.redraw_frame">CenterFrames.redraw_frame(player, name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -806,7 +492,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.toggle_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.toggle_frame">CenterFrames.toggle_frame (player, name[, state])</span>
|
||||
<span class="section-item-title" id="CenterFrames.toggle_frame">CenterFrames.toggle_frame(player, name[, state])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -885,6 +571,336 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames.new_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames.new_frame">CenterFrames.new_frame(permision_name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new center frame define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>permision_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name that can be used with the permision system
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new center frame define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:set_auto_focus" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:set_auto_focus">CenterFrames._prototype:set_auto_focus([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the frame to be the current active gui when opened and closes all other frames</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
when true will auto close other frames and set this frame as player.opened
|
||||
|
||||
(<em>default</em>: true)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:draw_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:draw_frame">CenterFrames._prototype:draw_frame(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to draw the frame for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the new frame that was drawn</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:redraw_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:redraw_frame">CenterFrames._prototype:redraw_frame(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to draw the frame for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the new frame that was drawn</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:toggle_frame" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:toggle_frame">CenterFrames._prototype:toggle_frame(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Toggles if the frame is open, if open it will close it and if closed it will open it</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to draw the frame for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">with the gui frame is now open</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#CenterFrames._prototype:event_handler" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="CenterFrames._prototype:event_handler">CenterFrames._prototype:event_handler([action=update])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates an event handler that will trigger one of its functions, use with Event.add</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>action</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the action to take on this event
|
||||
|
||||
(<em>default</em>: update)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -907,7 +923,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,21 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +116,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,19 +136,18 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.concepts.popups</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -168,24 +185,24 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames._prototype:open">PopupFrames._prototype:open (player[, open_time], ...)</a></td>
|
||||
<td class="summary">Opens this define for a player, can be given open time and any other params for the draw function</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames._prototype:set_default_open_time">PopupFrames._prototype:set_default_open_time (amount)</a></td>
|
||||
<td class="summary">Sets the default open time for the popup, will be used if non is provided with open</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.get_flow">PopupFrames.get_flow (player)</a></td>
|
||||
<td class="name"><a href="#PopupFrames.get_flow">PopupFrames.get_flow(player)</a></td>
|
||||
<td class="summary">Gets the left flow that contains the popup frames</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.new_popup">PopupFrames.new_popup ([name])</a></td>
|
||||
<td class="name"><a href="#PopupFrames.open">PopupFrames.open(define_name, player[, open_time], ...)</a></td>
|
||||
<td class="summary">Opens a popup for the player, can give the amount of time it is open as well as params for the draw function</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.new_popup">PopupFrames.new_popup([name])</a></td>
|
||||
<td class="summary">Creates a new popup frame define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.open">PopupFrames.open (define_name, player[, open_time], ...)</a></td>
|
||||
<td class="summary">Opens a popup for the player, can give the amount of time it is open as well as params for the draw function</td>
|
||||
<td class="name"><a href="#PopupFrames._prototype:set_default_open_time">PopupFrames._prototype:set_default_open_time(amount)</a></td>
|
||||
<td class="summary">Sets the default open time for the popup, will be used if non is provided with open</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames._prototype:open">PopupFrames._prototype:open(player[, open_time], ...)</a></td>
|
||||
<td class="summary">Opens this define for a player, can be given open time and any other params for the draw function</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -196,13 +213,13 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.close_button">PopupFrames.close_button</a></td>
|
||||
<td class="summary">A button which can be used to close the gui before the timer runs out</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.close_progress">PopupFrames.close_progress</a></td>
|
||||
<td class="summary">Progress bar which when depleaded will close the popup frame</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#PopupFrames.close_button">PopupFrames.close_button</a></td>
|
||||
<td class="summary">A button which can be used to close the gui before the timer runs out</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
@@ -215,155 +232,8 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames._prototype:open" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames._prototype:open">PopupFrames._prototype:open (player[, open_time], ...)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Opens this define for a player, can be given open time and any other params for the draw function</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to open the popup for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>open_time</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><span class="type">any</span></span>)
|
||||
|
||||
the other params that you want to pass to your on_draw event
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the frame that was drawn, the inner gui flow which contains the content</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames._prototype:set_default_open_time" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames._prototype:set_default_open_time">PopupFrames._prototype:set_default_open_time (amount)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the default open time for the popup, will be used if non is provided with open</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>amount</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the number of ticks, by default, the popup will be open for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the define to allow for chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames.get_flow" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.get_flow">PopupFrames.get_flow (player)</span>
|
||||
<span class="section-item-title" id="PopupFrames.get_flow">PopupFrames.get_flow(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -409,64 +279,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames.new_popup" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.new_popup">PopupFrames.new_popup ([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new popup frame define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new popup frame define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -478,7 +290,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames.open" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.open">PopupFrames.open (define_name, player[, open_time], ...)</span>
|
||||
<span class="section-item-title" id="PopupFrames.open">PopupFrames.open(define_name, player[, open_time], ...)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -545,6 +357,211 @@
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><span class="type">any</span></span>)
|
||||
|
||||
the other params that you want to pass to your on_draw event
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the frame that was drawn, the inner gui flow which contains the content</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames.new_popup" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.new_popup">PopupFrames.new_popup([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new popup frame define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new popup frame define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames._prototype:set_default_open_time" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames._prototype:set_default_open_time">PopupFrames._prototype:set_default_open_time(amount)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the default open time for the popup, will be used if non is provided with open</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>amount</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the number of ticks, by default, the popup will be open for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the define to allow for chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames._prototype:open" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames._prototype:open">PopupFrames._prototype:open(player[, open_time], ...)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Opens this define for a player, can be given open time and any other params for the draw function</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>player</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaPlayer.html">LuaPlayer</a></span>)
|
||||
|
||||
the player to open the popup for
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>open_time</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
@@ -586,14 +603,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames.close_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.close_button">PopupFrames.close_button</span>
|
||||
<a href="#PopupFrames.close_progress" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.close_progress">PopupFrames.close_progress</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">A button which can be used to close the gui before the timer runs out</p>
|
||||
<p class="section-item-summary">Progress bar which when depleaded will close the popup frame</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -613,14 +630,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#PopupFrames.close_progress" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.close_progress">PopupFrames.close_progress</span>
|
||||
<a href="#PopupFrames.close_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="PopupFrames.close_button">PopupFrames.close_button</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Progress bar which when depleaded will close the popup frame</p>
|
||||
<p class="section-item-summary">A button which can be used to close the gui before the timer runs out</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -652,7 +669,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.concepts.toolbar</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,15 +183,15 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Toolbar.add_button">Toolbar.add_button (button)</a></td>
|
||||
<td class="summary">Adds an existing buttton to the toolbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Toolbar.new_button">Toolbar.new_button ([name])</a></td>
|
||||
<td class="name"><a href="#Toolbar.new_button">Toolbar.new_button([name])</a></td>
|
||||
<td class="summary">Adds a new button to the toolbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Toolbar.update">Toolbar.update (player)</a></td>
|
||||
<td class="name"><a href="#Toolbar.add_button">Toolbar.add_button(button)</a></td>
|
||||
<td class="summary">Adds an existing buttton to the toolbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Toolbar.update">Toolbar.update(player)</a></td>
|
||||
<td class="summary">Updates the player's toolbar with an new buttons or expected change in auth return</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -190,58 +206,8 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Toolbar.add_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Toolbar.add_button">Toolbar.add_button (button)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds an existing buttton to the toolbar</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>button</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
the button define for the button to be added
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Toolbar.new_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Toolbar.new_button">Toolbar.new_button ([name])</span>
|
||||
<span class="section-item-title" id="Toolbar.new_button">Toolbar.new_button([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -288,6 +254,56 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Toolbar.add_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Toolbar.add_button">Toolbar.add_button(button)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds an existing buttton to the toolbar</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>button</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
the button define for the button to be added
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -299,7 +315,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Toolbar.update" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Toolbar.update">Toolbar.update (player)</span>
|
||||
<span class="section-item-title" id="Toolbar.update">Toolbar.update(player)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -360,7 +376,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -173,7 +181,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.elements.buttons</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,20 +183,20 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Button._prototype:set_click_filter">Button._prototype:set_click_filter (filter[, ...])</a></td>
|
||||
<td class="summary">Adds a click / mouse button filter to the button</td>
|
||||
<td class="name"><a href="#Button.new_button">Button.new_button([name])</a></td>
|
||||
<td class="summary">Creates a new button element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Button._prototype:set_key_filter">Button._prototype:set_key_filter (filter[, ...])</a></td>
|
||||
<td class="summary">Adds a control key filter to the button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Button._prototype:set_sprites">Button._prototype:set_sprites (sprite[, hovered_sprite][, clicked_sprite])</a></td>
|
||||
<td class="name"><a href="#Button._prototype:set_sprites">Button._prototype:set_sprites(sprite[, hovered_sprite][, clicked_sprite])</a></td>
|
||||
<td class="summary">Adds sprites to a button making it a spirte button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Button.new_button">Button.new_button ([name])</a></td>
|
||||
<td class="summary">Creates a new button element define</td>
|
||||
<td class="name"><a href="#Button._prototype:set_click_filter">Button._prototype:set_click_filter(filter[, ...])</a></td>
|
||||
<td class="summary">Adds a click / mouse button filter to the button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Button._prototype:set_key_filter">Button._prototype:set_key_filter(filter[, ...])</a></td>
|
||||
<td class="summary">Adds a control key filter to the button</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -194,14 +210,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Button._prototype:set_click_filter" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button._prototype:set_click_filter">Button._prototype:set_click_filter (filter[, ...])</span>
|
||||
<a href="#Button.new_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button.new_button">Button.new_button([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a click / mouse button filter to the button</p>
|
||||
<p class="section-item-summary">Creates a new button element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -215,29 +231,13 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>filter</em></strong>
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
?string|table either a of mouse buttons or the first mouse button to filter, with a table true means allowed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
when filter is not a you can add the mouse buttons one after each other
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
@@ -251,82 +251,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">returns the button define to allow chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Button._prototype:set_key_filter" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button._prototype:set_key_filter">Button._prototype:set_key_filter (filter[, ...])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a control key filter to the button</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>filter</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
?string|table either a of control keys or the first control keys to filter, with a table true means allowed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
when filter is not a you can add the control keyss one after each other
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">returns the button define to allow chaining</span>
|
||||
<span class="return-text">the new button element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -343,7 +269,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Button._prototype:set_sprites" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button._prototype:set_sprites">Button._prototype:set_sprites (sprite[, hovered_sprite][, clicked_sprite])</span>
|
||||
<span class="section-item-title" id="Button._prototype:set_sprites">Button._prototype:set_sprites(sprite[, hovered_sprite][, clicked_sprite])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -433,14 +359,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Button.new_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button.new_button">Button.new_button ([name])</span>
|
||||
<a href="#Button._prototype:set_click_filter" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button._prototype:set_click_filter">Button._prototype:set_click_filter(filter[, ...])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new button element define</p>
|
||||
<p class="section-item-summary">Adds a click / mouse button filter to the button</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -454,13 +380,29 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
<strong><em>filter</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
?string|table either a of mouse buttons or the first mouse button to filter, with a table true means allowed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
when filter is not a you can add the mouse buttons one after each other
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
@@ -474,8 +416,82 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">returns the button define to allow chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Button._prototype:set_key_filter" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Button._prototype:set_key_filter">Button._prototype:set_key_filter(filter[, ...])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a control key filter to the button</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>filter</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new button element define</span>
|
||||
|
||||
?string|table either a of control keys or the first control keys to filter, with a table true means allowed
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>...</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
|
||||
when filter is not a you can add the control keyss one after each other
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">returns the button define to allow chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -503,7 +519,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.elements.checkboxs</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,35 +183,35 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox._prototype_radiobutton:add_as_option">Checkbox._prototype_radiobutton:add_as_option (option_set, option_name)</a></td>
|
||||
<td class="summary">Adds this radiobutton to be an option in the given option set (only one can be true at a time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox._prototype_radiobutton:get_store">Checkbox._prototype_radiobutton:get_store (category, internal)</a></td>
|
||||
<td class="summary">Gets the stored value of the radiobutton or the option set if present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox._prototype_radiobutton:set_store">Checkbox._prototype_radiobutton:set_store (category, value, internal)</a></td>
|
||||
<td class="summary">Sets the stored value of the radiobutton or the option set if present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.draw_option_set">Checkbox.draw_option_set (name, element)</a></td>
|
||||
<td class="summary">Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.new_checkbox">Checkbox.new_checkbox ([name])</a></td>
|
||||
<td class="name"><a href="#Checkbox.new_checkbox">Checkbox.new_checkbox([name])</a></td>
|
||||
<td class="summary">Creates a new checkbox element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.new_option_set">Checkbox.new_option_set (name, callback, categorize)</a></td>
|
||||
<td class="summary">Registers a new option set that can be linked to radiobutotns (only one can be true at a time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.new_radiobutton">Checkbox.new_radiobutton ([name])</a></td>
|
||||
<td class="name"><a href="#Checkbox.new_radiobutton">Checkbox.new_radiobutton([name])</a></td>
|
||||
<td class="summary">Creates a new radiobutton element define, has all functions checkbox has</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.reset_radiobuttons">Checkbox.reset_radiobuttons (element[, exclude][, recursive=false])</a></td>
|
||||
<td class="name"><a href="#Checkbox._prototype_radiobutton:add_as_option">Checkbox._prototype_radiobutton:add_as_option(option_set, option_name)</a></td>
|
||||
<td class="summary">Adds this radiobutton to be an option in the given option set (only one can be true at a time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox._prototype_radiobutton:get_store">Checkbox._prototype_radiobutton:get_store(category, internal)</a></td>
|
||||
<td class="summary">Gets the stored value of the radiobutton or the option set if present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox._prototype_radiobutton:set_store">Checkbox._prototype_radiobutton:set_store(category, value, internal)</a></td>
|
||||
<td class="summary">Sets the stored value of the radiobutton or the option set if present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.new_option_set">Checkbox.new_option_set(name, callback, categorize)</a></td>
|
||||
<td class="summary">Registers a new option set that can be linked to radiobutotns (only one can be true at a time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.draw_option_set">Checkbox.draw_option_set(name, element)</a></td>
|
||||
<td class="summary">Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Checkbox.reset_radiobuttons">Checkbox.reset_radiobuttons(element[, exclude][, recursive=false])</a></td>
|
||||
<td class="summary">Sets all radiobutotn in a element to false (unless excluded) and can act recursivly</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -210,8 +226,124 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.new_checkbox" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.new_checkbox">Checkbox.new_checkbox([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new checkbox element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new checkbox element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.new_radiobutton" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.new_radiobutton">Checkbox.new_radiobutton([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new radiobutton element define, has all functions checkbox has</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new button element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox._prototype_radiobutton:add_as_option" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox._prototype_radiobutton:add_as_option">Checkbox._prototype_radiobutton:add_as_option (option_set, option_name)</span>
|
||||
<span class="section-item-title" id="Checkbox._prototype_radiobutton:add_as_option">Checkbox._prototype_radiobutton:add_as_option(option_set, option_name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -284,7 +416,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox._prototype_radiobutton:get_store" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox._prototype_radiobutton:get_store">Checkbox._prototype_radiobutton:get_store (category, internal)</span>
|
||||
<span class="section-item-title" id="Checkbox._prototype_radiobutton:get_store">Checkbox._prototype_radiobutton:get_store(category, internal)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -357,7 +489,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox._prototype_radiobutton:set_store" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox._prototype_radiobutton:set_store">Checkbox._prototype_radiobutton:set_store (category, value, internal)</span>
|
||||
<span class="section-item-title" id="Checkbox._prototype_radiobutton:set_store">Checkbox._prototype_radiobutton:set_store(category, value, internal)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -435,130 +567,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.draw_option_set" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.draw_option_set">Checkbox.draw_option_set (name, element)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the option set to draw the radiobuttons of
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>element</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
|
||||
the parent element that the radiobuttons will be drawn to
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.new_checkbox" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.new_checkbox">Checkbox.new_checkbox ([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new checkbox element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new checkbox element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -570,7 +578,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.new_option_set" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.new_option_set">Checkbox.new_option_set (name, callback, categorize)</span>
|
||||
<span class="section-item-title" id="Checkbox.new_option_set">Checkbox.new_option_set(name, callback, categorize)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -660,14 +668,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.new_radiobutton" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.new_radiobutton">Checkbox.new_radiobutton ([name])</span>
|
||||
<a href="#Checkbox.draw_option_set" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.draw_option_set">Checkbox.draw_option_set(name, element)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new radiobutton element define, has all functions checkbox has</p>
|
||||
<p class="section-item-summary">Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -687,9 +695,24 @@
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
the name of the option set to draw the radiobuttons of
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>element</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
|
||||
the parent element that the radiobuttons will be drawn to
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -698,13 +721,6 @@
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new button element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
@@ -719,7 +735,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Checkbox.reset_radiobuttons" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Checkbox.reset_radiobuttons">Checkbox.reset_radiobuttons (element[, exclude][, recursive=false])</span>
|
||||
<span class="section-item-title" id="Checkbox.reset_radiobuttons">Checkbox.reset_radiobuttons(element[, exclude][, recursive=false])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -821,7 +837,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.elements.dropdown</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,33 +183,33 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown._prototype:add_option_callback">Dropdown._prototype:add_option_callback (option, callback)</a></td>
|
||||
<td class="summary">Adds a case specific callback which will only run when that option is selected (general case still triggered)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown._prototype:new_dynamic_options">Dropdown._prototype:new_dynamic_options (callback)</a></td>
|
||||
<td class="summary">Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown._prototype:new_static_options">Dropdown._prototype:new_static_options (options[, ...], the)</a></td>
|
||||
<td class="summary">Adds new static options to the dropdown which will trigger the general callback</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown.get_selected_value">Dropdown.get_selected_value (element)</a></td>
|
||||
<td class="summary">Returns the currently selected value rather than index</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown.new_dropdown">Dropdown.new_dropdown ([name])</a></td>
|
||||
<td class="name"><a href="#Dropdown.new_dropdown">Dropdown.new_dropdown([name])</a></td>
|
||||
<td class="summary">Creates a new dropdown element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown.new_list_box">Dropdown.new_list_box ([name])</a></td>
|
||||
<td class="name"><a href="#Dropdown.new_list_box">Dropdown.new_list_box([name])</a></td>
|
||||
<td class="summary">Creates a new list box element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown.select_value">Dropdown.select_value (element, value)</a></td>
|
||||
<td class="name"><a href="#Dropdown._prototype:new_static_options">Dropdown._prototype:new_static_options(options[, ...], the)</a></td>
|
||||
<td class="summary">Adds new static options to the dropdown which will trigger the general callback</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown._prototype:new_dynamic_options">Dropdown._prototype:new_dynamic_options(callback)</a></td>
|
||||
<td class="summary">Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown._prototype:add_option_callback">Dropdown._prototype:add_option_callback(option, callback)</a></td>
|
||||
<td class="summary">Adds a case specific callback which will only run when that option is selected (general case still triggered)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown.select_value">Dropdown.select_value(element, value)</a></td>
|
||||
<td class="summary">Selects the option from a dropdown or list box given the value rather than key</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Dropdown.get_selected_value">Dropdown.get_selected_value(element)</a></td>
|
||||
<td class="summary">Returns the currently selected value rather than index</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
@@ -206,14 +222,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown._prototype:add_option_callback" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown._prototype:add_option_callback">Dropdown._prototype:add_option_callback (option, callback)</span>
|
||||
<a href="#Dropdown.new_dropdown" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.new_dropdown">Dropdown.new_dropdown([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a case specific callback which will only run when that option is selected (general case still triggered)</p>
|
||||
<p class="section-item-summary">Creates a new dropdown element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -227,33 +243,15 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>option</em></strong>
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the name of the option to trigger the callback on; if not already added then will be added as an option
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>callback</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
the function that will be called when that option is selected
|
||||
callback param - player LuaPlayer - the player who owns the gui element
|
||||
callback param - element LuaGuiElement - the element which is being effected
|
||||
callback param - value string - the new option that has been selected
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -265,8 +263,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">the define to allow chaining</span>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new dropdown element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -282,14 +280,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown._prototype:new_dynamic_options" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown._prototype:new_dynamic_options">Dropdown._prototype:new_dynamic_options (callback)</span>
|
||||
<a href="#Dropdown.new_list_box" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.new_list_box">Dropdown.new_list_box([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)</p>
|
||||
<p class="section-item-summary">Creates a new list box element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -303,17 +301,15 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>callback</em></strong>
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the function that will run to get the options for the dropdown
|
||||
callback param - player LuaPlayer - the player that the element is being drawn to
|
||||
callback param - element LuaGuiElement - the element that is being drawn
|
||||
callback return - table - the values of this table will be appended to the static options of the dropdown
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -325,8 +321,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">the define to allow chaining</span>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new list box element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -343,7 +339,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown._prototype:new_static_options" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown._prototype:new_static_options">Dropdown._prototype:new_static_options (options[, ...], the)</span>
|
||||
<span class="section-item-title" id="Dropdown._prototype:new_static_options">Dropdown._prototype:new_static_options(options[, ...], the)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -425,14 +421,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown.get_selected_value" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.get_selected_value">Dropdown.get_selected_value (element)</span>
|
||||
<a href="#Dropdown._prototype:new_dynamic_options" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown._prototype:new_dynamic_options">Dropdown._prototype:new_dynamic_options(callback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns the currently selected value rather than index</p>
|
||||
<p class="section-item-summary">Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -446,13 +442,16 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>element</em></strong>
|
||||
<strong><em>callback</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
the gui element that you want to get the value of
|
||||
the function that will run to get the options for the dropdown
|
||||
callback param - player LuaPlayer - the player that the element is being drawn to
|
||||
callback param - element LuaGuiElement - the element that is being drawn
|
||||
callback return - table - the values of this table will be appended to the static options of the dropdown
|
||||
|
||||
</li>
|
||||
|
||||
@@ -465,8 +464,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
<span class="return-text">the value that is currently selected</span>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">the define to allow chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -482,14 +481,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown.new_dropdown" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.new_dropdown">Dropdown.new_dropdown ([name])</span>
|
||||
<a href="#Dropdown._prototype:add_option_callback" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown._prototype:add_option_callback">Dropdown._prototype:add_option_callback(option, callback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new dropdown element define</p>
|
||||
<p class="section-item-summary">Adds a case specific callback which will only run when that option is selected (general case still triggered)</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -503,73 +502,33 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
<strong><em>option</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
the name of the option to trigger the callback on; if not already added then will be added as an option
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new dropdown element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown.new_list_box" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.new_list_box">Dropdown.new_list_box ([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new list box element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
<strong><em>callback</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
the function that will be called when that option is selected
|
||||
callback param - player LuaPlayer - the player who owns the gui element
|
||||
callback param - element LuaGuiElement - the element which is being effected
|
||||
callback param - value string - the new option that has been selected
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -581,8 +540,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new list box element define</span>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">the define to allow chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -599,7 +558,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown.select_value" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.select_value">Dropdown.select_value (element, value)</span>
|
||||
<span class="section-item-title" id="Dropdown.select_value">Dropdown.select_value(element, value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -661,6 +620,63 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Dropdown.get_selected_value" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Dropdown.get_selected_value">Dropdown.get_selected_value(element)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns the currently selected value rather than index</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>element</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
|
||||
the gui element that you want to get the value of
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
<span class="return-text">the value that is currently selected</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -683,7 +699,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,21 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +116,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,19 +136,18 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.elements.elem-button</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -168,12 +185,12 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#ElemButton._prototype:set_default">ElemButton._prototype:set_default (value)</a></td>
|
||||
<td class="summary">Sets the default value for the elem button, this may be a function or a string</td>
|
||||
<td class="name"><a href="#ElemButton.new_elem_button">ElemButton.new_elem_button([name])</a></td>
|
||||
<td class="summary">Creates a new elem button element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#ElemButton.new_elem_button">ElemButton.new_elem_button ([name])</a></td>
|
||||
<td class="summary">Creates a new elem button element define</td>
|
||||
<td class="name"><a href="#ElemButton._prototype:set_default">ElemButton._prototype:set_default(value)</a></td>
|
||||
<td class="summary">Sets the default value for the elem button, this may be a function or a string</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -199,65 +216,8 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#ElemButton._prototype:set_default" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="ElemButton._prototype:set_default">ElemButton._prototype:set_default (value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the default value for the elem button, this may be a function or a string</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>value</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a> or <a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
string a will be a static default and a function will be called when drawn to get the default
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">the</span></span>)
|
||||
<span class="return-text">element define to allow for chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#ElemButton.new_elem_button" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="ElemButton.new_elem_button">ElemButton.new_elem_button ([name])</span>
|
||||
<span class="section-item-title" id="ElemButton.new_elem_button">ElemButton.new_elem_button([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -304,6 +264,63 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#ElemButton._prototype:set_default" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="ElemButton._prototype:set_default">ElemButton._prototype:set_default(value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the default value for the elem button, this may be a function or a string</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>value</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a> or <a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
|
||||
|
||||
string a will be a static default and a function will be called when drawn to get the default
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">the</span></span>)
|
||||
<span class="return-text">element define to allow for chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -378,7 +395,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.elements.slider</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,20 +183,20 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Slider._prototype:draw_label">Slider._prototype:draw_label (element)</a></td>
|
||||
<td class="summary">Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player</td>
|
||||
<td class="name"><a href="#Slider.new_slider">Slider.new_slider([name])</a></td>
|
||||
<td class="summary">Creates a new slider element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Slider._prototype:enable_auto_draw_label">Slider._prototype:enable_auto_draw_label ([state=true])</a></td>
|
||||
<td class="summary">Enables auto draw of the label, the label will share the same parent element as the slider</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Slider._prototype:set_range">Slider._prototype:set_range ([min][, max])</a></td>
|
||||
<td class="name"><a href="#Slider._prototype:set_range">Slider._prototype:set_range([min][, max])</a></td>
|
||||
<td class="summary">Sets the range of a slider, if not used will use default values for a slider</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Slider.new_slider">Slider.new_slider ([name])</a></td>
|
||||
<td class="summary">Creates a new slider element define</td>
|
||||
<td class="name"><a href="#Slider._prototype:draw_label">Slider._prototype:draw_label(element)</a></td>
|
||||
<td class="summary">Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Slider._prototype:enable_auto_draw_label">Slider._prototype:enable_auto_draw_label([state=true])</a></td>
|
||||
<td class="summary">Enables auto draw of the label, the label will share the same parent element as the slider</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -194,14 +210,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Slider._prototype:draw_label" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider._prototype:draw_label">Slider._prototype:draw_label (element)</span>
|
||||
<a href="#Slider.new_slider" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider.new_slider">Slider.new_slider([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player</p>
|
||||
<p class="section-item-summary">Creates a new slider element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -215,14 +231,15 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>element</em></strong>
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the parent element that the lable will be drawn to
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -234,66 +251,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the new label element so that styles can be applied</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Slider._prototype:enable_auto_draw_label" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider._prototype:enable_auto_draw_label">Slider._prototype:enable_auto_draw_label ([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Enables auto draw of the label, the label will share the same parent element as the slider</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
when false will disable the auto draw of the label
|
||||
|
||||
(<em>default</em>: true)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">the define to allow chaining</span>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new slider element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -310,7 +269,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Slider._prototype:set_range" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider._prototype:set_range">Slider._prototype:set_range ([min][, max])</span>
|
||||
<span class="section-item-title" id="Slider._prototype:set_range">Slider._prototype:set_range([min][, max])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -384,14 +343,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Slider.new_slider" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider.new_slider">Slider.new_slider ([name])</span>
|
||||
<a href="#Slider._prototype:draw_label" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider._prototype:draw_label">Slider._prototype:draw_label(element)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new slider element define</p>
|
||||
<p class="section-item-summary">Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -405,15 +364,14 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
<strong><em>element</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
the parent element that the lable will be drawn to
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -425,8 +383,66 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new slider element define</span>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/LuaGuiElement.html">LuaGuiElement</a></span>)
|
||||
<span class="return-text">the new label element so that styles can be applied</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Slider._prototype:enable_auto_draw_label" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Slider._prototype:enable_auto_draw_label">Slider._prototype:enable_auto_draw_label([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Enables auto draw of the label, the label will share the same parent element as the slider</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
when false will disable the auto draw of the label
|
||||
|
||||
(<em>default</em>: true)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">the define to allow chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -454,7 +470,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.gui.elements.text</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,24 +183,24 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text._prototype_box:set_read_only">Text._prototype_box:set_read_only ([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to be read only</td>
|
||||
<td class="name"><a href="#Text.new_text_field">Text.new_text_field([name])</a></td>
|
||||
<td class="summary">Creates a new text field element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text._prototype_box:set_selectable">Text._prototype_box:set_selectable ([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to be selectable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text._prototype_box:set_word_wrap">Text._prototype_box:set_word_wrap ([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to have word wrap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text.new_text_box">Text.new_text_box ([name])</a></td>
|
||||
<td class="name"><a href="#Text.new_text_box">Text.new_text_box([name])</a></td>
|
||||
<td class="summary">Creates a new text box element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text.new_text_field">Text.new_text_field ([name])</a></td>
|
||||
<td class="summary">Creates a new text field element define</td>
|
||||
<td class="name"><a href="#Text._prototype_box:set_selectable">Text._prototype_box:set_selectable([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to be selectable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text._prototype_box:set_word_wrap">Text._prototype_box:set_word_wrap([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to have word wrap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Text._prototype_box:set_read_only">Text._prototype_box:set_read_only([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to be read only</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -198,14 +214,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Text._prototype_box:set_read_only" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text._prototype_box:set_read_only">Text._prototype_box:set_read_only ([state=true])</span>
|
||||
<a href="#Text.new_text_field" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text.new_text_field">Text.new_text_field([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the text box to be read only</p>
|
||||
<p class="section-item-summary">Creates a new text field element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -219,15 +235,15 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>state</em></strong>
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
when false will set the state to false
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>default</em>: true)
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -239,8 +255,66 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">table the define to allow for chaining</span>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new text field element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Text.new_text_box" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text.new_text_box">Text.new_text_box([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new text box element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new text box element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -257,7 +331,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Text._prototype_box:set_selectable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text._prototype_box:set_selectable">Text._prototype_box:set_selectable ([state=true])</span>
|
||||
<span class="section-item-title" id="Text._prototype_box:set_selectable">Text._prototype_box:set_selectable([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -315,7 +389,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Text._prototype_box:set_word_wrap" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text._prototype_box:set_word_wrap">Text._prototype_box:set_word_wrap ([state=true])</span>
|
||||
<span class="section-item-title" id="Text._prototype_box:set_word_wrap">Text._prototype_box:set_word_wrap([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -372,14 +446,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Text.new_text_box" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text.new_text_box">Text.new_text_box ([name])</span>
|
||||
<a href="#Text._prototype_box:set_read_only" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text._prototype_box:set_read_only">Text._prototype_box:set_read_only([state=true])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new text box element define</p>
|
||||
<p class="section-item-summary">Sets the text box to be read only</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -393,15 +467,15 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
<strong><em>state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
when false will set the state to false
|
||||
|
||||
(<em>optional</em>)
|
||||
(<em>default</em>: true)
|
||||
</li>
|
||||
|
||||
|
||||
@@ -413,66 +487,8 @@
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new text box element define</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Text.new_text_field" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Text.new_text_field">Text.new_text_field ([name])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Creates a new text field element define</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the optional debug name that can be added
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">the new text field element define</span>
|
||||
(<span class="types"><span class="type">self</span></span>)
|
||||
<span class="return-text">table the define to allow for chaining</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -500,7 +516,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -171,7 +179,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -171,7 +179,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -172,7 +180,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>expcore.store</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,33 +183,33 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.clear">Store.clear (location[, child][, from_sync])</a></td>
|
||||
<td class="summary">Sets the value at a location to nil, this location must be registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.get">Store.get (location[, child][, allow_unregistered=false])</a></td>
|
||||
<td class="summary">Gets the value stored at a location, this location must be registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.get_children">Store.get_children (location)</a></td>
|
||||
<td class="summary">Gets all non nil children at a location, children can be added and removed during runtime
|
||||
this is similar to Store.get but will always return a table even if it is empty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.is_registered">Store.is_registered (location)</a></td>
|
||||
<td class="name"><a href="#Store.is_registered">Store.is_registered(location)</a></td>
|
||||
<td class="summary">Check for if a lcoation is registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.register">Store.register ([location][, synced][, callback])</a></td>
|
||||
<td class="name"><a href="#Store.uid_location">Store.uid_location()</a></td>
|
||||
<td class="summary">Returns a unqiue name that can be used for a store</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.register">Store.register([location][, synced][, callback])</a></td>
|
||||
<td class="summary">Registers a new location with an update callback which is triggered when the value updates</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.set">Store.set (location[, child], value[, from_sync])</a></td>
|
||||
<td class="name"><a href="#Store.get">Store.get(location[, child][, allow_unregistered=false])</a></td>
|
||||
<td class="summary">Gets the value stored at a location, this location must be registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.set">Store.set(location[, child], value[, from_sync])</a></td>
|
||||
<td class="summary">Sets the value at a location, this location must be registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.uid_location">Store.uid_location ()</a></td>
|
||||
<td class="summary">Returns a unqiue name that can be used for a store</td>
|
||||
<td class="name"><a href="#Store.clear">Store.clear(location[, child][, from_sync])</a></td>
|
||||
<td class="summary">Sets the value at a location to nil, this location must be registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Store.get_children">Store.get_children(location)</a></td>
|
||||
<td class="summary">Gets all non nil children at a location, children can be added and removed during runtime
|
||||
this is similar to Store.get but will always return a table even if it is empty</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -207,248 +223,8 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.clear" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.clear">Store.clear (location[, child][, from_sync])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Sets the value at a location to nil, this location must be registered</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>location</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the location to set the data to
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>child</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the child location if required
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>from_sync</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
set this true to avoid an output to the sync file
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">true if it was successful</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.get" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.get">Store.get (location[, child][, allow_unregistered=false])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets the value stored at a location, this location must be registered</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>location</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the location to get the data from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>child</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the child location if required
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>allow_unregistered</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
when true no error is returned if the location is not registered
|
||||
|
||||
(<em>default</em>: false)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">any</span></span>)
|
||||
<span class="return-text">the data which was stored at the location</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.get_children" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.get_children">Store.get_children (location)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets all non nil children at a location, children can be added and removed during runtime
|
||||
this is similar to Store.get but will always return a table even if it is empty</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>location</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the location to get the children of
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">a table containg all the children names</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.is_registered" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.is_registered">Store.is_registered (location)</span>
|
||||
<span class="section-item-title" id="Store.is_registered">Store.is_registered(location)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -494,6 +270,40 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.uid_location" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.uid_location">Store.uid_location()</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns a unqiue name that can be used for a store</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
<span class="return-text">a unqiue name</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -505,7 +315,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.register" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.register">Store.register ([location][, synced][, callback])</span>
|
||||
<span class="section-item-title" id="Store.register">Store.register([location][, synced][, callback])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -586,6 +396,97 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.get" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.get">Store.get(location[, child][, allow_unregistered=false])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets the value stored at a location, this location must be registered</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>location</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the location to get the data from
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>child</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the child location if required
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>allow_unregistered</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
when true no error is returned if the location is not registered
|
||||
|
||||
(<em>default</em>: false)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><span class="type">any</span></span>)
|
||||
<span class="return-text">the data which was stored at the location</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -597,7 +498,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.set" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.set">Store.set (location[, child], value[, from_sync])</span>
|
||||
<span class="section-item-title" id="Store.set">Store.set(location[, child], value[, from_sync])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -703,25 +604,140 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.uid_location" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.uid_location">Store.uid_location ()</span>
|
||||
<a href="#Store.clear" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.clear">Store.clear(location[, child][, from_sync])</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns a unqiue name that can be used for a store</p>
|
||||
<p class="section-item-summary">Sets the value at a location to nil, this location must be registered</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>location</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the location to set the data to
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>child</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
|
||||
the child location if required
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>from_sync</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
|
||||
set this true to avoid an output to the sync file
|
||||
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#boolean">boolean</a></span>)
|
||||
<span class="return-text">true if it was successful</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Store.get_children" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Store.get_children">Store.get_children(location)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Gets all non nil children at a location, children can be added and removed during runtime
|
||||
this is similar to Store.get but will always return a table even if it is empty</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>location</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a></span>)
|
||||
<span class="return-text">a unqiue name</span>
|
||||
|
||||
the location to get the children of
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
|
||||
<span class="return-text">a table containg all the children names</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
@@ -749,7 +765,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -171,7 +179,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -171,7 +179,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -171,7 +179,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
1281
doc/modules/modules.control.production.html
Normal file
1281
doc/modules/modules.control.production.html
Normal file
File diff suppressed because it is too large
Load Diff
1026
doc/modules/modules.control.reports.html
Normal file
1026
doc/modules/modules.control.reports.html
Normal file
File diff suppressed because it is too large
Load Diff
1416
doc/modules/modules.control.warnings.html
Normal file
1416
doc/modules/modules.control.warnings.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>modules.gui.rocket-info</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -220,7 +236,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,12 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +107,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,10 +127,9 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,7 +178,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.alien_evolution_progress</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -168,7 +184,7 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#AlienEvolutionProgress.create_spawner_request">AlienEvolutionProgress.create_spawner_request (total_aliens)</a></td>
|
||||
<td class="name"><a href="#AlienEvolutionProgress.create_spawner_request">AlienEvolutionProgress.create_spawner_request(total_aliens)</a></td>
|
||||
<td class="summary">Creates the spawner_request structure required for AlienEvolutionProgress.get_aliens for all
|
||||
available spawners.</td>
|
||||
</tr>
|
||||
@@ -185,7 +201,7 @@ available spawners.</td>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#AlienEvolutionProgress.create_spawner_request" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="AlienEvolutionProgress.create_spawner_request">AlienEvolutionProgress.create_spawner_request (total_aliens)</span>
|
||||
<span class="section-item-title" id="AlienEvolutionProgress.create_spawner_request">AlienEvolutionProgress.create_spawner_request(total_aliens)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -247,7 +263,7 @@ fraction will decide a chance to spawn. 1 alien for 2 spawners will have 50% on
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,21 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +116,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,19 +136,18 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.core</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,41 +184,41 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.cant_run">Module.cant_run (name)</a></td>
|
||||
<td class="summary">Prints a message letting the player know they cannot run a command</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.format_time">Module.format_time (ticks)</a></td>
|
||||
<td class="summary">Takes a time in ticks and returns a string with the time in format "x hour(s) x minute(s)"</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.get_actor">Module.get_actor ()</a></td>
|
||||
<td class="summary">Returns a valid string with the name of the actor of a command.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.log_command">Module.log_command (actor, command, parameters)</a></td>
|
||||
<td class="summary">Logs the use of a command and its user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.print_admins">Module.print_admins (msg, source)</a></td>
|
||||
<td class="summary">Prints a message to all online admins</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.print_except">Module.print_except (msg, player, color)</a></td>
|
||||
<td class="name"><a href="#Module.print_except">Module.print_except(msg, player, color)</a></td>
|
||||
<td class="summary">Takes msg and prints it to all players except provided player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.random_RGB">Module.random_RGB ()</a></td>
|
||||
<td class="name"><a href="#Module.print_admins">Module.print_admins(msg, source)</a></td>
|
||||
<td class="summary">Prints a message to all online admins</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.get_actor">Module.get_actor()</a></td>
|
||||
<td class="summary">Returns a valid string with the name of the actor of a command.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.format_time">Module.format_time(ticks)</a></td>
|
||||
<td class="summary">Takes a time in ticks and returns a string with the time in format "x hour(s) x minute(s)"</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.cant_run">Module.cant_run(name)</a></td>
|
||||
<td class="summary">Prints a message letting the player know they cannot run a command</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.log_command">Module.log_command(actor, command, parameters)</a></td>
|
||||
<td class="summary">Logs the use of a command and its user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.verify_mult_types">Module.verify_mult_types(arg, arg_types)</a></td>
|
||||
<td class="summary">Asserts the argument is one of type arg_types</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.random_RGB">Module.random_RGB()</a></td>
|
||||
<td class="summary">Returns a random RGB color as a table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.set_and_return">Module.set_and_return (tbl, key, value)</a></td>
|
||||
<td class="name"><a href="#Module.set_and_return">Module.set_and_return(tbl, key, value)</a></td>
|
||||
<td class="summary">Sets a table element to value while also returning value.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.verify_mult_types">Module.verify_mult_types (arg, arg_types)</a></td>
|
||||
<td class="summary">Asserts the argument is one of type arg_types</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
@@ -211,10 +228,6 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.is_module_available">Module.is_module_available</a></td>
|
||||
<td class="summary">Takes the string of a module and returns whether is it available or not</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.move_position">Module.move_position</a></td>
|
||||
<td class="summary">Moves a position according to the parameters given
|
||||
Notice: only accepts cardinal directions as direction</td>
|
||||
@@ -223,6 +236,10 @@
|
||||
<td class="name"><a href="#Module.opposite_direction">Module.opposite_direction</a></td>
|
||||
<td class="summary">Takes a direction and gives you the opposite</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.is_module_available">Module.is_module_available</a></td>
|
||||
<td class="summary">Takes the string of a module and returns whether is it available or not</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
@@ -235,275 +252,8 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.cant_run" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.cant_run">Module.cant_run (name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Prints a message letting the player know they cannot run a command</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
string name of the command
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.format_time" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.format_time">Module.format_time (ticks)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Takes a time in ticks and returns a string with the time in format "x hour(s) x minute(s)"</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>ticks</em></strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.get_actor" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.get_actor">Module.get_actor ()</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns a valid string with the name of the actor of a command.</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.log_command" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.log_command">Module.log_command (actor, command, parameters)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Logs the use of a command and its user</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>actor</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
string with the actor's name (usually acquired by calling get_actor)
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>command</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the command's name as table element
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>parameters</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the command's parameters as a table (optional)
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.print_admins" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.print_admins">Module.print_admins (msg, source)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Prints a message to all online admins</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>msg</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<string|table> table if locale is used
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>source</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<LuaPlayer|string|nil> string must be the name of a player, nil for server.
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.print_except" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.print_except">Module.print_except (msg, player, color)</span>
|
||||
<span class="section-item-title" id="Module.print_except">Module.print_except(msg, player, color)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -571,6 +321,343 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.print_admins" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.print_admins">Module.print_admins(msg, source)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Prints a message to all online admins</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>msg</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<string|table> table if locale is used
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>source</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<LuaPlayer|string|nil> string must be the name of a player, nil for server.
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.get_actor" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.get_actor">Module.get_actor()</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns a valid string with the name of the actor of a command.</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.format_time" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.format_time">Module.format_time(ticks)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Takes a time in ticks and returns a string with the time in format "x hour(s) x minute(s)"</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>ticks</em></strong>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.cant_run" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.cant_run">Module.cant_run(name)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Prints a message letting the player know they cannot run a command</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
string name of the command
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.log_command" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.log_command">Module.log_command(actor, command, parameters)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Logs the use of a command and its user</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>actor</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
string with the actor's name (usually acquired by calling get_actor)
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>command</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the command's name as table element
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>parameters</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the command's parameters as a table (optional)
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.verify_mult_types" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.verify_mult_types">Module.verify_mult_types(arg, arg_types)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Asserts the argument is one of type arg_types</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>arg</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the variable to check
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>arg_types</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the type as a table of sings
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">boolean</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -582,7 +669,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.random_RGB" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.random_RGB">Module.random_RGB ()</span>
|
||||
<span class="section-item-title" id="Module.random_RGB">Module.random_RGB()</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -609,7 +696,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.set_and_return" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.set_and_return">Module.set_and_return (tbl, key, value)</span>
|
||||
<span class="section-item-title" id="Module.set_and_return">Module.set_and_return(tbl, key, value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -683,76 +770,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.verify_mult_types" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.verify_mult_types">Module.verify_mult_types (arg, arg_types)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Asserts the argument is one of type arg_types</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>arg</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the variable to check
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>arg_types</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
the type as a table of sings
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">boolean</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -766,54 +783,6 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.is_module_available" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.is_module_available">Module.is_module_available</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Takes the string of a module and returns whether is it available or not</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-module-field-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<string> the name of the module (ex. 'utils.core')
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.move_position" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.move_position">Module.move_position</span>
|
||||
</div>
|
||||
@@ -931,6 +900,54 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.is_module_available" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.is_module_available">Module.is_module_available</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Takes the string of a module and returns whether is it available or not</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-module-field-li">
|
||||
|
||||
<strong><em>name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<string> the name of the module (ex. 'utils.core')
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -953,7 +970,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.debug</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -166,31 +182,31 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.cheat">Debug.cheat (callback)</a></td>
|
||||
<td class="summary">Executes the given callback if cheating is enabled.</td>
|
||||
<td class="name"><a href="#Debug.print">Debug.print(message, stack_traceback)</a></td>
|
||||
<td class="summary">Shows the given message if debug is enabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.get_meta_value">Debug.get_meta_value (object, key)</a></td>
|
||||
<td class="name"><a href="#Debug.get_meta_value">Debug.get_meta_value(object, key)</a></td>
|
||||
<td class="summary">Returns the value of the key inside the object
|
||||
or 'InvalidLuaObject' if the LuaObject is invalid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.is_closure">Debug.is_closure (func)</a></td>
|
||||
<td class="summary">Returns true if the function is a closure, false otherwise.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.object_type">Debug.object_type (object)</a></td>
|
||||
<td class="name"><a href="#Debug.object_type">Debug.object_type(object)</a></td>
|
||||
<td class="summary">Returns the Lua data type or the factorio LuaObject type
|
||||
or 'NoHelpLuaObject' if the LuaObject does not have a help function
|
||||
or 'InvalidLuaObject' if the LuaObject is invalid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.print">Debug.print (message, stack_traceback)</a></td>
|
||||
<td class="summary">Shows the given message if debug is enabled.</td>
|
||||
<td class="name"><a href="#Debug.print_position">Debug.print_position(position, message)</a></td>
|
||||
<td class="summary">Shows the given message if debug is on.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.print_position">Debug.print_position (position, message)</a></td>
|
||||
<td class="summary">Shows the given message if debug is on.</td>
|
||||
<td class="name"><a href="#Debug.cheat">Debug.cheat(callback)</a></td>
|
||||
<td class="summary">Executes the given callback if cheating is enabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Debug.is_closure">Debug.is_closure(func)</a></td>
|
||||
<td class="summary">Returns true if the function is a closure, false otherwise.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -204,15 +220,15 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.cheat" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.cheat">Debug.cheat (callback)</span>
|
||||
<a href="#Debug.print" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.print">Debug.print(message, stack_traceback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Executes the given callback if cheating is enabled.</p>
|
||||
<p class="section-item-description"></p>
|
||||
<p class="section-item-summary">Shows the given message if debug is enabled.</p>
|
||||
<p class="section-item-description"> Uses serpent to print non scalars.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
@@ -225,12 +241,27 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>callback</em></strong>
|
||||
<strong><em>message</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
function
|
||||
<table|string|number|boolean>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>stack_traceback</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number|nil> levels of stack trace to give, defaults to 1 level if nil
|
||||
|
||||
</li>
|
||||
|
||||
@@ -254,7 +285,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.get_meta_value" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.get_meta_value">Debug.get_meta_value (object, key)</span>
|
||||
<span class="section-item-title" id="Debug.get_meta_value">Debug.get_meta_value(object, key)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -315,63 +346,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.is_closure" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.is_closure">Debug.is_closure (func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns true if the function is a closure, false otherwise.</p>
|
||||
<p class="section-item-description">
|
||||
A closure is a function that contains 'upvalues' or in other words
|
||||
has a reference to a local variable defined outside the function's scope.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">boolean</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -383,7 +357,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.object_type" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.object_type">Debug.object_type (object)</span>
|
||||
<span class="section-item-title" id="Debug.object_type">Debug.object_type(object)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -429,70 +403,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.print" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.print">Debug.print (message, stack_traceback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Shows the given message if debug is enabled.</p>
|
||||
<p class="section-item-description"> Uses serpent to print non scalars.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>message</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<table|string|number|boolean>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>stack_traceback</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number|nil> levels of stack trace to give, defaults to 1 level if nil
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -504,7 +414,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.print_position" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.print_position">Debug.print_position (position, message)</span>
|
||||
<span class="section-item-title" id="Debug.print_position">Debug.print_position(position, message)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -557,6 +467,112 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.cheat" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.cheat">Debug.cheat(callback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Executes the given callback if cheating is enabled.</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>callback</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
function
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Debug.is_closure" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Debug.is_closure">Debug.is_closure(func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns true if the function is a closure, false otherwise.</p>
|
||||
<p class="section-item-description">
|
||||
A closure is a function that contains 'upvalues' or in other words
|
||||
has a reference to a local variable defined outside the function's scope.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">boolean</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -579,7 +595,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.event</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -257,51 +273,51 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.add">Event.add (event_name, handler)</a></td>
|
||||
<td class="name"><a href="#Event.add">Event.add(event_name, handler)</a></td>
|
||||
<td class="summary">Register a handler for the event_name event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.add_removable">Event.add_removable (event_name, token)</a></td>
|
||||
<td class="summary">Register a token handler that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.add_removable_function">Event.add_removable_function (event_name, func)</a></td>
|
||||
<td class="summary">Register a handler that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.add_removable_nth_tick">Event.add_removable_nth_tick (tick, token)</a></td>
|
||||
<td class="summary">Register a token handler for the nth tick that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.add_removable_nth_tick_function">Event.add_removable_nth_tick_function (tick, func)</a></td>
|
||||
<td class="summary">Register a handler for the nth tick that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.on_init">Event.on_init (handler)</a></td>
|
||||
<td class="name"><a href="#Event.on_init">Event.on_init(handler)</a></td>
|
||||
<td class="summary">Register a handler for the script.on_init event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.on_load">Event.on_load (handler)</a></td>
|
||||
<td class="name"><a href="#Event.on_load">Event.on_load(handler)</a></td>
|
||||
<td class="summary">Register a handler for the script.on_load event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.on_nth_tick">Event.on_nth_tick (tick, handler)</a></td>
|
||||
<td class="name"><a href="#Event.on_nth_tick">Event.on_nth_tick(tick, handler)</a></td>
|
||||
<td class="summary">Register a handler for the nth_tick event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable">Event.remove_removable (event_name, token)</a></td>
|
||||
<td class="name"><a href="#Event.add_removable">Event.add_removable(event_name, token)</a></td>
|
||||
<td class="summary">Register a token handler that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable">Event.remove_removable(event_name, token)</a></td>
|
||||
<td class="summary">Removes a token handler for the given event_name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable_function">Event.remove_removable_function (event_name, func)</a></td>
|
||||
<td class="name"><a href="#Event.add_removable_function">Event.add_removable_function(event_name, func)</a></td>
|
||||
<td class="summary">Register a handler that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable_function">Event.remove_removable_function(event_name, func)</a></td>
|
||||
<td class="summary">Removes a handler for the given event_name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable_nth_tick">Event.remove_removable_nth_tick (tick, token)</a></td>
|
||||
<td class="name"><a href="#Event.add_removable_nth_tick">Event.add_removable_nth_tick(tick, token)</a></td>
|
||||
<td class="summary">Register a token handler for the nth tick that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable_nth_tick">Event.remove_removable_nth_tick(tick, token)</a></td>
|
||||
<td class="summary">Removes a token handler for the nth tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable_nth_tick_function">Event.remove_removable_nth_tick_function (tick, func)</a></td>
|
||||
<td class="name"><a href="#Event.add_removable_nth_tick_function">Event.add_removable_nth_tick_function(tick, func)</a></td>
|
||||
<td class="summary">Register a handler for the nth tick that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Event.remove_removable_nth_tick_function">Event.remove_removable_nth_tick_function(tick, func)</a></td>
|
||||
<td class="summary">Removes a handler for the nth tick.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -317,7 +333,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.add" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.add">Event.add (event_name, handler)</span>
|
||||
<span class="section-item-title" id="Event.add">Event.add(event_name, handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -352,6 +368,174 @@
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.on_init" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.on_init">Event.on_init(handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Register a handler for the script.on_init event.</p>
|
||||
<p class="section-item-description">
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.on_load" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.on_load">Event.on_load(handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Register a handler for the script.on_load event.</p>
|
||||
<p class="section-item-description">
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.on_nth_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.on_nth_tick">Event.on_nth_tick(tick, handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Register a handler for the nth_tick event.</p>
|
||||
<p class="section-item-description">
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>tick</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number> The handler will be called every nth tick
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
@@ -383,7 +567,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.add_removable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.add_removable">Event.add_removable (event_name, token)</span>
|
||||
<span class="section-item-title" id="Event.add_removable">Event.add_removable(event_name, token)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -418,6 +602,72 @@
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>token</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable">Event.remove_removable(event_name, token)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a token handler for the given event_name.</p>
|
||||
<p class="section-item-description">
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>event_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>token</em></strong>
|
||||
@@ -449,7 +699,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.add_removable_function" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.add_removable_function">Event.add_removable_function (event_name, func)</span>
|
||||
<span class="section-item-title" id="Event.add_removable_function">Event.add_removable_function(event_name, func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -485,6 +735,72 @@
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable_function" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable_function">Event.remove_removable_function(event_name, func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a handler for the given event_name.</p>
|
||||
<p class="section-item-description">
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>event_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func</em></strong>
|
||||
@@ -516,7 +832,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.add_removable_nth_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.add_removable_nth_tick">Event.add_removable_nth_tick (tick, token)</span>
|
||||
<span class="section-item-title" id="Event.add_removable_nth_tick">Event.add_removable_nth_tick(tick, token)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -551,6 +867,72 @@
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>token</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable_nth_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable_nth_tick">Event.remove_removable_nth_tick(tick, token)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a token handler for the nth tick.</p>
|
||||
<p class="section-item-description">
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>tick</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>token</em></strong>
|
||||
@@ -582,7 +964,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.add_removable_nth_tick_function" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.add_removable_nth_tick_function">Event.add_removable_nth_tick_function (tick, func)</span>
|
||||
<span class="section-item-title" id="Event.add_removable_nth_tick_function">Event.add_removable_nth_tick_function(tick, func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -638,372 +1020,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.on_init" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.on_init">Event.on_init (handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Register a handler for the script.on_init event.</p>
|
||||
<p class="section-item-description">
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.on_load" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.on_load">Event.on_load (handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Register a handler for the script.on_load event.</p>
|
||||
<p class="section-item-description">
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.on_nth_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.on_nth_tick">Event.on_nth_tick (tick, handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Register a handler for the nth_tick event.</p>
|
||||
<p class="section-item-description">
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>tick</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number> The handler will be called every nth tick
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>handler</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable">Event.remove_removable (event_name, token)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a token handler for the given event_name.</p>
|
||||
<p class="section-item-description">
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>event_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>token</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable_function" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable_function">Event.remove_removable_function (event_name, func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a handler for the given event_name.</p>
|
||||
<p class="section-item-description">
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>event_name</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<function>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable_nth_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable_nth_tick">Event.remove_removable_nth_tick (tick, token)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes a token handler for the nth tick.</p>
|
||||
<p class="section-item-description">
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.</p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>tick</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>token</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -1015,7 +1031,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Event.remove_removable_nth_tick_function" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Event.remove_removable_nth_tick_function">Event.remove_removable_nth_tick_function (tick, func)</span>
|
||||
<span class="section-item-title" id="Event.remove_removable_nth_tick_function">Event.remove_removable_nth_tick_function(tick, func)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -1092,7 +1108,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.event_core</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -166,15 +182,15 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.on_init">Public.on_init (handler)</a></td>
|
||||
<td class="name"><a href="#Public.on_init">Public.on_init(handler)</a></td>
|
||||
<td class="summary">Do not use this function, use Event.on_init instead as it has safety checks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.on_load">Public.on_load (handler)</a></td>
|
||||
<td class="name"><a href="#Public.on_load">Public.on_load(handler)</a></td>
|
||||
<td class="summary">Do not use this function, use Event.on_load instead as it has safety checks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.on_nth_tick">Public.on_nth_tick (tick, handler)</a></td>
|
||||
<td class="name"><a href="#Public.on_nth_tick">Public.on_nth_tick(tick, handler)</a></td>
|
||||
<td class="summary">Do not use this function, use Event.on_nth_tick instead as it has safety checks.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -190,7 +206,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.on_init" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.on_init">Public.on_init (handler)</span>
|
||||
<span class="section-item-title" id="Public.on_init">Public.on_init(handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -238,7 +254,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.on_load" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.on_load">Public.on_load (handler)</span>
|
||||
<span class="section-item-title" id="Public.on_load">Public.on_load(handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -286,7 +302,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.on_nth_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.on_nth_tick">Public.on_nth_tick (tick, handler)</span>
|
||||
<span class="section-item-title" id="Public.on_nth_tick">Public.on_nth_tick(tick, handler)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -359,7 +375,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.math</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -166,7 +182,7 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#calculate_y_intercept">calculate_y_intercept (x, slope)</a></td>
|
||||
<td class="name"><a href="#calculate_y_intercept">calculate_y_intercept(x, slope)</a></td>
|
||||
<td class="summary">Calculates the y-intercept of a line</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -182,7 +198,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#calculate_y_intercept" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="calculate_y_intercept">calculate_y_intercept (x, slope)</span>
|
||||
<span class="section-item-title" id="calculate_y_intercept">calculate_y_intercept(x, slope)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -263,7 +279,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.recipe_locker</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,7 +183,7 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.unlock_recipes">Public.unlock_recipes (tbl)</a></td>
|
||||
<td class="name"><a href="#Public.unlock_recipes">Public.unlock_recipes(tbl)</a></td>
|
||||
<td class="summary">Unlocks recipes, allowing them to be enabled by research.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -183,7 +199,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.unlock_recipes" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.unlock_recipes">Public.unlock_recipes (tbl)</span>
|
||||
<span class="section-item-title" id="Public.unlock_recipes">Public.unlock_recipes(tbl)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -244,7 +260,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.state_machine</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,32 +186,32 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.in_state">Module.in_state (self, state)</a></td>
|
||||
<td class="name"><a href="#Module.transition">Module.transition(self, new_state)</a></td>
|
||||
<td class="summary">Transitions the supplied machine into a given state and executes all transaction_callbacks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.in_state">Module.in_state(self, state)</a></td>
|
||||
<td class="summary">Is this machine in this state?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.machine_tick">Module.machine_tick (self)</a></td>
|
||||
<td class="name"><a href="#Module.machine_tick">Module.machine_tick(self)</a></td>
|
||||
<td class="summary">Invoke a machine tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.new">Module.new (init_state)</a></td>
|
||||
<td class="summary">Constructs a new state machine</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.register_state_tick_callback">Module.register_state_tick_callback (self, state, callback)</a></td>
|
||||
<td class="name"><a href="#Module.register_state_tick_callback">Module.register_state_tick_callback(self, state, callback)</a></td>
|
||||
<td class="summary">Register a handler that will be invoked by StateMachine.machine_tick
|
||||
You may register multiple handlers for the same transition
|
||||
NOTICE: This function will invoke an error if called after init.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.register_transition_callback">Module.register_transition_callback (self, state, state, callback)</a></td>
|
||||
<td class="name"><a href="#Module.register_transition_callback">Module.register_transition_callback(self, state, state, callback)</a></td>
|
||||
<td class="summary">Register a handler that will be invoked by StateMachine.transition
|
||||
You may register multiple handlers for the same transition
|
||||
NOTICE: This function will invoke an error if called after init.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Module.transition">Module.transition (self, new_state)</a></td>
|
||||
<td class="summary">Transitions the supplied machine into a given state and executes all transaction_callbacks</td>
|
||||
<td class="name"><a href="#Module.new">Module.new(init_state)</a></td>
|
||||
<td class="summary">Constructs a new state machine</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -209,8 +225,72 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.transition" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.transition">Module.transition(self, new_state)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Transitions the supplied machine into a given state and executes all transaction_callbacks</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>self</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
StateMachine
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>new_state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
number/string The new state to transition to
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.in_state" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.in_state">Module.in_state (self, state)</span>
|
||||
<span class="section-item-title" id="Module.in_state">Module.in_state(self, state)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -280,7 +360,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.machine_tick" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.machine_tick">Module.machine_tick (self)</span>
|
||||
<span class="section-item-title" id="Module.machine_tick">Module.machine_tick(self)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -318,61 +398,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.new" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.new">Module.new (init_state)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Constructs a new state machine</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>init_state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
number/string The starting state of the machine
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">StateMachine The constructed state machine object</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -384,7 +409,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.register_state_tick_callback" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.register_state_tick_callback">Module.register_state_tick_callback (self, state, callback)</span>
|
||||
<span class="section-item-title" id="Module.register_state_tick_callback">Module.register_state_tick_callback(self, state, callback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -465,7 +490,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.register_transition_callback" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.register_transition_callback">Module.register_transition_callback (self, state, state, callback)</span>
|
||||
<span class="section-item-title" id="Module.register_transition_callback">Module.register_transition_callback(self, state, state, callback)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -560,14 +585,14 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Module.transition" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.transition">Module.transition (self, new_state)</span>
|
||||
<a href="#Module.new" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Module.new">Module.new(init_state)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Transitions the supplied machine into a given state and executes all transaction_callbacks</p>
|
||||
<p class="section-item-summary">Constructs a new state machine</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
@@ -581,27 +606,12 @@
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>self</em></strong>
|
||||
<strong><em>init_state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
StateMachine
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>new_state</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
number/string The new state to transition to
|
||||
number/string The starting state of the machine
|
||||
|
||||
</li>
|
||||
|
||||
@@ -611,6 +621,12 @@
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">StateMachine The constructed state machine object</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
@@ -636,7 +652,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.task</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,13 +183,13 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Task.queue_task">Task.queue_task (func_token, params, weight)</a></td>
|
||||
<td class="summary">Queueing allows you to split up heavy tasks which don't need to be completed in the same tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Task.set_timeout">Task.set_timeout (sec, func_token, params)</a></td>
|
||||
<td class="name"><a href="#Task.set_timeout">Task.set_timeout(sec, func_token, params)</a></td>
|
||||
<td class="summary">Allows you to set a timer (in seconds) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Task.queue_task">Task.queue_task(func_token, params, weight)</a></td>
|
||||
<td class="summary">Queueing allows you to split up heavy tasks which don't need to be completed in the same tick.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -187,8 +203,88 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Task.set_timeout" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Task.set_timeout">Task.set_timeout(sec, func_token, params)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Allows you to set a timer (in seconds) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>sec</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func_token</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number> a token for a function store via the token system
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>params</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<any> the argument to send to the tokened function
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Task.queue_task" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Task.queue_task">Task.queue_task (func_token, params, weight)</span>
|
||||
<span class="section-item-title" id="Task.queue_task">Task.queue_task(func_token, params, weight)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -259,86 +355,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Task.set_timeout" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Task.set_timeout">Task.set_timeout (sec, func_token, params)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Allows you to set a timer (in seconds) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>sec</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>func_token</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number> a token for a function store via the token system
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>params</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<any> the argument to send to the tokened function
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -361,7 +377,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,14 +35,20 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h2>Sections</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -109,6 +115,17 @@
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
@@ -118,18 +135,17 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-module-contents">
|
||||
<li class="nav-item">
|
||||
<h4>Contents of <strong>utils.timestamp</strong></h4>
|
||||
<h4>Jump to Section</h4>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="up-to-top">
|
||||
<a href="#">Top <i class="icon icon-upward"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -167,17 +183,17 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.from_timetable">Public.from_timetable (timetable)</a></td>
|
||||
<td class="name"><a href="#Public.to_timetable">Public.to_timetable(sec)</a></td>
|
||||
<td class="summary">Converts unix epoch timestamp into table {year: number, month: number, day: number, hour: number, min: number, sec: number}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.from_timetable">Public.from_timetable(timetable)</a></td>
|
||||
<td class="summary">Converts timetable into unix epoch timestamp</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.to_string">Public.to_string (secs)</a></td>
|
||||
<td class="name"><a href="#Public.to_string">Public.to_string(secs)</a></td>
|
||||
<td class="summary">Converts unix epoch timestamp into human readable string.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Public.to_timetable">Public.to_timetable (sec)</a></td>
|
||||
<td class="summary">Converts unix epoch timestamp into table {year: number, month: number, day: number, hour: number, min: number, sec: number}</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
@@ -190,8 +206,63 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.to_timetable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.to_timetable">Public.to_timetable(sec)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Converts unix epoch timestamp into table {year: number, month: number, day: number, hour: number, min: number, sec: number}</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>sec</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number> unix epoch timestamp
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">{year: number, month: number, day: number, hour: number, min: number, sec: number}</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.from_timetable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.from_timetable">Public.from_timetable (timetable)</span>
|
||||
<span class="section-item-title" id="Public.from_timetable">Public.from_timetable(timetable)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -246,7 +317,7 @@
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.to_string" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.to_string">Public.to_string (secs)</span>
|
||||
<span class="section-item-title" id="Public.to_string">Public.to_string(secs)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -290,61 +361,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Public.to_timetable" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Public.to_timetable">Public.to_timetable (sec)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Converts unix epoch timestamp into table {year: number, month: number, day: number, hour: number, min: number, sec: number}</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>sec</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
|
||||
<number> unix epoch timestamp
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="return-text">{year: number, month: number, day: number, hour: number, min: number, sec: number}</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -367,7 +383,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,13 +35,25 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../topics/license.html"><span class="module-name-item">license</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../topics/license.html"><span class="module-name-item">license</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -49,9 +61,6 @@
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -118,8 +127,6 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
</div>
|
||||
<!-- sidebar end -->
|
||||
@@ -723,7 +730,7 @@ Public License instead of this License. But first, please read
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -35,13 +35,25 @@
|
||||
</div>
|
||||
|
||||
|
||||
<!-- sidebar navigation -->
|
||||
<!-- sidebar navigation -->
|
||||
<!-- list of items in a module -->
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Topics</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/license.html"><span class="module-name-item">license</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/license.html"><span class="module-name-item">license</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="nav nav-modules">
|
||||
<li class="nav-item">
|
||||
<h2>Control</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -49,9 +61,6 @@
|
||||
<li class="nav-item">
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
|
||||
@@ -118,8 +127,6 @@
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<!-- list of items in a module -->
|
||||
</div>
|
||||
</div>
|
||||
<!-- sidebar end -->
|
||||
@@ -263,7 +270,7 @@
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
|
||||
</div>
|
||||
<div class="content-footer column col-9 col-sm-12">
|
||||
<i>Last updated 2019-06-29 01:27:33 UTC</i>
|
||||
<i>Last updated 2019-07-20 23:44:09 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user