Automatic Doc Update

2025-12-27 11:35:22 +09:00 · 2020-09-08 18:12:02 +00:00
parent 3218bb6426
commit b6933bddf8
100 changed files with 204 additions and 105 deletions
--- a/docs/core/Async.html
+++ b/docs/core/Async.html
@@ -613,7 +613,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/Commands.html
+++ b/docs/core/Commands.html
@@ -2428,7 +2428,7 @@ nb: use error(error_message) within your callback to trigger do not trigger dire
    <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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/Common.html
+++ b/docs/core/Common.html
@@ -2767,7 +2767,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/Datastore.html
+++ b/docs/core/Datastore.html
@@ -2964,7 +2964,7 @@ ExampleData:on_update(<span class="keyword">function</span>(key, value)
    <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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/External.html
+++ b/docs/core/External.html
@@ -748,7 +748,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/Groups.html
+++ b/docs/core/Groups.html
@@ -1443,7 +1443,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/Gui.html
+++ b/docs/core/Gui.html
@@ -4421,7 +4421,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/PlayerData.html
+++ b/docs/core/PlayerData.html
@@ -531,7 +531,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>
--- a/docs/core/Roles.html
+++ b/docs/core/Roles.html
@@ -584,7 +584,11 @@ nb: this is a recursive action, and changing the allows and disallows will effec
 nb: this is one way, failing false after already gaining the role will not revoke the role</td>
    </tr>
    <tr>
-    <td class="name"><a href="#Roles._prototype:set_block_auto_promote">Roles._prototype:set_block_auto_promote([state=true])</a></td>
+    <td class="name"><a href="#Roles._prototype:get_auto_assign_condition">Roles._prototype:get_auto_assign_condition()</a></td>
+    <td class="summary">Get the auto assign condition for this role, returns nil if no condition is set</td>
+    </tr>
+    <tr>
+    <td class="name"><a href="#Roles._prototype:set_block_auto_assign">Roles._prototype:set_block_auto_assign([state=true])</a></td>
    <td class="summary">Sets the role to not allow players to have auto assign effect them, useful to keep people locked to a role</td>
    </tr>
    </tbody>
@@ -2932,7 +2936,7 @@ nb: this is one way, failing false after already gaining the role will not revok

    (<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)

-     receives only one param which is player to promote, return true to promote the player
+     receives only one param which is player to assign, return true to assign the player

    </li>

@@ -2967,8 +2971,45 @@ nb: this is one way, failing false after already gaining the role will not revok
    <dt>
    <div class="divider divider-custom"></div>
    <div class="block section-item-header">
-    <a href="#Roles._prototype:set_block_auto_promote" class="fragment-hashtag">#</a>
-    <span class="section-item-title" id="Roles._prototype:set_block_auto_promote">Roles._prototype:set_block_auto_promote([state=true])</span>
+    <a href="#Roles._prototype:get_auto_assign_condition" class="fragment-hashtag">#</a>
+    <span class="section-item-title" id="Roles._prototype:get_auto_assign_condition">Roles._prototype:get_auto_assign_condition()</span>
+    </div>
+    </dt>
+    <dd>
+    <div class="section-item-body">
+
+    <p class="section-item-summary">Get the auto assign condition for this role, returns nil if no condition is set</p>
+    <p class="section-item-description"></p>
+
+    <!-- parameters start -->
+    <!-- parameters end -->
+
+    <!-- returns start -->
+    <strong>Returns:</strong>
+    <ul>
+    <li>
+    (<span class="types"><a class="type" href="https://www.lua.org/pil/2.6.html">function</a></span>)
+    <span class="return-text">The callback which was assigned as the auto assign condition</span>
+    </li>
+    </ul>
+    <!-- returns end -->
+
+
+    <!-- see also start -->
+    <!-- see also end -->
+
+    <!-- usage start -->
+    <strong>Usage:</strong>
+    <pre class="code" data-lang="Lua"><code><span class="comment">-- Give this role to a user if there are admin, ran every 60 seconds
+</span><span class="keyword">local</span> condition = role:get_auto_assign_condition()</code></pre>
+    <!-- usage end -->
+
+    </dd>
+    <dt>
+    <div class="divider divider-custom"></div>
+    <div class="block section-item-header">
+    <a href="#Roles._prototype:set_block_auto_assign" class="fragment-hashtag">#</a>
+    <span class="section-item-title" id="Roles._prototype:set_block_auto_assign">Roles._prototype:set_block_auto_assign([state=true])</span>
    </div>
    </dt>
    <dd>
@@ -3021,7 +3062,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">-- Make a role stop players from being auto assigned to other roles
-</span>role:set_block_auto_promote()</code></pre>
+</span>role:set_block_auto_assign()</code></pre>
    <!-- usage end -->

    </dd>
@@ -3350,7 +3391,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-08-26 14:31:25 UTC</i>
+    <i>Last updated 2020-09-08 18:12:00 UTC</i>
    </div>
    </div>
    </div>