mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-30 12:31:41 +09:00
Automattic Doc Update
This commit is contained in:
Cooldude2606
@@ -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>
|
||||
|
||||
Reference in New Issue
Block a user