mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-30 12:31:41 +09:00
Updated Docs
This commit is contained in:
Cooldude2606
@@ -53,13 +53,13 @@
|
||||
<li class="nav-item">
|
||||
<h2>Core</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Async.html"><span class="module-name-item">Async</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Commands.html"><span class="module-name-item">Commands</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Common-Library.html"><span class="module-name-item">Common-Library</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Common.html"><span class="module-name-item">Common</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Gui.html"><span class="module-name-item">Gui</span></a></div></li>
|
||||
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../core/Permissions-Groups.html"><span class="module-name-item">Permissions-Groups</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Roles.html"><span class="module-name-item">Roles</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Store.html"><span class="module-name-item">Store</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../core/Sudo.html"><span class="module-name-item">Sudo</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -88,10 +88,12 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Damage-Popups.html"><span class="module-name-item">Damage-Popups</span></a></div></li>
|
||||
<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/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>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Spawn-Area.html"><span class="module-name-item">Spawn-Area</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../addons/Tree-Decon.html"><span class="module-name-item">Tree-Decon</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -100,8 +102,10 @@
|
||||
<h2>Guis</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/Player-List.html"><span class="module-name-item">Player-List</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/Readme.html"><span class="module-name-item">Readme</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/Rocket-Info.html"><span class="module-name-item">Rocket-Info</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/Science-Info.html"><span class="module-name-item">Science-Info</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/server-ups.html"><span class="module-name-item">server-ups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/Task-List.html"><span class="module-name-item">Task-List</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../guis/Warps-List.html"><span class="module-name-item">Warps-List</span></a></div></li>
|
||||
</ul>
|
||||
@@ -139,7 +143,6 @@
|
||||
<h2>Configs</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/File-Loader.html"><span class="module-name-item">File-Loader</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Player-List.html"><span class="module-name-item">Player-List</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Advanced-Start.html"><span class="module-name-item">Advanced-Start</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Bonuses.html"><span class="module-name-item">Bonuses</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Chat-Reply.html"><span class="module-name-item">Chat-Reply</span></a></div></li>
|
||||
@@ -148,22 +151,23 @@
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/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="../configs/Commands-Auth-Admin.html"><span class="module-name-item">Commands-Auth-Admin</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Commands-Auth-Roles.html"><span class="module-name-item">Commands-Auth-Roles</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Commands-Auth-Runtime-Disable.html"><span class="module-name-item">Commands-Auth-Runtime-Disable</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Commands-Parse.html"><span class="module-name-item">Commands-Parse</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Commands-Parse-Roles.html"><span class="module-name-item">Commands-Parse-Roles</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Commands-Auth-Runtime-Disable.html"><span class="module-name-item">Commands-Auth-Runtime-Disable</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Permission-Groups.html"><span class="module-name-item">Permission-Groups</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Roles.html"><span class="module-name-item">Roles</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Player-List.html"><span class="module-name-item">Player-List</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Rockets.html"><span class="module-name-item">Rockets</span></a></div></li>
|
||||
<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/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/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/Rockets.html"><span class="module-name-item">Rockets</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../configs/Roles.html"><span class="module-name-item">Roles</span></a></div></li>
|
||||
<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/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>
|
||||
<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/Warnings.html"><span class="module-name-item">Warnings</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>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -172,18 +176,13 @@
|
||||
<h2>Modules</h2>
|
||||
<ul class="nav">
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/control.html"><span class="module-name-item">control</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.alien_evolution_progress.html"><span class="module-name-item">utils.alien_evolution_progress</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.core.html"><span class="module-name-item">utils.core</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.debug.html"><span class="module-name-item">utils.debug</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.dump_env.html"><span class="module-name-item">utils.dump_env</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.station-auto-name.html"><span class="module-name-item">modules.addons.station-auto-name</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/overrides.debug.html"><span class="module-name-item">overrides.debug</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/overrides.math.html"><span class="module-name-item">overrides.math</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/overrides.table.html"><span class="module-name-item">overrides.table</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.event.html"><span class="module-name-item">utils.event</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.event_core.html"><span class="module-name-item">utils.event_core</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.math.html"><span class="module-name-item">utils.math</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.recipe_locker.html"><span class="module-name-item">utils.recipe_locker</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.state_machine.html"><span class="module-name-item">utils.state_machine</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.table.html"><span class="module-name-item">utils.table</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.task.html"><span class="module-name-item">utils.task</span></a></div></li>
|
||||
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.timestamp.html"><span class="module-name-item">utils.timestamp</span></a></div></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -230,7 +229,7 @@
|
||||
|
||||
<h2><span class="body-module-name"><strong><em>Permissions-Groups</em></strong></span> core</h2>
|
||||
<p>Core Module - Permission Groups
|
||||
- Permission group making for factorio so you never have to make one by hand again</p>
|
||||
- Permission group making for factorio so you never have to make one by hand again</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
@@ -239,26 +238,22 @@
|
||||
|
||||
<!-- module usage start -->
|
||||
<h3>Usage</h3>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">---- Example Group (Allow All)
|
||||
</span>
|
||||
<span class="comment">-- here we will create an admin group however we do not want them to use the map editor or mess with the permission groups
|
||||
</span> Permission_Groups.new_group(<span class="string">'Admin'</span>) <span class="comment">-- this defines a new group called "Admin"
|
||||
</span> :allow_all() <span class="comment">-- this makes the default to allow any input action unless set other wise
|
||||
</span> :disallow{ <span class="comment">-- here we disallow the input action we don't want them to use
|
||||
</span> <span class="string">'add_permission_group'</span>,
|
||||
<span class="string">'delete_permission_group'</span>,
|
||||
<span class="string">'import_permissions_string'</span>,
|
||||
<span class="string">'map_editor_action'</span>,
|
||||
<span class="string">'toggle_map_editor'</span>
|
||||
}</code></pre>
|
||||
<pre class="code" data-lang="Lua"><code>
|
||||
<span class="comment">---- Example Group (Disallow All)
|
||||
</span>
|
||||
<span class="comment">-- here we will create a group that cant do anything but talk in chat
|
||||
</span> Permission_Groups.new_group(<span class="string">'Restricted'</span>) <span class="comment">-- this defines a new group called "Restricted"
|
||||
</span> :disallow_all() <span class="comment">-- this makes the default to disallow any input action unless set other wise
|
||||
</span> :allow(<span class="string">'write_to_console'</span>) <span class="comment">-- here we allow them to chat, {} can be used here if we had more than one action
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">--- Example Group (Allow All)
|
||||
</span><span class="comment">-- here we will create an admin group however we do not want them to use the map editor or mess with the permission groups
|
||||
</span>Permission_Groups.new_group(<span class="string">'Admin'</span>) <span class="comment">-- this defines a new group called "Admin"
|
||||
</span>:allow_all() <span class="comment">-- this makes the default to allow any input action unless set other wise
|
||||
</span>:disallow{ <span class="comment">-- here we disallow the input action we don't want them to use
|
||||
</span> <span class="string">'add_permission_group'</span>,
|
||||
<span class="string">'delete_permission_group'</span>,
|
||||
<span class="string">'import_permissions_string'</span>,
|
||||
<span class="string">'map_editor_action'</span>,
|
||||
<span class="string">'toggle_map_editor'</span>
|
||||
}</code></pre>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">--- Example Group (Disallow All)
|
||||
</span><span class="comment">-- here we will create a group that cant do anything but talk in chat
|
||||
</span>Permission_Groups.new_group(<span class="string">'Restricted'</span>) <span class="comment">-- this defines a new group called "Restricted"
|
||||
</span>:disallow_all() <span class="comment">-- this makes the default to disallow any input action unless set other wise
|
||||
</span>:allow(<span class="string">'write_to_console'</span>) <span class="comment">-- here we allow them to chat, {} can be used here if we had more than one action
|
||||
</span></code></pre>
|
||||
<!-- module usage end -->
|
||||
|
||||
@@ -278,7 +273,7 @@
|
||||
<td class="name"><a href="#utils.event">utils.event</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#expcore.sudo">expcore.sudo</a></td>
|
||||
<td class="name"><a href="#expcore.async">expcore.async</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -313,10 +308,6 @@
|
||||
<td class="summary">Reloads/creates all permission groups and sets them to they configured state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#lockdown_permissions">lockdown_permissions(exempt)</a></td>
|
||||
<td class="summary">Removes all permissions from every permission group except for "Default" and any passed as exempt</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#set_player_group">set_player_group(player, group)</a></td>
|
||||
<td class="summary">Sets a player's group to the one given, a player can only have one group at a time</td>
|
||||
</tr>
|
||||
@@ -361,14 +352,14 @@
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="name"><a href="#Permissions_Groups._prototype:get_raw">Permissions_Groups._prototype:get_raw()</a></td>
|
||||
<td class="summary">Returns the LuaPermissionGroup that was created with this group object, used internally</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Permissions_Groups._prototype:create">Permissions_Groups._prototype:create()</a></td>
|
||||
<td class="summary">Creates or updates the permission group with the configured actions, used internally</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Permissions_Groups._prototype:get_raw">Permissions_Groups._prototype:get_raw()</a></td>
|
||||
<td class="summary">Returns the LuaPermissionGroup that was created with this group object, used internally</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#Permissions_Groups._prototype:add_player">Permissions_Groups._prototype:add_player(player)</a></td>
|
||||
<td class="summary">Adds a player to this group</td>
|
||||
</tr>
|
||||
@@ -446,8 +437,8 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#expcore.sudo" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="expcore.sudo">expcore.sudo</span>
|
||||
<a href="#expcore.async" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="expcore.async">expcore.async</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -525,6 +516,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Defining a new permission group
|
||||
</span>Groups.new_group(<span class="string">'Admin'</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -582,6 +576,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Getting a permision group
|
||||
</span><span class="keyword">local</span> admin_group = Groups.get_group_by_name(<span class="string">'Admin'</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -639,6 +636,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Get your permission group
|
||||
</span><span class="keyword">local</span> group = Groups.get_group_from_player(game.player)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -669,63 +669,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#lockdown_permissions" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="lockdown_permissions">lockdown_permissions(exempt)</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Removes all permissions from every permission group except for "Default" and any passed as exempt</p>
|
||||
<p class="section-item-description"></p>
|
||||
|
||||
<!-- parameters start -->
|
||||
<strong>Parameters:</strong>
|
||||
|
||||
<ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="section-subitem-li">
|
||||
|
||||
<strong><em>exempt</em></strong>
|
||||
|
||||
<strong> : </strong>
|
||||
|
||||
(<span class="types"><a class="type" href="http://lua-api.factorio.com/latest/Builtin-Types.html#string">string</a> or <span class="type">Array<string></span></span>)
|
||||
|
||||
groups that you want to be except, "Default" is always exempt
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- parameters end -->
|
||||
|
||||
<!-- returns start -->
|
||||
<strong>Returns:</strong>
|
||||
<ul>
|
||||
<li>
|
||||
(<span class="types"><a class="type" href="https://www.lua.org/pil/2.3.html">number</a></span>)
|
||||
<span class="return-text">the number of groups that had they permissions removed</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">-- Reload the permission groups, used internally
|
||||
</span>Groups.reload_permissions()</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -799,6 +745,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Set your permission group
|
||||
</span>Groups.set_player_group(game.player, <span class="string">'Admin'</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -875,6 +824,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Set an action to be disalowed
|
||||
</span>group:set_action(<span class="string">'toggle_map_editor'</span>, <span class="keyword">false</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -932,6 +884,11 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Allow some actions
|
||||
</span>group:allow{
|
||||
<span class="string">'write_to_console'</span>
|
||||
}</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -989,6 +946,15 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Disalow some actions
|
||||
</span>group:disallow{
|
||||
<span class="string">'add_permission_group'</span>,
|
||||
<span class="string">'delete_permission_group'</span>,
|
||||
<span class="string">'import_permissions_string'</span>,
|
||||
<span class="string">'map_editor_action'</span>,
|
||||
<span class="string">'toggle_map_editor'</span>
|
||||
}</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1023,6 +989,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Allow all actions unless given by disallow
|
||||
</span>group:allow_all()</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1057,6 +1026,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Disallow all actions unless given by allow
|
||||
</span>group:disallow_all()</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1114,6 +1086,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Test if a group is allowed an action
|
||||
</span><span class="keyword">local</span> allowed = group:is_allowed(<span class="string">'write_to_console'</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1123,40 +1098,6 @@
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Permissions_Groups._prototype:get_raw" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Permissions_Groups._prototype:get_raw">Permissions_Groups._prototype:get_raw()</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns the LuaPermissionGroup that was created with this group object, used internally</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="http://lua-api.factorio.com/latest/LuaPermissionGroup.html">LuaPermissionGroup</a></span>)
|
||||
<span class="return-text">the raw lua permission group</span>
|
||||
</li>
|
||||
</ul>
|
||||
<!-- returns end -->
|
||||
|
||||
|
||||
<!-- see also start -->
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Permissions_Groups._prototype:create" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Permissions_Groups._prototype:create">Permissions_Groups._prototype:create()</span>
|
||||
</div>
|
||||
@@ -1185,6 +1126,46 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Create the permission group so players can be added, used internally
|
||||
</span>group:create()</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<div class="divider divider-custom"></div>
|
||||
<div class="block section-item-header">
|
||||
<a href="#Permissions_Groups._prototype:get_raw" class="fragment-hashtag">#</a>
|
||||
<span class="section-item-title" id="Permissions_Groups._prototype:get_raw">Permissions_Groups._prototype:get_raw()</span>
|
||||
</div>
|
||||
</dt>
|
||||
<dd>
|
||||
<div class="section-item-body">
|
||||
|
||||
<p class="section-item-summary">Returns the LuaPermissionGroup that was created with this group object, used internally</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="http://lua-api.factorio.com/latest/LuaPermissionGroup.html">LuaPermissionGroup</a></span>)
|
||||
<span class="return-text">the raw lua permission group</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">-- Get the factorio api permision group, used internally
|
||||
</span><span class="keyword">local</span> permission_group = group:get_raw()</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1242,6 +1223,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Add a player to this permission group
|
||||
</span>group:add_player(game.player)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1299,6 +1283,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Remove a player from this permission group
|
||||
</span>group:remove_player(game.player)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1357,6 +1344,11 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Get all players in this group
|
||||
</span><span class="keyword">local</span> online_players = group:get_players()</code></pre>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Get all online players in this group
|
||||
</span><span class="keyword">local</span> online_players = group:get_players(<span class="keyword">true</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1414,6 +1406,9 @@
|
||||
<!-- see also end -->
|
||||
|
||||
<!-- usage start -->
|
||||
<strong>Usage:</strong>
|
||||
<pre class="code" data-lang="Lua"><code><span class="comment">-- Print a message to all players in thie group
|
||||
</span>group:<span class="global">print</span>(<span class="string">'Hello, World!'</span>)</code></pre>
|
||||
<!-- usage end -->
|
||||
|
||||
</dd>
|
||||
@@ -1432,7 +1427,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 2019-10-25 23:42:24 UTC</i>
|
||||
<i>Last updated 2020-03-31 15:51:56 UTC</i>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user