mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-30 12:31:41 +09:00
Automattic Doc Update
This commit is contained in:
Cooldude2606
@@ -42,9 +42,9 @@
|
||||
<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="#Formating"><span class="fragment-hashtag">#</span> Formating </a></li>
|
||||
<li class="nav-item"><a href="#Precision"><span class="fragment-hashtag">#</span> Precision </a></li>
|
||||
<li class="nav-item"><a href="#Statistics"><span class="fragment-hashtag">#</span> Statistics </a></li>
|
||||
<li class="nav-item"><a href="#Formating"><span class="fragment-hashtag">#</span> Formating </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -88,6 +88,7 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Death-Logger.html"><span class="module-name-item">Death-Logger</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Discord-Alerts.html"><span class="module-name-item">Discord-Alerts</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/greetings.html"><span class="module-name-item">greetings</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Inventory-Clear.html"><span class="module-name-item">Inventory-Clear</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Pollution-Grading.html"><span class="module-name-item">Pollution-Grading</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Player-Colours.html"><span class="module-name-item">Player-Colours</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Scorched-Earth.html"><span class="module-name-item">Scorched-Earth</span></a></div></li>
|
||||
@@ -126,6 +127,7 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../commands/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="../commands/Kill.html"><span class="module-name-item">Kill</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../commands/Me.html"><span class="module-name-item">Me</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../commands/Quickbar.html"><span class="module-name-item">Quickbar</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../commands/Rainbow.html"><span class="module-name-item">Rainbow</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../commands/Repair.html"><span class="module-name-item">Repair</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../commands/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
|
||||
@@ -160,9 +162,11 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Science.html"><span class="module-name-item">Science</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Tasks.html"><span class="module-name-item">Tasks</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Warps.html"><span class="module-name-item">Warps</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/inventory_clear.html"><span class="module-name-item">inventory_clear</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Pollution-Grading.html"><span class="module-name-item">Pollution-Grading</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Popup-Messages.html"><span class="module-name-item">Popup-Messages</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Preset-Player-Colours.html"><span class="module-name-item">Preset-Player-Colours</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Preset-Player-Quickbar.html"><span class="module-name-item">Preset-Player-Quickbar</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Repair.html"><span class="module-name-item">Repair</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Scorched-Earth.html"><span class="module-name-item">Scorched-Earth</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Spawn-Area.html"><span class="module-name-item">Spawn-Area</span></a></div></li>
|
||||
@@ -189,8 +193,8 @@
|
||||
<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>
|
||||
<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"><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"><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>
|
||||
@@ -204,9 +208,9 @@
|
||||
<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="#Formating"><span class="fragment-hashtag">#</span> Formating </a></li>
|
||||
<li class="nav-item"><a href="#Precision"><span class="fragment-hashtag">#</span> Precision </a></li>
|
||||
<li class="nav-item"><a href="#Statistics"><span class="fragment-hashtag">#</span> Statistics </a></li>
|
||||
<li class="nav-item"><a href="#Formating"><span class="fragment-hashtag">#</span> Formating </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -247,21 +251,21 @@
|
||||
|
||||
<span class="comment">-- The get production function is used to get production, consumion and net
|
||||
</span> <span class="comment">-- it may be used for any item and with any precision level, use total for total
|
||||
</span> Production.get_production(game.forces.player,<span class="string">'iron-plate'</span>,defines.flow_precision_index.one_minute)
|
||||
</span> Production.get_production(game.forces.player, <span class="string">'iron-plate'</span>, defines.flow_precision_index.one_minute)
|
||||
|
||||
<span class="comment">-- The fluctuations works by compearing recent production with the average over time
|
||||
</span> <span class="comment">-- again any precision may be used, apart from one_thousand_hours as there would be no valid average
|
||||
</span> Production.get_fluctuations(game.forces.player,<span class="string">'iron-plate'</span>,defines.flow_precision_index.one_minute)
|
||||
</span> Production.get_fluctuations(game.forces.player, <span class="string">'iron-plate'</span>, defines.flow_precision_index.one_minute)
|
||||
|
||||
<span class="comment">-- ETA is calculated based on what function you use but all share a similar method
|
||||
</span> <span class="comment">-- for production eta it will take current production average given by the precision
|
||||
</span> <span class="comment">-- and work out how many ticks it will require to make the required amount (1000 by default)
|
||||
</span> Production.get_production_eta(game.forces.player,<span class="string">'iron-plate'</span>,defines.flow_precision_index.one_minute,<span class="number">250000</span>)
|
||||
</span> Production.get_production_eta(game.forces.player, <span class="string">'iron-plate'</span>, defines.flow_precision_index.one_minute, <span class="number">250000</span>)
|
||||
|
||||
<span class="comment">-- Both get_color and format_number are helper functions to help format production stats
|
||||
</span> <span class="comment">-- get_color will return green,orange,red,or grey based on the active_value
|
||||
</span> <span class="comment">-- the passive_value is used when active_value is 0 and can only return orange,red,or grey
|
||||
</span> Production.get_color(clamp,active_value,passive_value)</code></pre>
|
||||
</span> <span class="comment">-- get_color will return green, orange, red, or grey based on the active_value
|
||||
</span> <span class="comment">-- the passive_value is used when active_value is 0 and can only return orange, red, or grey
|
||||
</span> Production.get_color(clamp, active_value, passive_value)</code></pre>
|
||||
<!-- module usage end -->
|
||||
|
||||
<!-- module content header end -->
|
||||
@@ -283,22 +287,6 @@
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Formating">Formating </a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#get_color">get_color(clamp, active_value, passive_value)</a></td>
|
||||
<td class="summary">Returns a color value bassed on the value that was given</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#format_number">format_number(value)</a></td>
|
||||
<td class="summary">Returns three parts used to format a number</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Precision">Precision </a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
@@ -349,6 +337,22 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<table class="section-content-list">
|
||||
<thead>
|
||||
<h3><a href="#Formating">Formating </a></h3>
|
||||
<span></span>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#get_color">get_color(clamp, active_value, passive_value)</a></td>
|
||||
<td class="summary">Returns a color value bassed on the value that was given</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#format_number">format_number(value)</a></td>
|
||||
<td class="summary">Returns three parts used to format a number</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<!-- module section list end -->
|
||||
|
||||
<br />
|
||||
@@ -399,159 +403,6 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3><span id="Formating" class="section-title"><a href="#Formating">Formating </a></span></h3>
|
||||
<dl class="section-body-container">
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#get_color" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="get_color">get_color(clamp, active_value, passive_value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns a color value bassed on the value that was given</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>clamp</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
value which seperates the different colours
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>active_value</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
first value tested, tested against clamp
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>passive_value</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
second value tested, tested against 0
|
||||
|
||||
</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">contains r,g,b keys</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="#format_number" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="format_number">format_number(value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns three parts used to format a number</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="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the value to format
|
||||
|
||||
</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 sign for the number</span>
|
||||
</li>
|
||||
<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 surfix for any unit used</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -1306,6 +1157,159 @@
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3><span id="Formating" class="section-title"><a href="#Formating">Formating </a></span></h3>
|
||||
<dl class="section-body-container">
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#get_color" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="get_color">get_color(clamp, active_value, passive_value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns a color value bassed on the value that was given</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>clamp</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
value which seperates the different colours
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>active_value</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
first value tested, tested against clamp
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>passive_value</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
second value tested, tested against 0
|
||||
|
||||
</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">contains r, g,b keys</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="#format_number" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="format_number">format_number(value)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns three parts used to format a number</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="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
|
||||
the value to format
|
||||
|
||||
</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 sign for the number</span>
|
||||
</li>
|
||||
<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 surfix for any unit used</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
@@ -1328,7 +1332,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 2020-03-31 23:28:20 UTC</i>
|
||||
<i>Last updated 2020-05-26 17:59:21 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user