mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-29 12:16:37 +09:00
Change to sync docs
This commit is contained in:
Cooldude2606
705
doc/modules/ExpGamingCore.Sync.html
Normal file
705
doc/modules/ExpGamingCore.Sync.html
Normal file
@@ -0,0 +1,705 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>ldoc</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
<li><a href="#Fields">Fields</a></li>
|
||||
<li><a href="#modules_expgamingcore_sync_lib_gui_Functions">modules.expgamingcore.sync.lib.gui Functions</a></li>
|
||||
<li><a href="#modules_expgamingcore_sync_lib_ranking_Functions">modules.expgamingcore.sync.lib.ranking Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><strong>ExpGamingCore.Sync</strong></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>ExpGamingCore.Sync</code></h1>
|
||||
<p>Description - A small description that will be displayed on the doc</p>
|
||||
<p></p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<li><strong>License</strong>: https://github.com/explosivegaming/scenario/blob/master/LICENSE</li>
|
||||
<li><strong>Author</strong>: Cooldude2606</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#tick_format">tick_format (tick)</a></td>
|
||||
<td class="summary">Used to standidise the tick format for any sync info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#print">print (player_message, player_name[, player_tag[, player_colour[, prefix]]])</a></td>
|
||||
<td class="summary">Prints to chat as if it were a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#emit_embeded">emit_embeded (args)</a></td>
|
||||
<td class="summary">Logs an embed to the json.data we use a js script to add things we cant here</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#count_admins">count_admins ()</a></td>
|
||||
<td class="summary">Used to get the number of admins currently online</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#count_afk">count_afk ([time=7200])</a></td>
|
||||
<td class="summary">Used to get the number of afk players defined by 2 min by default</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#count_ranks">count_ranks ()</a></td>
|
||||
<td class="summary">Used to get the number of players in each rank and currently online; if ExpGamingCore/Ranking is present then it will give more than admin and user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#count_players">count_players (online)</a></td>
|
||||
<td class="summary">Used to get a list of every player name with the option to limit to only online players</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#count_player_times">count_player_times ()</a></td>
|
||||
<td class="summary">Used to get a list of every player name with the amount of time they have played for</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#update">update ()</a></td>
|
||||
<td class="summary">Called to update values inside of the info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#add_update">add_update (key, callback)</a></td>
|
||||
<td class="summary">Adds a callback to be called when the info is updated</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#emit_data">emit_data ()</a></td>
|
||||
<td class="summary">Outputs the curent server info into a file</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#EmitEmbededParamaters">EmitEmbededParamaters</a></td>
|
||||
<td class="summary">Outline of the paramaters accepted by Sync.emit_embeded</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#info">info</a></td>
|
||||
<td class="summary">used to get the global list that has been defined, also used to set that list</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#time">time</a></td>
|
||||
<td class="summary">Used to return and set the current IRL time; not very good need a better way to do this</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#modules_expgamingcore_sync_lib_gui_Functions">modules.expgamingcore.sync.lib.gui Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#_comment">_comment ()</a></td>
|
||||
<td class="summary">This file will be loaded when ExpGamingCore/Gui is present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#add_to_gui">add_to_gui (element)</a></td>
|
||||
<td class="summary">Adds a emeltent to the sever info gui</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#modules_expgamingcore_sync_lib_ranking_Functions">modules.expgamingcore.sync.lib.ranking Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#_comment">_comment ()</a></td>
|
||||
<td class="summary">This file will be loaded when ExpGamingCore/Ranking is present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_ranks">set_ranks (...)</a></td>
|
||||
<td class="summary">Used as a redirect to Ranking._base_preset that will set the rank given to a player apon joining</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#count_ranks">count_ranks ()</a></td>
|
||||
<td class="summary">Used to get the number of players in each rank and currently online</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "tick_format"></a>
|
||||
<strong>tick_format (tick)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to standidise the tick format for any sync info
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">{number,string}</span></span>
|
||||
table containg both the raw number and clean version of a time
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.tick_format(<span class="number">60</span>) <span class="comment">-- return {60,'1.00M'}</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "print"></a>
|
||||
<strong>print (player_message, player_name[, player_tag[, player_colour[, prefix]]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prints to chat as if it were a player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player_message</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the message to be printed in chat
|
||||
</li>
|
||||
<li><span class="parameter">player_name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the player sending the message
|
||||
</li>
|
||||
<li><span class="parameter">player_tag</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the tag apllied to the player's name
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">player_colour</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the colour of the message, either hex or named colour
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">prefix</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
add a prefix before the chat eg [IRC]
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.<span class="global">print</span>(<span class="string">'Test'</span>,<span class="string">'Cooldude2606'</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "emit_embeded"></a>
|
||||
<strong>emit_embeded (args)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Logs an embed to the json.data we use a js script to add things we cant here
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">args</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
a table which contains everything that the embeded will use
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
<a href="../modules/ExpGamingCore.Sync.html#EmitEmbededParamaters">EmitEmbededParamaters</a>
|
||||
</ul>
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.emit_embeded{title=<span class="string">'BAN'</span>,color=<span class="string">'0x0'</span>,description=<span class="string">'A player was banned'</span> ... }</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "count_admins"></a>
|
||||
<strong>count_admins ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to get the number of admins currently online
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number of admins online
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_admins() <span class="comment">-- returns number</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "count_afk"></a>
|
||||
<strong>count_afk ([time=7200])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to get the number of afk players defined by 2 min by default
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">time</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
in ticks that a player is called afk
|
||||
(<em>default</em> 7200)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number of afk players
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_afk()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "count_ranks"></a>
|
||||
<strong>count_ranks ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to get the number of players in each rank and currently online; if ExpGamingCore/Ranking is present then it will give more than admin and user
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
contains the ranks and the players in that rank
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_ranks()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "count_players"></a>
|
||||
<strong>count_players (online)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to get a list of every player name with the option to limit to only online players
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">online</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true will get only the online players
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table of player names
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_players()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "count_player_times"></a>
|
||||
<strong>count_player_times ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to get a list of every player name with the amount of time they have played for
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table indexed by player name, each value contains the raw tick and then the clean string
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_player_times()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "update"></a>
|
||||
<strong>update ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Called to update values inside of the info
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
all of the new info
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.update()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "add_update"></a>
|
||||
<strong>add_update (key, callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a callback to be called when the info is updated
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">key</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the key that the value will be stored in
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function which will return this value
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.add_update(<span class="string">'players'</span>,<span class="keyword">function</span>() <span class="keyword">return</span> #game.players <span class="keyword">end</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "emit_data"></a>
|
||||
<strong>emit_data ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Outputs the curent server info into a file
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.emit_data()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "EmitEmbededParamaters"></a>
|
||||
<strong>EmitEmbededParamaters</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Outline of the paramaters accepted by Sync.emit_embeded
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">title</span>
|
||||
the tile of the embed
|
||||
</li>
|
||||
<li><span class="parameter">color</span>
|
||||
the color given in hex you can use Color.to_hex{r=0,g=0,b=0}
|
||||
</li>
|
||||
<li><span class="parameter">description</span>
|
||||
the description of the embed
|
||||
</li>
|
||||
<li><span class="parameter">server_detail</span>
|
||||
sting to add onto the pre-set server detail
|
||||
</li>
|
||||
<li><span class="parameter">fieldone</span>
|
||||
the filed to add to the embed (key is name) (value is text) (start value with <<inline>> to make inline)
|
||||
</li>
|
||||
<li><span class="parameter">fieldtwo</span>
|
||||
the filed to add to the embed (key is name) (value is text) (start value with <<inline>> to make inline)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "info"></a>
|
||||
<strong>info</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to get the global list that has been defined, also used to set that list
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">set</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
keys to be replaced in the server info
|
||||
(<em>default</em> nil)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<li><pre class="example">Sync.info{server_name=<span class="string">'Factorio Server 2'</span>} <span class="comment">-- returns true</span></pre></li>
|
||||
<li><pre class="example">Sync.info <span class="comment">-- table of info</span></pre></li>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "time"></a>
|
||||
<strong>time</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to return and set the current IRL time; not very good need a better way to do this
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">set</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the date time to be set
|
||||
(<em>default</em> nil)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<li><pre class="example">Sync.time(<span class="string">'Sun Apr 1 18:44:30 UTC 2018'</span>)</pre></li>
|
||||
<li><pre class="example">Sync.time <span class="comment">-- string</span></pre></li>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="modules_expgamingcore_sync_lib_gui_Functions"></a>modules.expgamingcore.sync.lib.gui Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "_comment"></a>
|
||||
<strong>_comment ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This file will be loaded when ExpGamingCore/Gui is present
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "add_to_gui"></a>
|
||||
<strong>add_to_gui (element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a emeltent to the sever info gui
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
see examples before for what can be used, it can also be a return from Gui.inputs.add
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bolean</span></span>
|
||||
based on weather it was successful or not
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.add_to_gui(<span class="string">'string'</span>) <span class="comment">-- return true</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="modules_expgamingcore_sync_lib_ranking_Functions"></a>modules.expgamingcore.sync.lib.ranking Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "_comment"></a>
|
||||
<strong>_comment ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
This file will be loaded when ExpGamingCore/Ranking is present
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_ranks"></a>
|
||||
<strong>set_ranks (...)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used as a redirect to Ranking._base_preset that will set the rank given to a player apon joining
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">...</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.set_ranks{player_name=rank_name,...}</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "count_ranks"></a>
|
||||
<strong>count_ranks ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to get the number of players in each rank and currently online
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
contains the ranks and the players in that rank
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_ranks()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><strong>ExpGamingLib</strong></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,11 +56,6 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -86,6 +81,10 @@
|
||||
<td class="summary">Used to get the current ENV with all _G keys removed; useful when saving function to global</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#add_metatable">add_metatable (tbl[, callback=tostring[, string=table.tostring]])</a></td>
|
||||
<td class="summary">Creats a table that will act like a string and a function</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#is_type">is_type (v[, test_type=nil])</a></td>
|
||||
<td class="summary">Compear types faster for faster valadation of prams</td>
|
||||
</tr>
|
||||
@@ -166,6 +165,47 @@
|
||||
<pre class="example">get_env() returns current ENV with _G keys removed</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "add_metatable"></a>
|
||||
<strong>add_metatable (tbl[, callback=tostring[, string=table.tostring]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creats a table that will act like a string and a function
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the table that will have its metatable set
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function that will be used for the call
|
||||
(<em>default</em> tostring)
|
||||
</li>
|
||||
<li><span class="parameter">string</span>
|
||||
<span class="types"><span class="type">function</span> or <a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
a function that resolves to a string or a string
|
||||
(<em>default</em> table.tostring)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new table with its metatable set
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">add_metatable({},<span class="keyword">function</span>) <span class="comment">-- returns table</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "is_type"></a>
|
||||
@@ -371,7 +411,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -39,17 +39,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><strong>FSM</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -57,11 +57,6 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -412,7 +407,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -39,17 +39,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><strong>StdLib.Color</strong></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -57,11 +57,6 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -558,7 +553,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><strong>StdLib.Game</strong></li>
|
||||
@@ -56,11 +56,6 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -219,7 +214,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,11 +56,6 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -299,7 +294,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,11 +56,6 @@
|
||||
<li><strong>StdLib.Table</strong></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -1128,7 +1123,7 @@ some_func(<span class="number">1</span>,<span class="number">2</span>) <span cla
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,11 +56,6 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><strong>StdLib.Time</strong></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -136,7 +131,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -1,143 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>ldoc</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><strong>StdLib</strong></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>StdLib</code></h1>
|
||||
<p>A defines module for retrieving the number of ticks in 1 unit of time.</p>
|
||||
<p>
|
||||
Extends the Factorio defines table.</p>
|
||||
|
||||
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#defines.time">defines.time</a></td>
|
||||
<td class="summary">Returns the number of ticks in a second, minute, hour, day, week, month, or year.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "defines.time"></a>
|
||||
<strong>defines.time</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the number of ticks in a second, minute, hour, day, week, month, or year.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">second</span>
|
||||
the number of Factorio ticks in a second
|
||||
</li>
|
||||
<li><span class="parameter">minute</span>
|
||||
the number of Factorio ticks in a second
|
||||
</li>
|
||||
<li><span class="parameter">hour</span>
|
||||
the number of Factorio ticks in an hour
|
||||
</li>
|
||||
<li><span class="parameter">day</span>
|
||||
the number of Factorio ticks in an day
|
||||
</li>
|
||||
<li><span class="parameter">week</span>
|
||||
the number of Factorio ticks in a week
|
||||
</li>
|
||||
<li><span class="parameter">month</span>
|
||||
the number of Factorio ticks in a month (30 days)
|
||||
</li>
|
||||
<li><span class="parameter">year</span>
|
||||
the number of Factorio ticks in a year (365 days)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> ten_seconds = defines.time.second * <span class="number">10</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:33 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,542 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>ldoc</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><strong>expcore.sync</strong></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
<li><a href="../modules/StdLib.String.html">StdLib.String</a></li>
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.sync</code></h1>
|
||||
<p>Used as a faster way to get to the ranking function, overrides previous</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.set_ranks{name=rank_name}
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.tick_format">Sync.tick_format (tick)</a></td>
|
||||
<td class="summary">Used to standidise the tick format for any sync info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.print">Sync.print (player_message, player_name[, player_tag[, player_colour[, prefix]]])</a></td>
|
||||
<td class="summary">Prints to chat as if it were a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.emit_embeded">Sync.emit_embeded (args)</a></td>
|
||||
<td class="summary">Logs an embed to the json.data we use a js script to add things we cant here</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.count_admins">Sync.count_admins ()</a></td>
|
||||
<td class="summary">used to get the number of admins currently online</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.count_afk">Sync.count_afk ([time=7200])</a></td>
|
||||
<td class="summary">used to get the number of afk players defined by 2 min by default</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.count_ranks">Sync.count_ranks ()</a></td>
|
||||
<td class="summary">used to get the number of players in each rank and currently online</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.count_players">Sync.count_players (online)</a></td>
|
||||
<td class="summary">used to get the number of players either online or all</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.count_player_times">Sync.count_player_times ()</a></td>
|
||||
<td class="summary">used to get the number of players resulting in there play times</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.info">Sync.info ([set=nil])</a></td>
|
||||
<td class="summary">used to return the global list and set values in it</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.time">Sync.time ([set=nil])</a></td>
|
||||
<td class="summary">used to return the global time and set its value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.update">Sync.update ()</a></td>
|
||||
<td class="summary">called to update values inside of the info</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.add_update">Sync.add_update (key, callback)</a></td>
|
||||
<td class="summary">Adds a callback to be called when the info is updated</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.emit_data">Sync.emit_data ()</a></td>
|
||||
<td class="summary">outputs the curent server info into a file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Sync.add_to_gui">Sync.add_to_gui (element)</a></td>
|
||||
<td class="summary">Adds a emeltent to the sever info gui</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Sync.tick_format"></a>
|
||||
<strong>Sync.tick_format (tick)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to standidise the tick format for any sync info
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.tick_format(<span class="number">60</span>) <span class="comment">-- return {60,'1.00M'}</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.print"></a>
|
||||
<strong>Sync.print (player_message, player_name[, player_tag[, player_colour[, prefix]]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prints to chat as if it were a player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player_message</span>
|
||||
the message to be printed in chat
|
||||
</li>
|
||||
<li><span class="parameter">player_name</span>
|
||||
the name of the player sending the message
|
||||
</li>
|
||||
<li><span class="parameter">player_tag</span>
|
||||
the tag apllied to the player's name
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">player_colour</span>
|
||||
the colour of the message
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">prefix</span>
|
||||
add a prefix before the chat eg [IRC]
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.<span class="global">print</span>(<span class="string">'Test'</span>,<span class="string">'Cooldude2606'</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.emit_embeded"></a>
|
||||
<strong>Sync.emit_embeded (args)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Logs an embed to the json.data we use a js script to add things we cant here
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">args</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
a table which contains everything that the embeded will use
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.emit_embeded{title=<span class="string">'BAN'</span>,color=<span class="string">'0x0'</span>,description=<span class="string">'A player was banned'</span> ... }</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.count_admins"></a>
|
||||
<strong>Sync.count_admins ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to get the number of admins currently online
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
the number of admins online
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_admins()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.count_afk"></a>
|
||||
<strong>Sync.count_afk ([time=7200])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to get the number of afk players defined by 2 min by default
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">time</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
in ticks that a player is called afk
|
||||
(<em>default</em> 7200)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
the number of afk players
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_afk()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.count_ranks"></a>
|
||||
<strong>Sync.count_ranks ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to get the number of players in each rank and currently online
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
contains the ranks and the players in that rank
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_ranks()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.count_players"></a>
|
||||
<strong>Sync.count_players (online)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to get the number of players either online or all
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">online</span>
|
||||
<span class="types"><span class="type">bolean</span></span>
|
||||
if true only get online players
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
contains player names
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_players()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.count_player_times"></a>
|
||||
<strong>Sync.count_player_times ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to get the number of players resulting in there play times
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
contains players and each player is given a tick amount and a formated string
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.count_player_times()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.info"></a>
|
||||
<strong>Sync.info ([set=nil])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to return the global list and set values in it
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">set</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
keys to be replaced in the server info
|
||||
(<em>default</em> nil)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
either returns success when setting or the info when not setting
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.info{server_name=<span class="string">'Factorio Server 2'</span>}</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.time"></a>
|
||||
<strong>Sync.time ([set=nil])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
used to return the global time and set its value
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">set</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the date time to be set
|
||||
(<em>default</em> nil)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
either true false if setting or the date time and tick off set
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.time(<span class="string">'Sun Apr 1 18:44:30 UTC 2018'</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.update"></a>
|
||||
<strong>Sync.update ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
called to update values inside of the info
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
all of the new info
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.update()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.add_update"></a>
|
||||
<strong>Sync.add_update (key, callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a callback to be called when the info is updated
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">key</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the key that the value will be stored in
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function which will return this value
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.add_update(<span class="string">'players'</span>,<span class="keyword">function</span>() <span class="keyword">return</span> #game.players <span class="keyword">end</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.emit_data"></a>
|
||||
<strong>Sync.emit_data ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
outputs the curent server info into a file
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.emit_data()</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Sync.add_to_gui"></a>
|
||||
<strong>Sync.add_to_gui (element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a emeltent to the sever info gui
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
see examples before for what can be used, it can also be a return from Gui.inputs.add
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">bolean</span></span>
|
||||
based on weather it was successful or not
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">Sync.add_to_gui(<span class="string">'string'</span>) <span class="comment">-- return trues</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><strong>expcore.commands</strong></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><strong>modules.expgamingcore.commands.control</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.commands</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.commands.control</code></h1>
|
||||
<p>Uses a commands data to return the inputs as a string</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -80,7 +75,7 @@
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_commands">get_commands (player)</a></td>
|
||||
<td class="name" nowrap><a href="#commands.get_commands">commands.get_commands (player)</a></td>
|
||||
<td class="summary">Used to return all the commands a player can use</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -93,8 +88,8 @@
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "get_commands"></a>
|
||||
<strong>get_commands (player)</strong>
|
||||
<a name = "commands.get_commands"></a>
|
||||
<strong>commands.get_commands (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Used to return all the commands a player can use
|
||||
@@ -129,7 +124,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><strong>expcore.gui</strong></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><strong>modules.expgamingcore.gui.control</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.gui.control</code></h1>
|
||||
<p>Add a white bar to any gui frame</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -165,7 +160,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>expcore.guiparts.center</strong></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><strong>modules.expgamingcore.gui.guiparts.center</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.guiparts.center</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.gui.guiparts.center</code></h1>
|
||||
<p>Adds a new obj to the center gui</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -283,7 +278,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><strong>expcore.guiparts.inputs</strong></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><strong>modules.expgamingcore.gui.guiparts.inputs</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.guiparts.inputs</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.gui.guiparts.inputs</code></h1>
|
||||
<p>Sets the input to trigger on an certain event</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -439,7 +434,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><strong>expcore.guiparts.left</strong></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><strong>modules.expgamingcore.gui.guiparts.left</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.guiparts.left</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.gui.guiparts.left</code></h1>
|
||||
<p>Used to add a left gui frame</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -186,7 +181,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><strong>expcore.guiparts.popup</strong></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><strong>modules.expgamingcore.gui.guiparts.popup</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.guiparts.popup</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.gui.guiparts.popup</code></h1>
|
||||
<p>Used to add a popup gui style</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -131,7 +126,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><strong>expcore.guiparts.toolbar</strong></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><strong>modules.expgamingcore.gui.guiparts.toolbar</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.guiparts.toolbar</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.gui.guiparts.toolbar</code></h1>
|
||||
<p>Add a button to the toolbar, ranks need to be allowed to use these buttons if ranks is preset</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -122,7 +117,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><strong>expcore.ranking</strong></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><strong>modules.expgamingcore.ranking.control</strong></li>
|
||||
<li><a href="../modules/modules.expgamingcore.server.control.html">modules.expgamingcore.server.control</a></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.ranking</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.ranking.control</code></h1>
|
||||
<p>Returns a rank object given a player or rank name</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -379,7 +374,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -38,17 +38,17 @@
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><strong>expcore.server</strong></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.commands.control.html">modules.expgamingcore.commands.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.center.html">modules.expgamingcore.gui.guiparts.center</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.inputs.html">modules.expgamingcore.gui.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.left.html">modules.expgamingcore.gui.guiparts.left</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.popup.html">modules.expgamingcore.gui.guiparts.popup</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.guiparts.toolbar.html">modules.expgamingcore.gui.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.gui.control.html">modules.expgamingcore.gui.control</a></li>
|
||||
<li><a href="../modules/modules.expgamingcore.ranking.control.html">modules.expgamingcore.ranking.control</a></li>
|
||||
<li><strong>modules.expgamingcore.server.control</strong></li>
|
||||
<li><a href="../modules/ExpGamingCore.Sync.html">ExpGamingCore.Sync</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.Color.html">StdLib.Color</a></li>
|
||||
<li><a href="../modules/StdLib.Game.html">StdLib.Game</a></li>
|
||||
@@ -56,17 +56,12 @@
|
||||
<li><a href="../modules/StdLib.Table.html">StdLib.Table</a></li>
|
||||
<li><a href="../modules/StdLib.Time.html">StdLib.Time</a></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.server</code></h1>
|
||||
<h1>Module <code>modules.expgamingcore.server.control</code></h1>
|
||||
<p>Returns a un-used uuid (better system needed)</p>
|
||||
<p></p>
|
||||
<h3>Usage:</h3>
|
||||
@@ -564,7 +559,7 @@
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-30 00:08:40 </i>
|
||||
<i style="float:right;">Last updated 2018-05-31 00:41:31 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
@@ -1,567 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<div id="product">
|
||||
<div id="product_logo"></div>
|
||||
<div id="product_name"><big><b></b></big></div>
|
||||
<div id="product_description"></div>
|
||||
</div> <!-- id="product" -->
|
||||
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>ldoc</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/expcore.guiparts.center.html">expcore.guiparts.center</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.inputs.html">expcore.guiparts.inputs</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.left.html">expcore.guiparts.left</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.popup.html">expcore.guiparts.popup</a></li>
|
||||
<li><a href="../modules/expcore.guiparts.toolbar.html">expcore.guiparts.toolbar</a></li>
|
||||
<li><a href="../modules/expcore.commands.html">expcore.commands</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.ranking.html">expcore.ranking</a></li>
|
||||
<li><a href="../modules/expcore.server.html">expcore.server</a></li>
|
||||
<li><a href="../modules/expcore.sync.html">expcore.sync</a></li>
|
||||
<li><a href="../modules/FSM.html">FSM</a></li>
|
||||
<li><a href="../modules/ExpGamingLib.html">ExpGamingLib</a></li>
|
||||
<li><a href="../modules/StdLib.html">StdLib</a></li>
|
||||
<li><strong>modules.factoriostdlib.color</strong></li>
|
||||
</ul>
|
||||
<h2>Scripts</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../scripts/control.lua.html">control.lua</a></li>
|
||||
<li><a href="../scripts/index.lua.html">index.lua</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.factoriostdlib.color</code></h1>
|
||||
<p>A defines module for retrieving colors by name.</p>
|
||||
<p>
|
||||
Extends the Factorio defines table.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">require('stdlib/defines/color')
|
||||
</pre>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Color.set">Color.set ([color=white[, alpha=1]])</a></td>
|
||||
<td class="summary">Set a value for the alpha channel in the given color table.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Color.to_table">Color.to_table (c_arr)</a></td>
|
||||
<td class="summary">Converts a color in the array format to a color in the table format.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Color.from_rgb">Color.from_rgb ([r=0[, g=0[, b=0[, a=255]]]])</a></td>
|
||||
<td class="summary">Converts a color in the rgb format to a color table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Color.from_hex">Color.from_hex (hex[, alpha=1])</a></td>
|
||||
<td class="summary">Get a color table with a hexadecimal string.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Color.to_rgb">Color.to_rgb (color)</a></td>
|
||||
<td class="summary">Converts a color in the color table format to rgb</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Color.to_hex">Color.to_hex (color)</a></td>
|
||||
<td class="summary">Converts a color in the color table format to hex</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Tables">Tables</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#defines.color">defines.color</a></td>
|
||||
<td class="summary">A table of colors allowing retrieval by color name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#defines.anticolor">defines.anticolor</a></td>
|
||||
<td class="summary">Returns white for dark colors or black for lighter colors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#defines.lightcolor">defines.lightcolor</a></td>
|
||||
<td class="summary">Returns a lighter color of a named color</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#defines.textcolor">defines.textcolor</a></td>
|
||||
<td class="summary">Returns a lighter color of a named color.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Color.set"></a>
|
||||
<strong>Color.set ([color=white[, alpha=1]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Set a value for the alpha channel in the given color table.
|
||||
`color.a` represents the alpha channel in the given color table.
|
||||
<ul>
|
||||
<li>If ***alpha*** is given, set `color.a` to it.
|
||||
<li>If ***alpha*** is not given, and if the given color table does not have a value for `color.a`, set `color.a` to 1.
|
||||
<li>If ***alpha*** is not given, and if the given color table already has a value for `color.a`, then leave `color.a` alone.
|
||||
</ul>
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="../modules/modules.factoriostdlib.color.html#defines.color">defines.color</a> or <span class="type">Concepts.Color</span></span>
|
||||
the color to configure
|
||||
(<em>default</em> white)
|
||||
</li>
|
||||
<li><span class="parameter">alpha</span>
|
||||
<span class="types"><span class="type">float</span></span>
|
||||
the alpha value (*[0 - 1]*) to set for the given color
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">a</span></span>
|
||||
color table that has the specified value for the alpha channel
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.to_table"></a>
|
||||
<strong>Color.to_table (c_arr)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts a color in the array format to a color in the table format.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">c_arr</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the color to convert
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">a</span></span>
|
||||
converted color — { r = c\_arr[1], g = c\_arr[2], b = c\_arr[3], a = c\_arr[4] }
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.from_rgb"></a>
|
||||
<strong>Color.from_rgb ([r=0[, g=0[, b=0[, a=255]]]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts a color in the rgb format to a color table
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">r</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
0-255 red
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">g</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
0-255 green
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">b</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
0-255 blue
|
||||
(<em>default</em> 0)
|
||||
</li>
|
||||
<li><span class="parameter">a</span>
|
||||
<span class="types"><span class="type">int</span></span>
|
||||
0-255 alpha
|
||||
(<em>default</em> 255)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Concepts.Color</span></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.from_hex"></a>
|
||||
<strong>Color.from_hex (hex[, alpha=1])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Get a color table with a hexadecimal string.
|
||||
Optionally provide the value for the alpha channel.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">hex</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
hexadecimal color string (#ffffff, not #fff)
|
||||
</li>
|
||||
<li><span class="parameter">alpha</span>
|
||||
<span class="types"><span class="type">float</span></span>
|
||||
the alpha value to set; such that ***[ 0 ⋜ value ⋜ 1 ]***
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">a</span></span>
|
||||
color table with RGB converted from Hex and with alpha
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.to_rgb"></a>
|
||||
<strong>Color.to_rgb (color)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts a color in the color table format to rgb
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the color to convert
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the color as rgb
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Color.to_hex"></a>
|
||||
<strong>Color.to_hex (color)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts a color in the color table format to hex
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the color to convert
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the color as hex
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "defines.color"></a>
|
||||
<strong>defines.color</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A table of colors allowing retrieval by color name.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">white</span>
|
||||
{r=1.00,g=1.00,b=1.00}
|
||||
</li>
|
||||
<li><span class="parameter">black</span>
|
||||
{r=0.00,g=0.00,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">darkgrey</span>
|
||||
{r=0.25,g=0.25,b=0.25}
|
||||
</li>
|
||||
<li><span class="parameter">grey</span>
|
||||
{r=0.50,g=0.50,b=0.50}
|
||||
</li>
|
||||
<li><span class="parameter">lightgrey</span>
|
||||
{r=0.75,g=0.75,b=0.75}
|
||||
</li>
|
||||
<li><span class="parameter">red</span>
|
||||
{r=1.00,g=0.00,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">darkred</span>
|
||||
{r=0.50,g=0.00,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">lightred</span>
|
||||
{r=1.00,g=0.50,b=0.50}
|
||||
</li>
|
||||
<li><span class="parameter">green</span>
|
||||
{r=0.00,g=1.00,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">darkgreen</span>
|
||||
{r=0.00,g=0.50,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">lightgreen</span>
|
||||
{r=0.50,g=1.00,b=0.50}
|
||||
</li>
|
||||
<li><span class="parameter">blue</span>
|
||||
{r=0.00,g=0.00,b=1.00}
|
||||
</li>
|
||||
<li><span class="parameter">darkblue</span>
|
||||
{r=0.00,g=0.00,b=0.50}
|
||||
</li>
|
||||
<li><span class="parameter">lightblue</span>
|
||||
{r=0.50,g=0.50,b=1.00}
|
||||
</li>
|
||||
<li><span class="parameter">orange</span>
|
||||
{r=1.00,g=0.55,b=0.10}
|
||||
</li>
|
||||
<li><span class="parameter">yellow</span>
|
||||
{r=1.00,g=1.00,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">pink</span>
|
||||
{r=1.00,g=0.00,b=1.00}
|
||||
</li>
|
||||
<li><span class="parameter">purple</span>
|
||||
{r=0.60,g=0.10,b=0.60}
|
||||
</li>
|
||||
<li><span class="parameter">brown</span>
|
||||
{r=0.60,g=0.40,b=0.10}
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "defines.anticolor"></a>
|
||||
<strong>defines.anticolor</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns white for dark colors or black for lighter colors.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">green</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">grey</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">lightblue</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">lightgreen</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">lightgrey</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">lightred</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">orange</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">white</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">yellow</span>
|
||||
defines.color.black
|
||||
</li>
|
||||
<li><span class="parameter">black</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">blue</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">brown</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">darkblue</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">darkgreen</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">darkgrey</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">darkred</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">pink</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">purple</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
<li><span class="parameter">red</span>
|
||||
defines.color.white
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "defines.lightcolor"></a>
|
||||
<strong>defines.lightcolor</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a lighter color of a named color
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">white</span>
|
||||
defines.color.lightgrey
|
||||
</li>
|
||||
<li><span class="parameter">grey</span>
|
||||
defines.color.darkgrey
|
||||
</li>
|
||||
<li><span class="parameter">lightgrey</span>
|
||||
defines.color.grey
|
||||
</li>
|
||||
<li><span class="parameter">red</span>
|
||||
defines.color.lightred
|
||||
</li>
|
||||
<li><span class="parameter">green</span>
|
||||
defines.color.lightgreen
|
||||
</li>
|
||||
<li><span class="parameter">blue</span>
|
||||
defines.color.lightblue
|
||||
</li>
|
||||
<li><span class="parameter">yellow</span>
|
||||
defines.color.orange
|
||||
</li>
|
||||
<li><span class="parameter">pink</span>
|
||||
defines.color.purple
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "defines.textcolor"></a>
|
||||
<strong>defines.textcolor</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a lighter color of a named color.
|
||||
|
||||
|
||||
<h3>Fields:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">info</span>
|
||||
{r=0.21,g=0.95,b=1.00}
|
||||
</li>
|
||||
<li><span class="parameter">bg</span>
|
||||
{r=0.00,g=0.00,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">low</span>
|
||||
{r=0.18,g=0.77,b=0.18}
|
||||
</li>
|
||||
<li><span class="parameter">med</span>
|
||||
{r=1.00,g=0.89,b=0.26}
|
||||
</li>
|
||||
<li><span class="parameter">high</span>
|
||||
{r=1.00,g=0.33,b=0.00}
|
||||
</li>
|
||||
<li><span class="parameter">crit</span>
|
||||
{r=1.00,g=0.00,b=0.00}
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
|
||||
<i style="float:right;">Last updated 2018-05-29 23:30:03 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user