aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-27 11:35:22 +09:00
Code Issues Packages Projects Releases Wiki Activity

Automatic Doc Update

Browse Source
This commit is contained in:
Cooldude2606
2021-01-27 00:27:16 +00:00
parent 16524a92c9
commit e3dea6687e
103 changed files with 108 additions and 696 deletions
Download Patch File Download Diff File Expand all files Collapse all files

439
docs/control/Jail.html
View File

@@ -44,7 +44,6 @@
<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"><span class="fragment-hashtag">#</span> Jail </a></li>
<li class="nav-item"><a href="#Temp_ban"><span class="fragment-hashtag">#</span> Temp ban </a></li>
</ul>
</li>
</ul>
@@ -225,7 +224,6 @@
<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"><span class="fragment-hashtag">#</span> Jail </a></li>
<li class="nav-item"><a href="#Temp_ban"><span class="fragment-hashtag">#</span> Temp ban </a></li>
</ul>
</li>
</ul>
@@ -246,7 +244,7 @@
<h2><span class="body-module-name"><strong><em>Jail</em></strong></span> control</h2>
<p>Control Module - Jail
- Adds a way to jail players and temp ban players.</p>
- Adds a way to jail players.</p>
<p></p>
@@ -265,11 +263,7 @@
<span class="comment">-- This will give 'MrBiter' all his roles back and remove him from jail
</span> <span class="comment">-- again as above the player name is only used in the event for user feedback
</span> Jail.unjail_player(<span class="string">'MrBiter'</span>, <span class="string">'Cooldude2606'</span>)
<span class="comment">-- Temp ban works the same as jail but will store the reason and move the players items to spawn
</span> <span class="comment">-- this is meant to be used as a more permiment jail but not as strong as a ban
</span> Jail.temp_ban_player(<span class="string">'MrBiter'</span>, <span class="string">'Cooldude2606'</span>, <span class="string">'Likes biters too much'</span>)</code></pre>
</span> Jail.unjail_player(<span class="string">'MrBiter'</span>, <span class="string">'Cooldude2606'</span>)</code></pre>
<!-- module usage end -->
<!-- module content header end -->
@@ -290,9 +284,6 @@
<tr>
<td class="name"><a href="#utils.global">utils.global</a></td>
</tr>
<tr>
<td class="name"><a href="#expcore.common">expcore.common</a></td>
</tr>
</tbody>
</table>
<table class="section-content-list">
@@ -309,14 +300,6 @@
<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>
</tbody>
</table>
<table class="section-content-list">
@@ -339,26 +322,6 @@
</tr>
</tbody>
</table>
<table class="section-content-list">
<thead>
<h3><a href="#Temp_ban">Temp ban </a></h3>
<span></span>
</thead>
<tbody>
<tr>
<td class="name"><a href="#is_temp_banned">is_temp_banned(player)</a></td>
<td class="summary">Checks if a player is temp banned</td>
</tr>
<tr>
<td class="name"><a href="#temp_ban_player">temp_ban_player(player, by_player_name[, reason='Non given.'])</a></td>
<td class="summary">Temp bans a player by moving them to jail, clearing all other roles, storing the reason, and moving their items to spawn</td>
</tr>
<tr>
<td class="name"><a href="#untemp_ban_player">untemp_ban_player(player, by_player_name)</a></td>
<td class="summary">Rrmoves a player from temp ban by clearing the stored reason, removing them from jail, and restoring previous roles</td>
</tr>
</tbody>
</table>
<!-- module section list end -->
<br />
@@ -434,31 +397,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="#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">
<!-- parameters start -->
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
@@ -610,154 +548,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_temp_banned" class="fragment-hashtag">#</a>
<span class="section-item-title" id="on_player_temp_banned">on_player_temp_banned</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">When a player is temp banned</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 temp banned
</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 temp banned the other player
</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 temp banned
</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_player_untemp_banned" class="fragment-hashtag">#</a>
<span class="section-item-title" id="on_player_untemp_banned">on_player_untemp_banned</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">When a temp ban is removed from a player</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 untemp banned
</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 untemp banned the other player
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
@@ -981,229 +771,6 @@
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
</dl>
<h3><span id="Temp_ban" class="section-title"><a href="#Temp_ban">Temp ban </a></span></h3>
<dl class="section-body-container">
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#is_temp_banned" class="fragment-hashtag">#</a>
<span class="section-item-title" id="is_temp_banned">is_temp_banned(player)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Checks if a player is temp banned</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 check if they are temp banned
</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 player is temp banned</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="#temp_ban_player" class="fragment-hashtag">#</a>
<span class="section-item-title" id="temp_ban_player">temp_ban_player(player, by_player_name[, reason='Non given.'])</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Temp bans a player by moving them to jail, clearing all other roles, storing the reason, and moving their items to spawn</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 that will be temp banned
</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 temp ban
</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 temp banned
(<em>default</em>: 'Non given.')
</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 player was successfully temp banned</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="#untemp_ban_player" class="fragment-hashtag">#</a>
<span class="section-item-title" id="untemp_ban_player">untemp_ban_player(player, by_player_name)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Rrmoves a player from temp ban by clearing the stored reason, removing them from jail, and restoring previous roles</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 who is being removed from temp ban
</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 untemp ban
</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 player was successfully removed</span>
</li>
</ul>
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
@@ -1226,7 +793,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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>

2
docs/control/Production.html
View File

@@ -1347,7 +1347,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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>

2
docs/control/Reports.html
View File

@@ -1160,7 +1160,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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>

2
docs/control/Rockets.html
View File

@@ -1002,7 +1002,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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>

2
docs/control/Tasks.html
View File

@@ -988,7 +988,7 @@ Tasks.update_task(task_id, <span class="string">'We need more iron!'</span>, gam
<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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>

2
docs/control/Warnings.html
View File

@@ -1543,7 +1543,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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>

2
docs/control/Warps.html
View File

@@ -1525,7 +1525,7 @@ Warps.make_warp_tag(warp_id)</code></pre>
<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 2021-01-24 03:04:40 UTC</i>
<i>Last updated 2021-01-27 00:27:15 UTC</i>
</div>
</div>
</div>