Automattic Doc Update

This commit is contained in:
Cooldude2606
2020-05-26 17:59:24 +00:00
parent 935a721d51
commit 5c647a4d8e
95 changed files with 3373 additions and 562 deletions

View File

@@ -44,7 +44,7 @@
<li class="nav-item"><a href="#Dependencies"><span class="fragment-hashtag">#</span> Dependencies</a></li>
<li class="nav-item"><a href="#Type_Checking"><span class="fragment-hashtag">#</span> Type Checking </a></li>
<li class="nav-item"><a href="#Value_Returns"><span class="fragment-hashtag">#</span> Value Returns </a></li>
<li class="nav-item"><a href="#Formating"><span class="fragment-hashtag">#</span> Formating </a></li>
<li class="nav-item"><a href="#Formatting"><span class="fragment-hashtag">#</span> Formatting </a></li>
<li class="nav-item"><a href="#Factorio"><span class="fragment-hashtag">#</span> Factorio </a></li>
</ul>
</li>
@@ -89,6 +89,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>
@@ -127,6 +128,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>
@@ -161,9 +163,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>
@@ -190,8 +194,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>
@@ -207,7 +211,7 @@
<li class="nav-item"><a href="#Dependencies"><span class="fragment-hashtag">#</span> Dependencies</a></li>
<li class="nav-item"><a href="#Type_Checking"><span class="fragment-hashtag">#</span> Type Checking </a></li>
<li class="nav-item"><a href="#Value_Returns"><span class="fragment-hashtag">#</span> Value Returns </a></li>
<li class="nav-item"><a href="#Formating"><span class="fragment-hashtag">#</span> Formating </a></li>
<li class="nav-item"><a href="#Formatting"><span class="fragment-hashtag">#</span> Formatting </a></li>
<li class="nav-item"><a href="#Factorio"><span class="fragment-hashtag">#</span> Factorio </a></li>
</ul>
</li>
@@ -353,7 +357,7 @@
</table>
<table class="section-content-list">
<thead>
<h3><a href="#Formating">Formating </a></h3>
<h3><a href="#Formatting">Formatting </a></h3>
<span></span>
</thead>
<tbody>
@@ -747,7 +751,7 @@
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Check for a string or table
</span><span class="keyword">local</span> is_string_or_table = multi_type_check(value, {<span class="string">'string'</span>,<span class="string">'table'</span>})</code></pre>
</span><span class="keyword">local</span> is_string_or_table = multi_type_check(value, {<span class="string">'string'</span>, <span class="string">'table'</span>})</code></pre>
<!-- usage end -->
</dd>
@@ -855,7 +859,7 @@
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Raise error if value is not a string or table
</span>multi_type_error(<span class="string">'foo'</span>, {<span class="string">'string'</span>,<span class="string">'table'</span>}, <span class="string">'Value must be a string or table'</span>)</code></pre>
</span>multi_type_error(<span class="string">'foo'</span>, {<span class="string">'string'</span>, <span class="string">'table'</span>}, <span class="string">'Value must be a string or table'</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -1075,9 +1079,9 @@
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Output: "Bad argument #2 to "&lt;anon&gt;"; argument is of type number expected string or table"
</span>validate_argument_type(value, {<span class="string">'string'</span>,<span class="string">'table'</span>}, <span class="number">2</span>)</code></pre>
</span>validate_argument_type(value, {<span class="string">'string'</span>, <span class="string">'table'</span>}, <span class="number">2</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Output: "Bad argument #2 to "&lt;anon&gt;"; "player" is of type number expected string or table"
</span>validate_argument_type(value, {<span class="string">'string'</span>,<span class="string">'table'</span>}, <span class="number">2</span>, <span class="string">'player'</span>)</code></pre>
</span>validate_argument_type(value, {<span class="string">'string'</span>, <span class="string">'table'</span>}, <span class="number">2</span>, <span class="string">'player'</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -1948,7 +1952,7 @@
</dd>
</dl>
<h3><span id="Formating" class="section-title"><a href="#Formating">Formating </a></span></h3>
<h3><span id="Formatting" class="section-title"><a href="#Formatting">Formatting </a></span></h3>
<dl class="section-body-container">
<dt>
<div class="divider divider-custom"></div>
@@ -2056,7 +2060,7 @@
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
a color which contains r,g,b as its keys
a color which contains r, g, b as its keys
</li>
@@ -2132,7 +2136,7 @@
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
a color which contains r,g,b as its keys
a color which contains r, g, b as its keys
</li>
@@ -2480,7 +2484,7 @@
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.5.html">table</a></span>)
the position that the items will be moved to {x=100,y=100}
the position that the items will be moved to {x=100, y=100}
(<em>default</em>: {0)
</li>
@@ -2540,7 +2544,7 @@
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Copy all the items in a players inventory and place them in chests at {0,0}
<pre class="code" data-lang="Lua"><code><span class="comment">-- Copy all the items in a players inventory and place them in chests at {0, 0}
</span>move_items(game.player.get_main_inventory().get_contents())</code></pre>
<!-- usage end -->
@@ -2678,7 +2682,7 @@ https://github.com/Refactorio/RedMew/blob/9184b2940f311d8c9c891e83429fc57ec7e0c4
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Place a 0 at {0,0}
<pre class="code" data-lang="Lua"><code><span class="comment">-- Place a 0 at {0, 0}
</span>print_grid_value(<span class="number">0</span>, game.player.surface, { x=<span class="number">0</span>, y=<span class="number">0</span> })</code></pre>
<!-- usage end -->
@@ -2751,7 +2755,7 @@ https://github.com/Refactorio/RedMew/blob/9184b2940f311d8c9c891e83429fc57ec7e0c4
<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>