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

Automattic Doc Update

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/core/Async.html
View File

@@ -86,6 +86,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>
@@ -124,6 +125,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>
@@ -158,9 +160,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>
@@ -187,8 +191,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>
@@ -245,11 +249,11 @@ Async.register(<span class="keyword">function</span>(player)
<span class="keyword">end</span>)
<span class="comment">-- This will allow us to bypass the error by running one tick later outside of any player scope
</span>Async(promote_player,game.player)
</span>Async(promote_player, game.player)
<span class="comment">-- Here we make an sync function that we want to have a delay, note the delay is not defined here
</span><span class="keyword">local</span> print_message =
Async.register(<span class="keyword">function</span>(player,message)
Async.register(<span class="keyword">function</span>(player, message)
player.<span class="global">print</span>(message)
<span class="keyword">end</span>)
@@ -597,7 +601,7 @@ Async.register(<span class="keyword">function</span>(player, message)
<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>

22
docs/core/Commands.html
View File

@@ -92,6 +92,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>
@@ -130,6 +131,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>
@@ -164,9 +166,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>
@@ -193,8 +197,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>
@@ -266,7 +270,7 @@
msg = <span class="string">':'</span>..msg
<span class="keyword">end</span>
<span class="keyword">for</span> <span class="number">1</span> = <span class="number">1</span>,repeat_count <span class="keyword">do</span>
<span class="keyword">for</span> <span class="number">1</span> = <span class="number">1</span>, repeat_count <span class="keyword">do</span>
Command.<span class="global">print</span>(<span class="number">1.</span>.msg)
<span class="keyword">end</span>
<span class="keyword">end</span>)</code></pre>
@@ -331,7 +335,7 @@
<span class="comment">-- this is where that smiley param is used
</span> msg = <span class="string">':'</span>..msg
<span class="keyword">end</span>
<span class="keyword">for</span> <span class="number">1</span> = <span class="number">1</span>,repeat_count <span class="keyword">do</span>
<span class="keyword">for</span> <span class="number">1</span> = <span class="number">1</span>, repeat_count <span class="keyword">do</span>
<span class="comment">-- this print function will return ANY value to the user in a desync safe manor, this includes if the command was used through rcon
</span> Command.<span class="global">print</span>(<span class="number">1.</span>.msg)
<span class="keyword">end</span>
@@ -339,7 +343,7 @@
</span><span class="keyword">end</span>)
<span class="comment">-- Other values that can be returned from register
</span>Commands.<span class="global">print</span>(any,colour[opt]) <span class="comment">-- this will return any value value to the user including if it is ran through rcon console
</span>Commands.<span class="global">print</span>(any, colour[opt]) <span class="comment">-- this will return any value value to the user including if it is ran through rcon console
</span>Commands.error(message[opt]) <span class="comment">-- this returns a warning to the user, aka an error that does not prevent execution of the command
</span><span class="keyword">return</span> Commands.error(message[opt]) <span class="comment">-- this returns an error to the user, and will halt the command execution, ie no success message is returned
</span>Commands.success(message[opt]) <span class="comment">-- used to return a success message however don't use this method see below
@@ -417,7 +421,7 @@
<span class="keyword">if</span> <span class="keyword">not</span> input <span class="keyword">then</span> <span class="keyword">return</span> <span class="keyword">end</span> <span class="comment">-- nil check
</span>
<span class="comment">-- Example Code:
</span>Commands.add_parse(<span class="string">'number-range-int'</span>,<span class="keyword">function</span>(input, player, reject, range_min, range_max)
</span>Commands.add_parse(<span class="string">'number-range-int'</span>, <span class="keyword">function</span>(input, player, reject, range_min, range_max)
<span class="keyword">local</span> rtn = <span class="global">tonumber</span>(input) <span class="keyword">and</span> <span class="global">math</span>.floor(<span class="global">tonumber</span>(input)) <span class="keyword">or</span> <span class="keyword">nil</span> <span class="comment">-- converts input to number
</span> <span class="keyword">if</span> <span class="keyword">not</span> rtn <span class="keyword">or</span> rtn &lt; range_min <span class="keyword">or</span> rtn &gt; range_max <span class="keyword">then</span>
<span class="comment">-- the input is either not a number or is outside the range
@@ -1997,7 +2001,7 @@ nb: this must be the last function ran on the command and must be done for the c
<span class="keyword">local</span> msg = <span class="string">') '</span>..player.name
<span class="keyword">if</span> smiley <span class="keyword">then</span> msg = <span class="string">':'</span>..msg <span class="keyword">end</span>
<span class="keyword">for</span> <span class="number">1</span> = <span class="number">1</span>,repeat_count <span class="keyword">do</span>
<span class="keyword">for</span> <span class="number">1</span> = <span class="number">1</span>, repeat_count <span class="keyword">do</span>
Command.<span class="global">print</span>(<span class="number">1.</span>.msg)
<span class="keyword">end</span>
<span class="keyword">end</span>)</code></pre>
@@ -2175,7 +2179,7 @@ nb: use error(error_message) within your callback to trigger do not trigger dire
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Used in the command system to log handler errors
</span><span class="keyword">local</span> success, err = <span class="global">pcall</span>(command_data.callback, player, unpack(params))
</span><span class="keyword">local</span> success, err = <span class="global">pcall</span>(command_data.callback, player, <span class="global">unpack</span>(params))
<span class="keyword">if</span> Commands.internal_error(success, command_data.name, err) <span class="keyword">then</span>
<span class="keyword">return</span> command_log(player, command_data, <span class="string">'Internal Error: Command Callback Fail'</span>, raw_params, command_event.parameter, err)
<span class="keyword">end</span></code></pre>
@@ -2382,7 +2386,7 @@ nb: returning any value from your callback will trigger this function, return th
<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>

36
docs/core/Common.html
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>

10
docs/core/Groups.html
View File

@@ -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>
@@ -1427,7 +1431,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>

38
docs/core/Gui.html
View File

@@ -94,6 +94,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>
@@ -132,6 +133,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>
@@ -166,9 +168,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>
@@ -195,8 +199,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>
@@ -261,7 +265,7 @@ Gui.element{
<pre class="code" data-lang="Lua"><code><span class="comment">-- Making a factory function for a button which is contained within a flow
</span><span class="comment">-- This method is for when you still want to register event handlers but cant use the table method
</span><span class="keyword">local</span> example_flow_with_button =
Gui.element(<span class="keyword">function</span>(event_trigger,parent,...)
Gui.element(<span class="keyword">function</span>(event_trigger, parent, ...)
<span class="comment">-- ... shows that all other arguments from the factory call are passed to this function
</span> <span class="comment">-- Here we are adding a flow which we will then later add a button to
</span> <span class="keyword">local</span> flow =
@@ -301,7 +305,7 @@ Gui.element{
caption = <span class="string">'Example Button'</span>,
style = <span class="string">'forward_button'</span> <span class="comment">-- factorio styles can be applied here
</span>}
:style(<span class="keyword">function</span>(style,element,...)
:style(<span class="keyword">function</span>(style, element, ...)
<span class="comment">-- style is the current style object for the elemenent
</span> <span class="comment">-- element is the element that is being changed
</span> <span class="comment">-- ... shows that all other arguments from the factory call are passed to this function
@@ -316,7 +320,7 @@ Gui.element{
<span class="global">type</span> = <span class="string">'button'</span>,
caption = <span class="string">'Example Button'</span>
}
:on_click(<span class="keyword">function</span>(player,element,event)
:on_click(<span class="keyword">function</span>(player, element, event)
<span class="comment">-- player is the player who interacted with the element to cause the event
</span> <span class="comment">-- element is a refrence to the element which caused the event
</span> <span class="comment">-- event is a raw refrence to the event data if player and element are not enough
@@ -337,20 +341,20 @@ Gui.element{
width = <span class="number">18</span>,
height = <span class="number">20</span>
}
:on_click(<span class="keyword">function</span>(player,_,_)
:on_click(<span class="keyword">function</span>(player, _,_)
Gui.hide_left_flow(player)
<span class="keyword">end</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Eample from defines, Gui.alignment, called like: Gui.alignment(parent, name, horizontal_align, vertical_align)
</span><span class="comment">-- Notice how _ are used to blank arguments that are not needed in that context and how they line up with above
</span>Gui.alignment =
Gui.element(<span class="keyword">function</span>(_,parent,name,_,_)
Gui.element(<span class="keyword">function</span>(_, parent, name, _,_)
<span class="keyword">return</span> parent.add{
name = name <span class="keyword">or</span> <span class="string">'alignment'</span>,
<span class="global">type</span> = <span class="string">'flow'</span>,
}
<span class="keyword">end</span>)
:style(<span class="keyword">function</span>(style,_,_,horizontal_align,vertical_align)
style.padding = {<span class="number">1</span>,<span class="number">2</span>}
:style(<span class="keyword">function</span>(style, _,_, horizontal_align, vertical_align)
style.padding = {<span class="number">1</span>, <span class="number">2</span>}
style.vertical_align = vertical_align <span class="keyword">or</span> <span class="string">'center'</span>
style.horizontal_align = horizontal_align <span class="keyword">or</span> <span class="string">'right'</span>
style.vertically_stretchable = style.vertical_align ~= <span class="string">'center'</span>
@@ -1170,9 +1174,9 @@ Gui.element(<span class="keyword">function</span>(_,parent,name,_,_)
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding a right align flow
</span><span class="keyword">local</span> alignment = Gui.alignment(element,<span class="string">'example_right_alignment'</span>)</code></pre>
</span><span class="keyword">local</span> alignment = Gui.alignment(element, <span class="string">'example_right_alignment'</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding a horizontal center and top align flow
</span><span class="keyword">local</span> alignment = Gui.alignment(element,<span class="string">'example_center_top_alignment'</span>,<span class="string">'center'</span>,<span class="string">'top'</span>)</code></pre>
</span><span class="keyword">local</span> alignment = Gui.alignment(element, <span class="string">'example_center_top_alignment'</span>, <span class="string">'center'</span>, <span class="string">'top'</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -1274,7 +1278,7 @@ Gui.element(<span class="keyword">function</span>(_,parent,name,_,_)
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding a scroll table with max height of 200 and column count of 3
</span><span class="keyword">local</span> scroll_table = Gui.scroll_table(element,<span class="number">200</span>,<span class="number">3</span>)</code></pre>
</span><span class="keyword">local</span> scroll_table = Gui.scroll_table(element, <span class="number">200</span>, <span class="number">3</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -1607,7 +1611,7 @@ Gui.element(<span class="keyword">function</span>(_,parent,name,_,_)
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Adding a container as a base
</span><span class="keyword">local</span> container = Gui.container(parent,<span class="string">'my_container'</span>,<span class="number">200</span>)</code></pre>
</span><span class="keyword">local</span> container = Gui.container(parent, <span class="string">'my_container'</span>, <span class="number">200</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -2921,7 +2925,7 @@ Gui.element{
<pre class="code" data-lang="Lua"><code><span class="comment">-- Using element defines with a custom factory function
</span><span class="comment">-- This method can be used if you still want to be able register event handlers but it is too complex to be compatible with LuaGuiElement.add
</span><span class="keyword">local</span> example_flow_with_button =
Gui.element(<span class="keyword">function</span>(event_trigger,parent,...)
Gui.element(<span class="keyword">function</span>(event_trigger, parent, ...)
<span class="comment">-- ... shows that all other arguments from the factory call are passed to this function
</span> <span class="comment">-- parent is the element which was passed to the factory function where you should add your new element
</span> <span class="comment">-- here we are adding a flow which we will then later add a button to
@@ -3021,7 +3025,7 @@ Gui.element{
caption = <span class="string">'Example Button'</span>,
style = <span class="string">'forward_button'</span> <span class="comment">-- factorio styles can be applied here
</span>}
:style(<span class="keyword">function</span>(style,element,...)
:style(<span class="keyword">function</span>(style, element, ...)
<span class="comment">-- style is the current style object for the elemenent
</span> <span class="comment">-- element is the element that is being changed
</span> <span class="comment">-- ... shows that all other arguments from the factory call are passed to this function
@@ -4150,7 +4154,7 @@ element_define:raise_custom_event{
<pre class="code" data-lang="Lua"><code><span class="comment">-- Toggle your flow
</span>Gui.toggle_top_flow(game.player)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Open your top flow
</span>Gui.toggle_top_flow(game.player,<span class="keyword">true</span>)</code></pre>
</span>Gui.toggle_top_flow(game.player, <span class="keyword">true</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -4405,7 +4409,7 @@ Gui.left_toolbar_button(<span class="string">'entity/inserter'</span>, <span cla
<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>

52
docs/core/Roles.html
View File

@@ -93,6 +93,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>
@@ -131,6 +132,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>
@@ -165,9 +167,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>
@@ -194,8 +198,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>
@@ -249,13 +253,13 @@
<pre class="code" data-lang="Lua"><code><span class="comment">--- Using Role System (assignment):
</span><span class="comment">--When a map first starts you will want to define on mass all the players you expect to join and the roles to give them:
</span>Roles.override_player_roles{
Cooldude2606 = {<span class="string">'Owner'</span>,<span class="string">'Admin'</span>,<span class="string">'Member'</span>},
Cooldude2606 = {<span class="string">'Owner'</span>, <span class="string">'Admin'</span>, <span class="string">'Member'</span>},
NotCooldude2606 = {<span class="string">'Member'</span>}
}
<span class="comment">--Once the game is running you still want to be able to give role and remove them which is when you would use:
</span>Roles.assign_player(player,<span class="string">'Admin'</span>,by_player_name) <span class="comment">-- this will give the "Admin" role to the player
</span>Roles.unassign_player(player,{<span class="string">'Admin'</span>,<span class="string">'Moderator'</span>},by_player_name) <span class="comment">-- this will remove "Admin" and "Moderator" role in one go
</span>Roles.assign_player(player, <span class="string">'Admin'</span>, by_player_name) <span class="comment">-- this will give the "Admin" role to the player
</span>Roles.unassign_player(player, {<span class="string">'Admin'</span>, <span class="string">'Moderator'</span>}, by_player_name) <span class="comment">-- this will remove "Admin" and "Moderator" role in one go
</span></code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">--- Using Role System (role testing):
</span><span class="comment">--To comparer two players you can comparer the index of they highest roles, can be used when you want to allow a "write" down type system:
@@ -265,9 +269,9 @@
</span>Roles.get_player_roles(player) <span class="comment">-- the return is an array that can be looped over however this is not in particular order
</span>
<span class="comment">--Finally you may want to test if a player has a certain role, flag or action allowed which is when you would use:
</span>Roles.player_has_role(player,<span class="string">'Admin'</span>) <span class="comment">-- you can provide a role name if you only want a name based system
</span>Roles.player_has_flag(player,<span class="string">'is_donator'</span>) <span class="comment">-- your roles can be grouped together with flags such as is_donator
</span>Roles.player_allowed(player,<span class="string">'game modifiers'</span>) <span class="comment">-- or you can have an action based system where each action is something the player can do
</span>Roles.player_has_role(player, <span class="string">'Admin'</span>) <span class="comment">-- you can provide a role name if you only want a name based system
</span>Roles.player_has_flag(player, <span class="string">'is_donator'</span>) <span class="comment">-- your roles can be grouped together with flags such as is_donator
</span>Roles.player_allowed(player, <span class="string">'game modifiers'</span>) <span class="comment">-- or you can have an action based system where each action is something the player can do
</span></code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">--- Example Flag Define:
</span><span class="comment">--Flags can be used to group multiple roles and actions under one catch all, for example if you want a piece of code to only
@@ -275,7 +279,7 @@
</span><span class="comment">--a player has that tag present:
</span>
<span class="comment">-- give you donators a speed boost when they join; these functions aren't required but can be useful
</span>Roles.define_flag_trigger(<span class="string">'is_donator'</span>,<span class="keyword">function</span>(player,state)
</span>Roles.define_flag_trigger(<span class="string">'is_donator'</span>, <span class="keyword">function</span>(player, state)
<span class="keyword">if</span> state <span class="keyword">then</span>
player.character_running_speed_modifier = <span class="number">1.5</span>
<span class="keyword">else</span>
@@ -288,29 +292,29 @@
:set_flag(<span class="string">'is_donator'</span>)
<span class="comment">-- and in your code you would test for
</span><span class="keyword">if</span> Roles.player_has_flag(player,<span class="string">'is_donator'</span>) <span class="keyword">then</span>
</span><span class="keyword">if</span> Roles.player_has_flag(player, <span class="string">'is_donator'</span>) <span class="keyword">then</span>
<span class="comment">-- some donator only code
</span><span class="keyword">end</span></code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">--- Example Role Define:
</span><span class="comment">--You can't use a role system without any roles so first you must define your roles; each role has a minimum of a name with
</span><span class="comment">--the option for a shorthand:
</span>Roles.new_role(<span class="string">'Administrator'</span>,<span class="string">'Admin'</span>)
</span>Roles.new_role(<span class="string">'Administrator'</span>, <span class="string">'Admin'</span>)
<span class="comment">--Next you will want to add any extras you want to have, such as a tag, colour, permission group or any custom flags:
</span>Roles.new_role(<span class="string">'Administrator'</span>,<span class="string">'Admin'</span>)
</span>Roles.new_role(<span class="string">'Administrator'</span>, <span class="string">'Admin'</span>)
:set_custom_tag(<span class="string">'[Admin]'</span>)
:set_custom_color(<span class="string">'red'</span>) <span class="comment">-- this can be {r=0,g=0,b=0} or a predefined value
:set_custom_color(<span class="string">'red'</span>) <span class="comment">-- this can be {r=0, g=0, b=0} or a predefined value
</span>:set_permission_group(<span class="string">'Staff'</span>) <span class="comment">-- a second argument can be added if you have not used the custom permission group config
</span>:set_flag(<span class="string">'is_admin'</span>)
<span class="comment">--You will then want to decide if you want to allow all actions, this should of course be used sparely:
</span>Roles.new_role(<span class="string">'Administrator'</span>,<span class="string">'Admin'</span>)
</span>Roles.new_role(<span class="string">'Administrator'</span>, <span class="string">'Admin'</span>)
...extras...
:set_allow_all()
<span class="comment">--If you don't do this want this as i would advise you do then you will want to define what the role can do; this comes with
</span><span class="comment">--an optional inheritance system if you like those sort of things in which case disallow may also be of some use to you:
</span>Roles.new_role(<span class="string">'Administrator'</span>,<span class="string">'Admin'</span>)
</span>Roles.new_role(<span class="string">'Administrator'</span>, <span class="string">'Admin'</span>)
...extras...
:set_parent(<span class="string">'Moderator'</span>) <span class="comment">-- the admin can do anything that a moderator can do
</span>:allow{ <span class="comment">-- these actions can be anything just try to keep them without conflicts
@@ -319,7 +323,7 @@
}
<span class="comment">--Here is what the finished admin role would look like:
</span>Roles.new_role(<span class="string">'Administrator'</span>,<span class="string">'Admin'</span>)
</span>Roles.new_role(<span class="string">'Administrator'</span>, <span class="string">'Admin'</span>)
:set_custom_tag(<span class="string">'[Admin]'</span>)
:set_custom_color(<span class="string">'red'</span>)
:set_permission_group(<span class="string">'Staff'</span>)
@@ -413,7 +417,7 @@ Roles.define_role_order{
</tr>
<tr>
<td class="name"><a href="#get_role_from_any">get_role_from_any(any)</a></td>
<td class="summary">Gets a role from a name,index or role object (where it is just returned)
<td class="summary">Gets a role from a name, index or role object (where it is just returned)
nb: this function is used for the input for most outward facing functions</td>
</tr>
<tr>
@@ -531,7 +535,7 @@ nb: this function is used for the input for most outward facing functions</td>
</tr>
<tr>
<td class="name"><a href="#Roles._prototype:clear_flags">Roles._prototype:clear_flags()</a></td>
<td class="summary">Clears all flags from this role, individual flags can be removed with set_flag(name,false)</td>
<td class="summary">Clears all flags from this role, individual flags can be removed with set_flag(name, false)</td>
</tr>
<tr>
<td class="name"><a href="#Roles._prototype:has_flag">Roles._prototype:has_flag(name)</a></td>
@@ -884,7 +888,7 @@ nb: this is one way, failing false after already gaining the role will not revok
<!-- usage start -->
<strong>Usage:</strong>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Print a message to the given roles
</span>Roles.print_to_roles({<span class="string">'Administrator'</span>,<span class="string">'Moderator'</span>}, <span class="string">'Hello, World!'</span>)</code></pre>
</span>Roles.print_to_roles({<span class="string">'Administrator'</span>, <span class="string">'Moderator'</span>}, <span class="string">'Hello, World!'</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -1156,7 +1160,7 @@ nb: this is one way, failing false after already gaining the role will not revok
<dd>
<div class="section-item-body">
<p class="section-item-summary">Gets a role from a name,index or role object (where it is just returned)
<p class="section-item-summary">Gets a role from a name, index or role object (where it is just returned)
nb: this function is used for the input for most outward facing functions</p>
<p class="section-item-description"></p>
@@ -1643,8 +1647,8 @@ nb: this function is used for the input for most outward facing functions</p>
</span>Roles.override_player_roles(<span class="string">'Cooldude2606'</span>, {<span class="string">'Moderator'</span>})</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Override all existing roles, effects all users not just ones listed
</span>Roles.override_player_roles{
[<span class="string">'Cooldude2606'</span>] = {<span class="string">'Administrator'</span>,<span class="string">'Moderator'</span>},
[<span class="string">'arty714'</span>] = {<span class="string">'Administrator'</span>,<span class="string">'Moderator'</span>},
[<span class="string">'Cooldude2606'</span>] = {<span class="string">'Administrator'</span>, <span class="string">'Moderator'</span>},
[<span class="string">'arty714'</span>] = {<span class="string">'Administrator'</span>, <span class="string">'Moderator'</span>},
}</code></pre>
<!-- usage end -->
@@ -2537,7 +2541,7 @@ nb: this function is used for the input for most outward facing functions</p>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Clears all flags from this role, individual flags can be removed with set_flag(name,false)</p>
<p class="section-item-summary">Clears all flags from this role, individual flags can be removed with set_flag(name, false)</p>
<p class="section-item-description"></p>
<!-- parameters start -->
@@ -3334,7 +3338,7 @@ nb: this is one way, failing false after already gaining the role will not revok
<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>

58
docs/core/Store.html
View File

@@ -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>
@@ -244,13 +248,13 @@
</span><span class="keyword">local</span> scenario_diffculty = Store.register()
<span class="comment">-- When the store is changed this function will trigger
</span>Store.watch(scenario_diffculty,<span class="keyword">function</span>(value)
</span>Store.watch(scenario_diffculty, <span class="keyword">function</span>(value)
game.<span class="global">print</span>(<span class="string">'The scenario diffculty has been set to '</span>..value)
<span class="keyword">end</span>)
Store.set(scenario_diffculty,<span class="string">'hard'</span>) <span class="comment">-- Set the value stored to 'hard'
Store.set(scenario_diffculty, <span class="string">'hard'</span>) <span class="comment">-- Set the value stored to 'hard'
</span>Store.get(scenario_diffculty) <span class="comment">-- Returns 'hard'
</span>Store.update(scenario_diffculty,<span class="keyword">function</span>(value) <span class="comment">-- Will set value to 'normal' if no value is present
</span>Store.update(scenario_diffculty, <span class="keyword">function</span>(value) <span class="comment">-- Will set value to 'normal' if no value is present
</span> <span class="keyword">return</span> <span class="keyword">not</span> value <span class="keyword">and</span> <span class="string">'normal'</span>
<span class="keyword">end</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Require the module and add a store with keys
@@ -261,13 +265,13 @@ Store.set(scenario_diffculty,<span class="string">'hard'</span>) <span class="co
<span class="keyword">end</span>)
<span class="comment">-- When any key in the store is changed this function will trigger
</span>Store.watch(player_scores,<span class="keyword">function</span>(value,key,old_value)
</span>Store.watch(player_scores, <span class="keyword">function</span>(value, key, old_value)
game.<span class="global">print</span>(key..<span class="string">' now has a score of '</span>..value)
<span class="keyword">end</span>)
Store.set(player_scores,game.player,<span class="number">10</span>) <span class="comment">-- Set your score to 10
</span>Store.get(scenario_diffculty,game.player) <span class="comment">-- Returns 10
</span>Store.update(scenario_diffculty,game.player,<span class="keyword">function</span>(value) <span class="comment">-- Add 1 to your score
Store.set(player_scores, game.player, <span class="number">10</span>) <span class="comment">-- Set your score to 10
</span>Store.get(scenario_diffculty, game.player) <span class="comment">-- Returns 10
</span>Store.update(scenario_diffculty, game.player, <span class="keyword">function</span>(value) <span class="comment">-- Add 1 to your score
</span> <span class="keyword">return</span> value + <span class="number">1</span>
<span class="keyword">end</span>)</code></pre>
<!-- module usage end -->
@@ -639,7 +643,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- player_scores is a valid store and key will be your player name
</span><span class="keyword">local</span> key = Store.validate(player_scores,game.player)</code></pre>
</span><span class="keyword">local</span> key = Store.validate(player_scores, game.player)</code></pre>
<!-- usage end -->
</dd>
@@ -777,12 +781,12 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
</span><span class="keyword">local</span> scenario_diffculty = Store.register()
<span class="comment">-- Register the watcher so that when we change the value the message is printed
</span>Store.watch(scenario_diffculty,<span class="keyword">function</span>(value)
</span>Store.watch(scenario_diffculty, <span class="keyword">function</span>(value)
game.<span class="global">print</span>(<span class="string">'The scenario diffculty has been set to '</span>..value)
<span class="keyword">end</span>)
<span class="comment">-- Set a new value for the diffculty and see that it has printed to the game
</span>Store.set(scenario_diffculty,<span class="string">'hard'</span>)</code></pre>
</span>Store.set(scenario_diffculty, <span class="string">'hard'</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Printing the changed value to all players, with keys
</span><span class="comment">-- Register the new store, we are not using player names as the keys so it would be useful to accept LuaPlayer objects
</span><span class="keyword">local</span> player_scores = Store.register(<span class="keyword">function</span>(player)
@@ -790,12 +794,12 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- Register the watcher so that when we change the value the message is printed
</span>Store.watch(player_scores,<span class="keyword">function</span>(value,key,old_value)
</span>Store.watch(player_scores, <span class="keyword">function</span>(value, key, old_value)
game.<span class="global">print</span>(key..<span class="string">' now has a score of '</span>..value)
<span class="keyword">end</span>)
<span class="comment">-- Set a new value for your score and see that it has printed to the game
</span>Store.set(player_scores,game.player,<span class="number">10</span>)</code></pre>
</span>Store.set(player_scores, game.player, <span class="number">10</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -887,7 +891,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- Get your current score
</span><span class="keyword">local</span> my_score = Store.get(player_scores,game.player)
</span><span class="keyword">local</span> my_score = Store.get(player_scores, game.player)
<span class="comment">-- Get all scores
</span>lcoal scores = Store.get(player_scores)</code></pre>
@@ -972,7 +976,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- Clear your score
</span>Store.clear(player_scores,game.player)
</span>Store.clear(player_scores, game.player)
<span class="comment">-- Clear all scores
</span>Store.clear(player_scores)</code></pre>
@@ -1065,7 +1069,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
</span><span class="keyword">local</span> scenario_diffculty = Store.register()
<span class="comment">-- Set the new scenario diffculty
</span>Store.set(scenario_diffculty,<span class="string">'hard'</span>)</code></pre>
</span>Store.set(scenario_diffculty, <span class="string">'hard'</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Set data in a store with keys
</span><span class="comment">-- Register the new store, we are not using player names as the keys so it would be useful to accept LuaPlayer objects
</span><span class="keyword">local</span> player_scores = Store.register(<span class="keyword">function</span>(player)
@@ -1073,10 +1077,10 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- Set your current score
</span>Store.set(player_scores,game.player,<span class="number">10</span>)
</span>Store.set(player_scores, game.player, <span class="number">10</span>)
<span class="comment">-- Set all scores, note this might not have much use
</span>Store.set(player_scores,{
</span>Store.set(player_scores, {
[game.player.name] = <span class="number">10</span>,
[<span class="string">'SomeOtherPlayer'</span>] = <span class="number">0</span>
})</code></pre>
@@ -1169,10 +1173,10 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
</span><span class="keyword">local</span> game_score = Store.register()
<span class="comment">-- Setting a default value
</span>Store.set(game_score,<span class="number">0</span>)
</span>Store.set(game_score, <span class="number">0</span>)
<span class="comment">-- We now will update the game score by one, we return the value so that it is set as the new value in the store
</span>Store.update(game_score,<span class="keyword">function</span>(value)
</span>Store.update(game_score, <span class="keyword">function</span>(value)
<span class="keyword">return</span> value + <span class="number">1</span>
<span class="keyword">end</span>)</code></pre>
<pre class="code" data-lang="Lua"><code><span class="comment">-- Updating keys in a table of data
@@ -1182,7 +1186,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- Setting a default value for your player, used to show the table structure
</span>Store.set(player_data,game.player,{
</span>Store.set(player_data, game.player, {
group = <span class="string">'Admin'</span>,
role = <span class="string">'Owner'</span>,
show_group_config = <span class="keyword">false</span>
@@ -1190,7 +1194,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="comment">-- Updating the show_group_config key in your player data, note that it would be harder to call set every time
</span><span class="comment">-- We do not need to return anything in this case as we are not replacing all the data
</span>Store.update(player_data,game.player,<span class="keyword">function</span>(data)
</span>Store.update(player_data, game.player, <span class="keyword">function</span>(data)
data.show_group_config = <span class="keyword">not</span> data.show_group_config
<span class="keyword">end</span>)</code></pre>
<!-- usage end -->
@@ -1267,7 +1271,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="keyword">end</span>)
<span class="comment">-- Setting a default value for your player, used to show the table structure
</span>Store.set(player_data,game.player,{
</span>Store.set(player_data, game.player, {
group = <span class="string">'Admin'</span>,
role = <span class="string">'Owner'</span>,
show_group_config = <span class="keyword">false</span>
@@ -1276,7 +1280,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="comment">-- Updating the show_group_config key for all players, note that it would be harder to call set every time
</span><span class="comment">-- We do not need to return anything in this case as we are not replacing all the data
</span><span class="comment">-- We also have access to the current key being updated if needed
</span>Store.map(player_data,<span class="keyword">function</span>(data,key)
</span>Store.map(player_data, <span class="keyword">function</span>(data, key)
data.show_group_config = <span class="keyword">not</span> data.show_group_config
<span class="keyword">end</span>)</code></pre>
<!-- usage end -->
@@ -1461,7 +1465,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<span class="comment">-- Trigger the watchers with a fake change of diffculty
</span><span class="comment">-- This is mostly used internally but it can be useful in other cases
</span>Store.raw_trigger(scenario_diffculty,<span class="keyword">nil</span>,<span class="string">'normal'</span>,<span class="string">'normal'</span>)</code></pre>
</span>Store.raw_trigger(scenario_diffculty, <span class="keyword">nil</span>, <span class="string">'normal'</span>, <span class="string">'normal'</span>)</code></pre>
<!-- usage end -->
</dd>
@@ -1480,7 +1484,7 @@ Store.set(player_scores,game.player,<span class="number">10</span>) <span class=
<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>