mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-29 20:16:38 +09:00
Ldoc compliant
This commit is contained in:
Cooldude2606
376
doc/index.html
Normal file
376
doc/index.html
Normal file
@@ -0,0 +1,376 @@
|
||||
<!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>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="modules/control.html">control</a></li>
|
||||
<li><a href="modules/Commands.html">Commands</a></li>
|
||||
<li><a href="modules/Public.html">Public</a></li>
|
||||
<li><a href="modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="modules/Commands.html">Commands</a></li>
|
||||
<li><a href="modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<table class="module_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config._file_loader.html">config._file_loader</a></td>
|
||||
<td class="summary">This contains a list of all files that will be loaded and the order they are loaded in
|
||||
to stop a file from loading add "--" in front of it, remove the "--" to have the file be loaded
|
||||
config files should be loaded after all modules are loaded
|
||||
core files should be required by modules and not be present in this list</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.action_buttons.html">config.action_buttons</a></td>
|
||||
<td class="summary">Config for the different action buttons that show on the player list
|
||||
each button has the button define(s) given along side an auth function, and optional reason callback
|
||||
if a reason callback is used then Store.set_child(action_name_store,player.name,'BUTTON_NAME') should be called during on_click
|
||||
buttons can be removed from the gui by commenting them out of the config at the bottom of this file
|
||||
the key used for the name of the button is the permision name used by the role system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.advanced_start.html">config.advanced_start</a></td>
|
||||
<td class="summary">This file is used to setup the map starting settings and the items players will start with</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.death_logger.html">config.death_logger</a></td>
|
||||
<td class="summary">This config controls what happens when a player dies mostly about map markers and item collection
|
||||
allow_teleport_to_body_command and allow_collect_bodies_command can be over ridden if command_auth_runtime_disable is present
|
||||
if not present then the commands will not be loaded into the game</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></td>
|
||||
<td class="summary">This is a very simple config file which adds a admin only auth function
|
||||
not much to change here its more so it can be enabled and disabled from ./config/file_loader.lua
|
||||
either way you can change the requirements to be "admin" if you wanted to</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></td>
|
||||
<td class="summary">This will make commands only work if the role has been allowed it in the role config</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></td>
|
||||
<td class="summary">This config for command auth allows commands to be globally enabled and disabled during runtime
|
||||
this config adds Commands.disable and Commands.enable to enable and disable commands for all users</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></td>
|
||||
<td class="summary">This file contains some common command param parse functions
|
||||
this file is less of a config and more of a requirement but you may wish to change how some behave
|
||||
as such you need to be confident with lua but you edit this config file
|
||||
use Commands.add_parse('name',function(input,player,reject) end) to add a parse
|
||||
see ./expcore/commands.lua for more details</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></td>
|
||||
<td class="summary">Adds some parse functions that can be used with the role system</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.permission_groups.html">config.permission_groups</a></td>
|
||||
<td class="summary">Use this file to add new permission groups to the game
|
||||
start with Permission_Groups.new_group('name')
|
||||
then use either :allow_all() or :disallow_all() to set the default for non specified actions
|
||||
then use :allow{} and :disallow{} to specify certain actions to allow/disallow</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.popup_messages.html">config.popup_messages</a></td>
|
||||
<td class="summary">A combination of config settings for different popup values like chat and damage</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.rockets.html">config.rockets</a></td>
|
||||
<td class="summary">This file controls what will show in each section of the rocket info gui</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.roles.html">config.roles</a></td>
|
||||
<td class="summary">This is the main config file for the role system; file includes defines for roles and role flags and default values</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.scorched_earth.html">config.scorched_earth</a></td>
|
||||
<td class="summary">This file controls the placement/degrading of tiles as players build and walk</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.spawn_area.html">config.spawn_area</a></td>
|
||||
<td class="summary">Used to config the spawn generation settings yes there is alot here i know just ignore the long tables at the end (they were generated with a command)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/config.warnings.html">config.warnings</a></td>
|
||||
<td class="summary">Config file for the warning system, this is very similar to reports but is for the use of moderators rather than normal users.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/control.html">control</a></td>
|
||||
<td class="summary">Please go to ./config if you want to change settings, each file is commented with what it does
|
||||
if it is not in ./config then you should not attempt to change it unless you know what you are doing
|
||||
all files which are loaded (including the config files) are present in ./config/file_loader.lua
|
||||
this file is the landing point for all scenarios please DO NOT edit directly, further comments are to aid development</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/Commands.html">Commands</a></td>
|
||||
<td class="summary">Factorio command making module that makes commands with better parse and more modularity</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/Public.html">Public</a></td>
|
||||
<td class="summary">Adds some commonly used functions used in many modules</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.html">expcore.gui</a></td>
|
||||
<td class="summary">This file is used to require all the different elements of the gui module
|
||||
each module has an outline here but for more details see their seperate files in ./gui</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.buttons.html">expcore.gui.buttons</a></td>
|
||||
<td class="summary">Gui class define for buttons and sprite buttons
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.center.html">expcore.gui.center</a></td>
|
||||
<td class="summary">Gui structure define for center gui frames
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></td>
|
||||
<td class="summary">Gui class define for checkboxs and radiobuttons
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.core.html">expcore.gui.core</a></td>
|
||||
<td class="summary">Core gui file for making element defines and element classes (use require 'expcore.gui')
|
||||
see utils.gui for event handlering
|
||||
see expcore.gui.test for examples for element defines
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></td>
|
||||
<td class="summary">Gui class define for dropdowns and list boxs
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></td>
|
||||
<td class="summary">Gui class defines for elem buttons
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.instances.html">expcore.gui.instances</a></td>
|
||||
<td class="summary">This file is a breakout from core which forcues on instance management of defines
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.left.html">expcore.gui.left</a></td>
|
||||
<td class="summary">Gui structure define for left frames
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.popups.html">expcore.gui.popups</a></td>
|
||||
<td class="summary">Gui structure define for popup gui
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></td>
|
||||
<td class="summary">Gui element define for progess bars
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.slider.html">expcore.gui.slider</a></td>
|
||||
<td class="summary">Gui class define for silders
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.test.html">expcore.gui.test</a></td>
|
||||
<td class="summary">This file creates a teste gui that is used to test every input method
|
||||
note that this does not cover every permutation only features in indepentance
|
||||
for example store in most cases is just by player name, but other store methods are tested with checkbox</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.text.html">expcore.gui.text</a></td>
|
||||
<td class="summary">Gui class define for text fields and text boxs
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></td>
|
||||
<td class="summary">Gui structure for the toolbar (top left)
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/Permissions_Groups.html">Permissions_Groups</a></td>
|
||||
<td class="summary">Permission group making for factorio so you never have to make one by hand again</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/Commands.html">Commands</a></td>
|
||||
<td class="summary">Factorio role system to manage custom permissions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/expcore.store.html">expcore.store</a></td>
|
||||
<td class="summary">Adds an easy way to store and watch for updates to a value
|
||||
[[</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></td>
|
||||
<td class="summary">Adds a better method of player starting items based on production levels.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></td>
|
||||
<td class="summary">Creates flying text entities when a player sends a message in chat
|
||||
also displays a ping above users who are named in the message</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></td>
|
||||
<td class="summary">Displays the amount of dmg that is done by players to entities
|
||||
also shows player health when a player is attacked</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.gui.player-list.html">modules.gui.player-list</a></td>
|
||||
<td class="summary">Gui left frame define for a player list</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></td>
|
||||
<td class="summary">Adds a rocket infomation gui which shows general stats, milestones and build progress of rockets</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.gui.science-info.html">modules.gui.science-info</a></td>
|
||||
<td class="summary">Adds a science info gui that shows production usage and net for the different science packs as well as an eta</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/modules.gui.task-list.html">modules.gui.task-list</a></td>
|
||||
<td class="summary">Adds a task list to the game which players can add remove and edit items on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></td>
|
||||
<td class="summary">info
|
||||
Original (javascript) version: https://hastebin.com/udakacavap.js
|
||||
Can be tested against: https://wiki.factorio.com/Enemies#Spawn_chances_by_evolution_factor</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.core.html">utils.core</a></td>
|
||||
<td class="summary">Measures distance between pos1 and pos2</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.debug.html">utils.debug</a></td>
|
||||
<td class="summary"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.event.html">utils.event</a></td>
|
||||
<td class="summary">This Module allows for registering multiple handlers to the same event, overcoming the limitation of script.register.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.event_core.html">utils.event_core</a></td>
|
||||
<td class="summary">Do not use this function, use Event.add instead as it has safety checks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.math.html">utils.math</a></td>
|
||||
<td class="summary">Takes two points and calculates the slope of a line</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.recipe_locker.html">utils.recipe_locker</a></td>
|
||||
<td class="summary">Locks recipes, preventing them from being enabled by research.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.state_machine.html">utils.state_machine</a></td>
|
||||
<td class="summary">This module provides a classical mealy/moore state machine.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.table.html">utils.table</a></td>
|
||||
<td class="summary">Searches a table to remove a specific element without an index</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.task.html">utils.task</a></td>
|
||||
<td class="summary">Allows you to set a timer (in ticks) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="modules/utils.timestamp.html">utils.timestamp</a></td>
|
||||
<td class="summary">source https://github.com/daurnimator/luatz/blob/master/luatz/timetable.lua
|
||||
edited down to just what is needed.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
307
doc/ldoc.css
Normal file
307
doc/ldoc.css
Normal file
@@ -0,0 +1,307 @@
|
||||
/* BEGIN RESET
|
||||
|
||||
Copyright (c) 2010, Yahoo! Inc. All rights reserved.
|
||||
Code licensed under the BSD License:
|
||||
http://developer.yahoo.com/yui/license.html
|
||||
version: 2.8.2r1
|
||||
*/
|
||||
html {
|
||||
color: #000;
|
||||
background: #FFF;
|
||||
}
|
||||
body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
}
|
||||
fieldset,img {
|
||||
border: 0;
|
||||
}
|
||||
address,caption,cite,code,dfn,em,strong,th,var,optgroup {
|
||||
font-style: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
del,ins {
|
||||
text-decoration: none;
|
||||
}
|
||||
li {
|
||||
list-style: disc;
|
||||
margin-left: 20px;
|
||||
}
|
||||
caption,th {
|
||||
text-align: left;
|
||||
}
|
||||
h1,h2,h3,h4,h5,h6 {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
q:before,q:after {
|
||||
content: '';
|
||||
}
|
||||
abbr,acronym {
|
||||
border: 0;
|
||||
font-variant: normal;
|
||||
}
|
||||
sup {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
sub {
|
||||
vertical-align: baseline;
|
||||
}
|
||||
legend {
|
||||
color: #000;
|
||||
}
|
||||
input,button,textarea,select,optgroup,option {
|
||||
font-family: inherit;
|
||||
font-size: inherit;
|
||||
font-style: inherit;
|
||||
font-weight: inherit;
|
||||
}
|
||||
input,button,textarea,select {*font-size:100%;
|
||||
}
|
||||
/* END RESET */
|
||||
|
||||
body {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
font-family: arial, helvetica, geneva, sans-serif;
|
||||
background-color: #ffffff; margin: 0px;
|
||||
}
|
||||
|
||||
code, tt { font-family: monospace; font-size: 1.1em; }
|
||||
span.parameter { font-family:monospace; }
|
||||
span.parameter:after { content:":"; }
|
||||
span.types:before { content:"("; }
|
||||
span.types:after { content:")"; }
|
||||
.type { font-weight: bold; font-style:italic }
|
||||
|
||||
body, p, td, th { font-size: .95em; line-height: 1.2em;}
|
||||
|
||||
p, ul { margin: 10px 0 0 0px;}
|
||||
|
||||
strong { font-weight: bold;}
|
||||
|
||||
em { font-style: italic;}
|
||||
|
||||
h1 {
|
||||
font-size: 1.5em;
|
||||
margin: 0 0 20px 0;
|
||||
}
|
||||
h2, h3, h4 { margin: 15px 0 10px 0; }
|
||||
h2 { font-size: 1.25em; }
|
||||
h3 { font-size: 1.15em; }
|
||||
h4 { font-size: 1.06em; }
|
||||
|
||||
a:link { font-weight: bold; color: #004080; text-decoration: none; }
|
||||
a:visited { font-weight: bold; color: #006699; text-decoration: none; }
|
||||
a:link:hover { text-decoration: underline; }
|
||||
|
||||
hr {
|
||||
color:#cccccc;
|
||||
background: #00007f;
|
||||
height: 1px;
|
||||
}
|
||||
|
||||
blockquote { margin-left: 3em; }
|
||||
|
||||
ul { list-style-type: disc; }
|
||||
|
||||
p.name {
|
||||
font-family: "Andale Mono", monospace;
|
||||
padding-top: 1em;
|
||||
}
|
||||
|
||||
pre.example {
|
||||
background-color: rgb(245, 245, 245);
|
||||
border: 1px solid silver;
|
||||
padding: 10px;
|
||||
margin: 10px 0 10px 0;
|
||||
font-family: "Andale Mono", monospace;
|
||||
font-size: .85em;
|
||||
}
|
||||
|
||||
pre {
|
||||
background-color: rgb(245, 245, 245);
|
||||
border: 1px solid silver;
|
||||
padding: 10px;
|
||||
margin: 10px 0 10px 0;
|
||||
overflow: auto;
|
||||
font-family: "Andale Mono", monospace;
|
||||
}
|
||||
|
||||
|
||||
table.index { border: 1px #00007f; }
|
||||
table.index td { text-align: left; vertical-align: top; }
|
||||
|
||||
#container {
|
||||
margin-left: 1em;
|
||||
margin-right: 1em;
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
|
||||
#product {
|
||||
text-align: center;
|
||||
border-bottom: 1px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#product big {
|
||||
font-size: 2em;
|
||||
}
|
||||
|
||||
#main {
|
||||
background-color: #f0f0f0;
|
||||
border-left: 2px solid #cccccc;
|
||||
}
|
||||
|
||||
#navigation {
|
||||
float: left;
|
||||
width: 14em;
|
||||
vertical-align: top;
|
||||
background-color: #f0f0f0;
|
||||
overflow: visible;
|
||||
}
|
||||
|
||||
#navigation h2 {
|
||||
background-color:#e7e7e7;
|
||||
font-size:1.1em;
|
||||
color:#000000;
|
||||
text-align: left;
|
||||
padding:0.2em;
|
||||
border-top:1px solid #dddddd;
|
||||
border-bottom:1px solid #dddddd;
|
||||
}
|
||||
|
||||
#navigation ul
|
||||
{
|
||||
font-size:1em;
|
||||
list-style-type: none;
|
||||
margin: 1px 1px 10px 1px;
|
||||
}
|
||||
|
||||
#navigation li {
|
||||
text-indent: -1em;
|
||||
display: block;
|
||||
margin: 3px 0px 0px 22px;
|
||||
}
|
||||
|
||||
#navigation li li a {
|
||||
margin: 0px 3px 0px -1em;
|
||||
}
|
||||
|
||||
#content {
|
||||
margin-left: 14em;
|
||||
padding: 1em;
|
||||
width: 700px;
|
||||
border-left: 2px solid #cccccc;
|
||||
border-right: 2px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#about {
|
||||
clear: both;
|
||||
padding: 5px;
|
||||
border-top: 2px solid #cccccc;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
@media print {
|
||||
body {
|
||||
font: 12pt "Times New Roman", "TimeNR", Times, serif;
|
||||
}
|
||||
a { font-weight: bold; color: #004080; text-decoration: underline; }
|
||||
|
||||
#main {
|
||||
background-color: #ffffff;
|
||||
border-left: 0px;
|
||||
}
|
||||
|
||||
#container {
|
||||
margin-left: 2%;
|
||||
margin-right: 2%;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#content {
|
||||
padding: 1em;
|
||||
background-color: #ffffff;
|
||||
}
|
||||
|
||||
#navigation {
|
||||
display: none;
|
||||
}
|
||||
pre.example {
|
||||
font-family: "Andale Mono", monospace;
|
||||
font-size: 10pt;
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
}
|
||||
|
||||
table.module_list {
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.module_list td {
|
||||
border-width: 1px;
|
||||
padding: 3px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
}
|
||||
table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||
table.module_list td.summary { width: 100%; }
|
||||
|
||||
|
||||
table.function_list {
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.function_list td {
|
||||
border-width: 1px;
|
||||
padding: 3px;
|
||||
border-style: solid;
|
||||
border-color: #cccccc;
|
||||
}
|
||||
table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
|
||||
table.function_list td.summary { width: 100%; }
|
||||
|
||||
ul.nowrap {
|
||||
overflow:auto;
|
||||
white-space:nowrap;
|
||||
}
|
||||
|
||||
dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
|
||||
dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
|
||||
dl.table h3, dl.function h3 {font-size: .95em;}
|
||||
|
||||
/* stop sublists from having initial vertical space */
|
||||
ul ul { margin-top: 0px; }
|
||||
ol ul { margin-top: 0px; }
|
||||
ol ol { margin-top: 0px; }
|
||||
ul ol { margin-top: 0px; }
|
||||
|
||||
/* make the target distinct; helps when we're navigating to a function */
|
||||
a:target + * {
|
||||
background-color: #FF9;
|
||||
}
|
||||
|
||||
/* styles for prettification of source */
|
||||
pre .comment { color: #558817; }
|
||||
pre .constant { color: #a8660d; }
|
||||
pre .escape { color: #844631; }
|
||||
pre .keyword { color: #aa5050; font-weight: bold; }
|
||||
pre .library { color: #0e7c6b; }
|
||||
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
|
||||
pre .string { color: #8080ff; }
|
||||
pre .number { color: #f8660d; }
|
||||
pre .operator { color: #2239a8; font-weight: bold; }
|
||||
pre .preprocessor, pre .prepro { color: #a33243; }
|
||||
pre .global { color: #800080; }
|
||||
pre .prompt { color: #558817; }
|
||||
pre .url { color: #272fc2; text-decoration: underline; }
|
||||
1307
doc/modules/Commands.html
Normal file
1307
doc/modules/Commands.html
Normal file
File diff suppressed because it is too large
Load Diff
660
doc/modules/Permissions_Groups.html
Normal file
660
doc/modules/Permissions_Groups.html
Normal file
@@ -0,0 +1,660 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><strong>Permissions_Groups</strong></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>Permissions_Groups</code></h1>
|
||||
<p>Permission group making for factorio so you never have to make one by hand again</p>
|
||||
<p>
|
||||
[[</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<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="#new_group">new_group (name)</a></td>
|
||||
<td class="summary">Defines a new permission group that can have it actions set in the config</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_group_by_name">get_group_by_name (name)</a></td>
|
||||
<td class="summary">Returns the group with the given name, case sensitive</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_group_from_player">get_group_from_player (player)</a></td>
|
||||
<td class="summary">Returns the group that a player is in</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#reload_permissions">reload_permissions ()</a></td>
|
||||
<td class="summary">Reloads/creates all permission groups and sets them to they configured state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#lockdown_permissions">lockdown_permissions (exempt)</a></td>
|
||||
<td class="summary">Removes all permissions from every permission group except for "Default" and any passed as exempt</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set_player_group">set_player_group (player, group)</a></td>
|
||||
<td class="summary">Sets a player's group to the one given, a player can only have one group at a time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:set_action">Permissions_Groups._prototype:set_action (action, state)</a></td>
|
||||
<td class="summary">Sets the allow state of an action for this group, used internally but is safe to use else where</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:allow">Permissions_Groups._prototype:allow (actions)</a></td>
|
||||
<td class="summary">Sets an action or actions to be allowed for this group even with disallow_all triggered, Do not use in runtime</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:disallow">Permissions_Groups._prototype:disallow (actions)</a></td>
|
||||
<td class="summary">Sets an action or actions to be disallowed for this group even with allow_all triggered, Do not use in runtime</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:allow_all">Permissions_Groups._prototype:allow_all ()</a></td>
|
||||
<td class="summary">Sets the default state for any actions not given to be allowed, useful with :disallow</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:disallow_all">Permissions_Groups._prototype:disallow_all ()</a></td>
|
||||
<td class="summary">Sets the default state for any action not given to be disallowed, useful with :allow</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:is_allowed">Permissions_Groups._prototype:is_allowed (action)</a></td>
|
||||
<td class="summary">Returns if an input action is allowed for this group</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:get_raw">Permissions_Groups._prototype:get_raw ()</a></td>
|
||||
<td class="summary">Returns the LuaPermissionGroup that was created with this group object, used internally</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:create">Permissions_Groups._prototype:create ()</a></td>
|
||||
<td class="summary">Creates or updates the permission group with the configured actions, used internally</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:add_player">Permissions_Groups._prototype:add_player (player)</a></td>
|
||||
<td class="summary">Adds a player to this group</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:remove_player">Permissions_Groups._prototype:remove_player (player)</a></td>
|
||||
<td class="summary">Removes a player from this group</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:get_players">Permissions_Groups._prototype:get_players ([online])</a></td>
|
||||
<td class="summary">Returns all player that are in this group with the option to filter to online/offline only</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Permissions_Groups._prototype:print">Permissions_Groups._prototype:print (message)</a></td>
|
||||
<td class="summary">Prints a message to every player in this group</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "new_group"></a>
|
||||
<strong>new_group (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Defines a new permission group that can have it actions set in the config
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the new group
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span></span>
|
||||
the new group made with function to allow and disallow actions
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "get_group_by_name"></a>
|
||||
<strong>get_group_by_name (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the group with the given name, case sensitive
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the group to get
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span> or <span class="type">nil</span></span>
|
||||
the group with that name or nil if non found
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "get_group_from_player"></a>
|
||||
<strong>get_group_from_player (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the group that a player is in
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the group of can be name index etc
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span> or <span class="type">nil</span></span>
|
||||
the group with that player or nil if non found
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "reload_permissions"></a>
|
||||
<strong>reload_permissions ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Reloads/creates all permission groups and sets them to they configured state
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "lockdown_permissions"></a>
|
||||
<strong>lockdown_permissions (exempt)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes all permissions from every permission group except for "Default" and any passed as exempt
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">exempt</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">Array<string></span></span>
|
||||
groups that you want to be except, "Default" is always exempt
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number of groups that had they permissions removed
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set_player_group"></a>
|
||||
<strong>set_player_group (player, group)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets a player's group to the one given, a player can only have one group at a time
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to effect can be name index etc
|
||||
</li>
|
||||
<li><span class="parameter">group</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the group to give to the player
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if the player was added successfully, false other wise
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:set_action"></a>
|
||||
<strong>Permissions_Groups._prototype:set_action (action, state)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the allow state of an action for this group, used internally but is safe to use else where
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">action</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">defines.input_action</span></span>
|
||||
the action that you want to set the state of
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
the state that you want to set it to, true = allow, false = disallow
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span></span>
|
||||
returns self so function can be chained
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:allow"></a>
|
||||
<strong>Permissions_Groups._prototype:allow (actions)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets an action or actions to be allowed for this group even with disallow_all triggered, Do not use in runtime
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">actions</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">Array<string></span></span>
|
||||
the action or actions that you want to allow for this group
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span></span>
|
||||
returns self so function can be chained
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:disallow"></a>
|
||||
<strong>Permissions_Groups._prototype:disallow (actions)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets an action or actions to be disallowed for this group even with allow_all triggered, Do not use in runtime
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">actions</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">Array<string></span></span>
|
||||
the action or actions that you want to disallow for this group
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span></span>
|
||||
returns self so function can be chained
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:allow_all"></a>
|
||||
<strong>Permissions_Groups._prototype:allow_all ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the default state for any actions not given to be allowed, useful with :disallow
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span></span>
|
||||
returns self so function can be chained
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:disallow_all"></a>
|
||||
<strong>Permissions_Groups._prototype:disallow_all ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the default state for any action not given to be disallowed, useful with :allow
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">Permissions_Groups._prototype</span></span>
|
||||
returns self so function can be chained
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:is_allowed"></a>
|
||||
<strong>Permissions_Groups._prototype:is_allowed (action)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if an input action is allowed for this group
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">action</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">defines.input_action</span></span>
|
||||
the action that you want to test for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if the group is allowed the action, false other wise
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:get_raw"></a>
|
||||
<strong>Permissions_Groups._prototype:get_raw ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the LuaPermissionGroup that was created with this group object, used internally
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaPermissionGroup</span></span>
|
||||
the raw lua permission group
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:create"></a>
|
||||
<strong>Permissions_Groups._prototype:create ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates or updates the permission group with the configured actions, used internally
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaPermissionGroup</span></span>
|
||||
the permission group that was created
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:add_player"></a>
|
||||
<strong>Permissions_Groups._prototype:add_player (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a player to this group
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
LuaPlayer the player you want to add to this group can be name or index etc
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if the player was added successfully, false other wise
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:remove_player"></a>
|
||||
<strong>Permissions_Groups._prototype:remove_player (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes a player from this group
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
LuaPlayer the player you want to remove from this group can be name or index etc
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if the player was removed successfully, false other wise
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:get_players"></a>
|
||||
<strong>Permissions_Groups._prototype:get_players ([online])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns all player that are in this group with the option to filter to online/offline only
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">online</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
if nil returns all players, if true online players only, if false returns online players only
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
a table of players that are in this group; filtered if online param is given
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Permissions_Groups._prototype:print"></a>
|
||||
<strong>Permissions_Groups._prototype:print (message)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prints a message to every player in this group
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">message</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the message that you want to send to the players
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number of players that received the message
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
996
doc/modules/Public.html
Normal file
996
doc/modules/Public.html
Normal file
@@ -0,0 +1,996 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><strong>Public</strong></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>Public</code></h1>
|
||||
<p>Adds some commonly used functions used in many modules</p>
|
||||
<p>
|
||||
[[</p>
|
||||
<h3>Info:</h3>
|
||||
<ul>
|
||||
<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="#type_check">type_check (value[, test_type=nil])</a></td>
|
||||
<td class="summary">Compare types faster for faster validation of params</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#type_check_error">type_check_error (value, test_type, error_message, level)</a></td>
|
||||
<td class="summary">Raises an error if the value is of the wrong type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#param_check">param_check (value, test_type, param_name, param_number)</a></td>
|
||||
<td class="summary">Raises an error when the value is the incorrect type, uses a consistent error message format</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#player_return">player_return (value[, colour=defines.colour.white[, player=game.player]])</a></td>
|
||||
<td class="summary">Will return a value of any type to the player/server console, allows colour for in-game players</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#write_json">write_json (path, tbl)</a></td>
|
||||
<td class="summary">Writes a table object to a file in json format</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#opt_require">opt_require (path)</a></td>
|
||||
<td class="summary">Calls a require that will not error if the file is not found</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ext_require">ext_require (path, ...)</a></td>
|
||||
<td class="summary">Calls a require and returns only the keys given, file must return a table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#format_time">format_time (ticks, options)</a></td>
|
||||
<td class="summary">Formats tick into a clean format, denominations from highest to lowest
|
||||
long will use words rather than letters
|
||||
time will use : separates
|
||||
string will return a string not a locale string
|
||||
when a denomination is false it will overflow into the next one</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#move_items">move_items (items[, surface=navies[, position={0[, radius=32[, chest_type=iron-chest]]]])</a></td>
|
||||
<td class="summary">Moves items to the position and stores them in the closest entity of the type given</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#print_grid_value">print_grid_value (value, surface, position, scale, offset, immutable)</a></td>
|
||||
<td class="summary">https://github.com/Refactorio/RedMew/blob/9184b2940f311d8c9c891e83429fc57ec7e0c4a2/map_gen/maps/diggy/debug.lua#L31
|
||||
Prints a colored value on a location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#print_colored_grid_value">print_colored_grid_value (value, surface, position, offset, immutable, color_value, base_color, delta_color, under_bound, over_bound)</a></td>
|
||||
<td class="summary">Prints a colored value on a location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#clear_flying_text">clear_flying_text (surface)</a></td>
|
||||
<td class="summary">Clears all flying text entites on a surface</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#string_contains">string_contains (s, contains)</a></td>
|
||||
<td class="summary">Tests if a string contains a given substring.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#extract_keys">extract_keys (tbl, ...)</a></td>
|
||||
<td class="summary">Extracts certain keys from a table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#enum">enum (tbl)</a></td>
|
||||
<td class="summary">Converts a table to an enum</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#auto_complete">auto_complete (options, input[, use_key=false[, rtn_key=false]])</a></td>
|
||||
<td class="summary">Returns the closest match to the input</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#table_keys">table_keys (tbl)</a></td>
|
||||
<td class="summary">Returns all the keys of a table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#table_values">table_values (tbl)</a></td>
|
||||
<td class="summary">Returns all the values of a table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#table_alphanumsort">table_alphanumsort (tbl)</a></td>
|
||||
<td class="summary">Returns the list is a sorted way that would be expected by people (this is by key)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#table_keysort">table_keysort (tbl)</a></td>
|
||||
<td class="summary">Returns the list is a sorted way that would be expected by people (this is by key) (faster alterative than above)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#format_chat_colour">format_chat_colour (message, color)</a></td>
|
||||
<td class="summary">Returns a message with valid chat tags to change its colour</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#format_chat_colour_localized">format_chat_colour_localized (message, color)</a></td>
|
||||
<td class="summary">Returns a message with valid chat tags to change its colour, using localization</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#format_chat_player_name">format_chat_player_name (player[, raw_string=false])</a></td>
|
||||
<td class="summary">Returns the players name in the players color</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "type_check"></a>
|
||||
<strong>type_check (value[, test_type=nil])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Compare types faster for faster validation of params
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the value to be tested
|
||||
</li>
|
||||
<li><span class="parameter">test_type</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the type to test for if not given then it tests for nil
|
||||
(<em>default</em> nil)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
is v of type test_type
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<li><pre class="example">type_check(<span class="string">'foo'</span>,<span class="string">'string'</span>) -- <span class="keyword">return</span> <span class="keyword">true</span></pre></li>
|
||||
<li><pre class="example">type_check(<span class="string">'foo'</span>) -- <span class="keyword">return</span> <span class="keyword">false</span></pre></li>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "type_check_error"></a>
|
||||
<strong>type_check_error (value, test_type, error_message, level)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Raises an error if the value is of the wrong type
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the value that you want to test the type of
|
||||
</li>
|
||||
<li><span class="parameter">test_type</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the type that the value should be
|
||||
</li>
|
||||
<li><span class="parameter">error_message</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the error message that is returned
|
||||
</li>
|
||||
<li><span class="parameter">level</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the level to call the error on (level = 1 means the caller)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if no error was called
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">type_check_error(<span class="string">'foo'</span>,<span class="string">'number'</span>,<span class="string">'Value must be a number'</span>) -- will raise error <span class="string">"Value must be a number"</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "param_check"></a>
|
||||
<strong>param_check (value, test_type, param_name, param_number)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Raises an error when the value is the incorrect type, uses a consistent error message format
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the value that you want to test the type of
|
||||
</li>
|
||||
<li><span class="parameter">test_type</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the type that the value should be
|
||||
</li>
|
||||
<li><span class="parameter">param_name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the param
|
||||
</li>
|
||||
<li><span class="parameter">param_number</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number param it is
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if no error was raised
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example">param_check(<span class="string">'foo'</span>,<span class="string">'number'</span>,<span class="string">'repeat_count'</span>,<span class="number">2</span>) -- will raise error <span class="string">"Invalid param #02 given to <anon>; repeat_count is not of type number"</span></pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "player_return"></a>
|
||||
<strong>player_return (value[, colour=defines.colour.white[, player=game.player]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will return a value of any type to the player/server console, allows colour for in-game players
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
any value of any type that will be returned to the player or console
|
||||
</li>
|
||||
<li><span class="parameter">colour</span>
|
||||
<span class="types"><span class="type">defines.color</span> or <a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the colour of the text for the player, ignored when printing to console
|
||||
(<em>default</em> defines.colour.white)
|
||||
</li>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player that return will go to, if no game.player then returns to server
|
||||
(<em>default</em> game.player)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<li><pre class="example">player_return(<span class="string">'Hello, World!'</span>) -- returns <span class="string">'Hello, World!'</span> to game.player <span class="keyword">or</span> server console</pre></li>
|
||||
<li><pre class="example">player_return(<span class="string">'Hello, World!'</span>,<span class="string">'green'</span>) -- returns <span class="string">'Hello, World!'</span> to game.player with colour green <span class="keyword">or</span> server console</pre></li>
|
||||
<li><pre class="example">player_return(<span class="string">'Hello, World!'</span>,<span class="keyword">nil</span>,player) -- returns <span class="string">'Hello, World!'</span> to the given player</pre></li>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "write_json"></a>
|
||||
<strong>write_json (path, tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Writes a table object to a file in json format
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">path</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the path of the file to write include / to use dir
|
||||
</li>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the table that will be converted to a json string and wrote to file
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "opt_require"></a>
|
||||
<strong>opt_require (path)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Calls a require that will not error if the file is not found
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">path</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the path that you want to require
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
the returns from that file or nil, error if not loaded
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> file = opt_require(<span class="string">'file.not.present'</span>) -- will <span class="keyword">not</span> cause any error</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ext_require"></a>
|
||||
<strong>ext_require (path, ...)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Calls a require and returns only the keys given, file must return a table
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">path</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the path that you want to require
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the keys that you want returned
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
the keys in the order given
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> extract, param_check = ext_require(<span class="string">'expcore.common'</span>,<span class="string">'extract'</span>,<span class="string">'param_check'</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "format_time"></a>
|
||||
<strong>format_time (ticks, options)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Formats tick into a clean format, denominations from highest to lowest
|
||||
long will use words rather than letters
|
||||
time will use : separates
|
||||
string will return a string not a locale string
|
||||
when a denomination is false it will overflow into the next one
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ticks</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number of ticks that represents a time
|
||||
</li>
|
||||
<li><span class="parameter">options</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table a of options to use for the format
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
a locale string that can be used
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "move_items"></a>
|
||||
<strong>move_items (items[, surface=navies[, position={0[, radius=32[, chest_type=iron-chest]]]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Moves items to the position and stores them in the closest entity of the type given
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">items</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
items which are to be added to the chests, ['name']=count
|
||||
</li>
|
||||
<li><span class="parameter">surface</span>
|
||||
<span class="types"><span class="type">LuaSurface</span></span>
|
||||
the surface that the items will be moved to
|
||||
(<em>default</em> navies)
|
||||
</li>
|
||||
<li><span class="parameter">position</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the position that the items will be moved to {x=100,y=100}
|
||||
(<em>default</em> {0)
|
||||
</li>
|
||||
<li><span class="parameter">radius</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the radius in which the items are allowed to be placed
|
||||
(<em>default</em> 32)
|
||||
</li>
|
||||
<li><span class="parameter">chest_type</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the chest type that the items should be moved into
|
||||
(<em>default</em> iron-chest)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "print_grid_value"></a>
|
||||
<strong>print_grid_value (value, surface, position, scale, offset, immutable)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
https://github.com/Refactorio/RedMew/blob/9184b2940f311d8c9c891e83429fc57ec7e0c4a2/map_gen/maps/diggy/debug.lua#L31
|
||||
Prints a colored value on a location.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
between -1 and 1
|
||||
</li>
|
||||
<li><span class="parameter">surface</span>
|
||||
LuaSurface
|
||||
</li>
|
||||
<li><span class="parameter">position</span>
|
||||
Position {x, y}
|
||||
</li>
|
||||
<li><span class="parameter">scale</span>
|
||||
float
|
||||
</li>
|
||||
<li><span class="parameter">offset</span>
|
||||
float
|
||||
</li>
|
||||
<li><span class="parameter">immutable</span>
|
||||
bool if immutable, only set, never do a surface lookup, values never change
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "print_colored_grid_value"></a>
|
||||
<strong>print_colored_grid_value (value, surface, position, offset, immutable, color_value, base_color, delta_color, under_bound, over_bound)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prints a colored value on a location. When given a color_value and a delta_color,
|
||||
will change the color of the text from the base to base + value * delta. This will
|
||||
make the color of the text range from 'base_color' to 'base_color + delta_color'
|
||||
as the color_value ranges from 0 to 1
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
of number to be displayed
|
||||
</li>
|
||||
<li><span class="parameter">surface</span>
|
||||
LuaSurface
|
||||
</li>
|
||||
<li><span class="parameter">position</span>
|
||||
Position {x, y}
|
||||
</li>
|
||||
<li><span class="parameter">offset</span>
|
||||
float position offset
|
||||
</li>
|
||||
<li><span class="parameter">immutable</span>
|
||||
bool if immutable, only set, never do a surface lookup, values never change
|
||||
</li>
|
||||
<li><span class="parameter">color_value</span>
|
||||
float How far along the range of values of colors the value is to be displayed
|
||||
</li>
|
||||
<li><span class="parameter">base_color</span>
|
||||
{r,g,b} The color for the text to be if color_value is 0
|
||||
</li>
|
||||
<li><span class="parameter">delta_color</span>
|
||||
{r,g,b} The amount to correct the base_color if color_value is 1
|
||||
</li>
|
||||
<li><span class="parameter">under_bound</span>
|
||||
{r,g,b} The color to be used if color_value < 0
|
||||
</li>
|
||||
<li><span class="parameter">over_bound</span>
|
||||
{r,g,b} The color to be used if color_value > 1
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "clear_flying_text"></a>
|
||||
<strong>clear_flying_text (surface)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clears all flying text entites on a surface
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">surface</span>
|
||||
<span class="types"><span class="type">LuaSurface</span></span>
|
||||
the surface to clear
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "string_contains"></a>
|
||||
<strong>string_contains (s, contains)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Tests if a string contains a given substring.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">s</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the string to check for the substring
|
||||
</li>
|
||||
<li><span class="parameter">contains</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the substring to test for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if the substring was found in the string
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "extract_keys"></a>
|
||||
<strong>extract_keys (tbl, ...)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Extracts certain keys from a table
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table the which contains the keys
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the names of the keys you want extracted
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
the keys in the order given
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<pre class="example"><span class="keyword">local</span> key_three, key_one = extract({key_one=<span class="string">'foo'</span>,key_two=<span class="string">'bar'</span>,key_three=<span class="keyword">true</span>},<span class="string">'key_three'</span>,<span class="string">'key_one'</span>)</pre>
|
||||
</ul>
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "enum"></a>
|
||||
<strong>enum (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts a table to an enum
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table the that will be converted
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new table that acts like an enum
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "auto_complete"></a>
|
||||
<strong>auto_complete (options, input[, use_key=false[, rtn_key=false]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the closest match to the input
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">options</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table a of options for the auto complete
|
||||
</li>
|
||||
<li><span class="parameter">input</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
string the input that will be completed
|
||||
</li>
|
||||
<li><span class="parameter">use_key</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true the keys of options will be used as the options
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
<li><span class="parameter">rtn_key</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true the the key will be returned rather than the value
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
the list item found that matches the input
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "table_keys"></a>
|
||||
<strong>table_keys (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns all the keys of a table
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table the to get the keys of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
an array of the table keys
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "table_values"></a>
|
||||
<strong>table_values (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns all the values of a table
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
table the to get the values of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
an array of the table values
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "table_alphanumsort"></a>
|
||||
<strong>table_alphanumsort (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the list is a sorted way that would be expected by people (this is by key)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the table to be sorted
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the sorted table
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "table_keysort"></a>
|
||||
<strong>table_keysort (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the list is a sorted way that would be expected by people (this is by key) (faster alterative than above)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the table to be sorted
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the sorted table
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "format_chat_colour"></a>
|
||||
<strong>format_chat_colour (message, color)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a message with valid chat tags to change its colour
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">message</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the message that will be in the output
|
||||
</li>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
a color which contains r,g,b as its keys
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the message with the color tags included
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "format_chat_colour_localized"></a>
|
||||
<strong>format_chat_colour_localized (message, color)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a message with valid chat tags to change its colour, using localization
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">message</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the message that will be in the output
|
||||
</li>
|
||||
<li><span class="parameter">color</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
a color which contains r,g,b as its keys
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the message with the color tags included
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "format_chat_player_name"></a>
|
||||
<strong>format_chat_player_name (player[, raw_string=false])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the players name in the players color
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to use the name and color of
|
||||
</li>
|
||||
<li><span class="parameter">raw_string</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true a is returned rather than a localized string
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the players name with tags for the players color
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
121
doc/modules/config._file_loader.html
Normal file
121
doc/modules/config._file_loader.html
Normal file
@@ -0,0 +1,121 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><strong>config._file_loader</strong></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config._file_loader</code></h1>
|
||||
<p>This contains a list of all files that will be loaded and the order they are loaded in
|
||||
to stop a file from loading add "--" in front of it, remove the "--" to have the file be loaded
|
||||
config files should be loaded after all modules are loaded
|
||||
core files should be required by modules and not be present in this list</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
122
doc/modules/config.action_buttons.html
Normal file
122
doc/modules/config.action_buttons.html
Normal file
@@ -0,0 +1,122 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><strong>config.action_buttons</strong></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.action_buttons</code></h1>
|
||||
<p>Config for the different action buttons that show on the player list
|
||||
each button has the button define(s) given along side an auth function, and optional reason callback
|
||||
if a reason callback is used then Store.set_child(action_name_store,player.name,'BUTTON_NAME') should be called during on_click
|
||||
buttons can be removed from the gui by commenting them out of the config at the bottom of this file
|
||||
the key used for the name of the button is the permision name used by the role system</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.advanced_start.html
Normal file
118
doc/modules/config.advanced_start.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><strong>config.advanced_start</strong></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.advanced_start</code></h1>
|
||||
<p>This file is used to setup the map starting settings and the items players will start with</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
120
doc/modules/config.death_logger.html
Normal file
120
doc/modules/config.death_logger.html
Normal file
@@ -0,0 +1,120 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><strong>config.death_logger</strong></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.death_logger</code></h1>
|
||||
<p>This config controls what happens when a player dies mostly about map markers and item collection
|
||||
allow_teleport_to_body_command and allow_collect_bodies_command can be over ridden if command_auth_runtime_disable is present
|
||||
if not present then the commands will not be loaded into the game</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
120
doc/modules/config.expcore-commands.auth_admin.html
Normal file
120
doc/modules/config.expcore-commands.auth_admin.html
Normal file
@@ -0,0 +1,120 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><strong>config.expcore-commands.auth_admin</strong></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.expcore-commands.auth_admin</code></h1>
|
||||
<p>This is a very simple config file which adds a admin only auth function
|
||||
not much to change here its more so it can be enabled and disabled from ./config/file_loader.lua
|
||||
either way you can change the requirements to be "admin" if you wanted to</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.expcore-commands.auth_roles.html
Normal file
118
doc/modules/config.expcore-commands.auth_roles.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><strong>config.expcore-commands.auth_roles</strong></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.expcore-commands.auth_roles</code></h1>
|
||||
<p>This will make commands only work if the role has been allowed it in the role config</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
119
doc/modules/config.expcore-commands.auth_runtime_disable.html
Normal file
119
doc/modules/config.expcore-commands.auth_runtime_disable.html
Normal file
@@ -0,0 +1,119 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><strong>config.expcore-commands.auth_runtime_disable</strong></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.expcore-commands.auth_runtime_disable</code></h1>
|
||||
<p>This config for command auth allows commands to be globally enabled and disabled during runtime
|
||||
this config adds Commands.disable and Commands.enable to enable and disable commands for all users</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
122
doc/modules/config.expcore-commands.parse_general.html
Normal file
122
doc/modules/config.expcore-commands.parse_general.html
Normal file
@@ -0,0 +1,122 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><strong>config.expcore-commands.parse_general</strong></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.expcore-commands.parse_general</code></h1>
|
||||
<p>This file contains some common command param parse functions
|
||||
this file is less of a config and more of a requirement but you may wish to change how some behave
|
||||
as such you need to be confident with lua but you edit this config file
|
||||
use Commands.add_parse('name',function(input,player,reject) end) to add a parse
|
||||
see ./expcore/commands.lua for more details</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.expcore-commands.parse_roles.html
Normal file
118
doc/modules/config.expcore-commands.parse_roles.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><strong>config.expcore-commands.parse_roles</strong></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.expcore-commands.parse_roles</code></h1>
|
||||
<p>Adds some parse functions that can be used with the role system</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
121
doc/modules/config.permission_groups.html
Normal file
121
doc/modules/config.permission_groups.html
Normal file
@@ -0,0 +1,121 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><strong>config.permission_groups</strong></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.permission_groups</code></h1>
|
||||
<p>Use this file to add new permission groups to the game
|
||||
start with Permission_Groups.new_group('name')
|
||||
then use either :allow_all() or :disallow_all() to set the default for non specified actions
|
||||
then use :allow{} and :disallow{} to specify certain actions to allow/disallow</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.popup_messages.html
Normal file
118
doc/modules/config.popup_messages.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><strong>config.popup_messages</strong></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.popup_messages</code></h1>
|
||||
<p>A combination of config settings for different popup values like chat and damage</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
165
doc/modules/config.rockets.html
Normal file
165
doc/modules/config.rockets.html
Normal file
@@ -0,0 +1,165 @@
|
||||
<!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="#Fields">Fields</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><strong>config.rockets</strong></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.rockets</code></h1>
|
||||
<p>This file controls what will show in each section of the rocket info gui</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#show_stats">show_stats</a></td>
|
||||
<td class="summary">The data that will show in the stats section</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#show_progress">show_progress</a></td>
|
||||
<td class="summary">The data and buttons in the build progress section</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Fields"></a>Fields</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "show_stats"></a>
|
||||
<strong>show_stats</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The data that will show in the stats section
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "show_progress"></a>
|
||||
<strong>show_progress</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
The data and buttons in the build progress section
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.roles.html
Normal file
118
doc/modules/config.roles.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><strong>config.roles</strong></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.roles</code></h1>
|
||||
<p>This is the main config file for the role system; file includes defines for roles and role flags and default values</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.scorched_earth.html
Normal file
118
doc/modules/config.scorched_earth.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><strong>config.scorched_earth</strong></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.scorched_earth</code></h1>
|
||||
<p>This file controls the placement/degrading of tiles as players build and walk</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.spawn_area.html
Normal file
118
doc/modules/config.spawn_area.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><strong>config.spawn_area</strong></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.spawn_area</code></h1>
|
||||
<p>Used to config the spawn generation settings yes there is alot here i know just ignore the long tables at the end (they were generated with a command)</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/config.warnings.html
Normal file
118
doc/modules/config.warnings.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><strong>config.warnings</strong></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>config.warnings</code></h1>
|
||||
<p>Config file for the warning system, this is very similar to reports but is for the use of moderators rather than normal users.</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
121
doc/modules/control.html
Normal file
121
doc/modules/control.html
Normal file
@@ -0,0 +1,121 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><strong>control</strong></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>control</code></h1>
|
||||
<p>Please go to ./config if you want to change settings, each file is commented with what it does
|
||||
if it is not in ./config then you should not attempt to change it unless you know what you are doing
|
||||
all files which are loaded (including the config files) are present in ./config/file_loader.lua
|
||||
this file is the landing point for all scenarios please DO NOT edit directly, further comments are to aid development</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
275
doc/modules/expcore.gui.buttons.html
Normal file
275
doc/modules/expcore.gui.buttons.html
Normal file
@@ -0,0 +1,275 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><strong>expcore.gui.buttons</strong></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.buttons</code></h1>
|
||||
<p>Gui class define for buttons and sprite buttons
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Button.new_button">Button.new_button ([name])</a></td>
|
||||
<td class="summary">Creates a new button element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Button._prototype:set_sprites">Button._prototype:set_sprites (sprite[, hovered_sprite[, clicked_sprite]])</a></td>
|
||||
<td class="summary">Adds sprites to a button making it a spirte button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Button._prototype:set_click_filter">Button._prototype:set_click_filter (filter[, ...])</a></td>
|
||||
<td class="summary">Adds a click / mouse button filter to the button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Button._prototype:set_key_filter">Button._prototype:set_key_filter (filter[, ...])</a></td>
|
||||
<td class="summary">Adds a control key filter to the button</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Button.new_button"></a>
|
||||
<strong>Button.new_button ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new button element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new button element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Button._prototype:set_sprites"></a>
|
||||
<strong>Button._prototype:set_sprites (sprite[, hovered_sprite[, clicked_sprite]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds sprites to a button making it a spirte button
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">sprite</span>
|
||||
<span class="types"><span class="type">SpritePath</span></span>
|
||||
the sprite path for the default sprite for the button
|
||||
</li>
|
||||
<li><span class="parameter">hovered_sprite</span>
|
||||
<span class="types"><span class="type">SpritePath</span></span>
|
||||
the sprite path for the sprite when the player hovers over the button
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">clicked_sprite</span>
|
||||
<span class="types"><span class="type">SpritePath</span></span>
|
||||
the sprite path for the sprite when the player clicks the button
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
returns the button define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Button._prototype:set_click_filter"></a>
|
||||
<strong>Button._prototype:set_click_filter (filter[, ...])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a click / mouse button filter to the button
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">filter</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
?string|table either a of mouse buttons or the first mouse button to filter, with a table true means allowed
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
when filter is not a you can add the mouse buttons one after each other
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
returns the button define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Button._prototype:set_key_filter"></a>
|
||||
<strong>Button._prototype:set_key_filter (filter[, ...])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a control key filter to the button
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">filter</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
?string|table either a of control keys or the first control keys to filter, with a table true means allowed
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
when filter is not a you can add the control keyss one after each other
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
returns the button define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
472
doc/modules/expcore.gui.center.html
Normal file
472
doc/modules/expcore.gui.center.html
Normal file
@@ -0,0 +1,472 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><strong>expcore.gui.center</strong></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.center</code></h1>
|
||||
<p>Gui structure define for center gui frames
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames.get_flow">CenterFrames.get_flow (player)</a></td>
|
||||
<td class="summary">Gets the center flow for a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames.clear_flow">CenterFrames.clear_flow (player)</a></td>
|
||||
<td class="summary">Clears the center flow for a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames.draw_frame">CenterFrames.draw_frame (player, name)</a></td>
|
||||
<td class="summary">Draws the center frame for a player, if already open then will do nothing</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames.redraw_frame">CenterFrames.redraw_frame (player, name)</a></td>
|
||||
<td class="summary">Draws the center frame for a player, if already open then will destroy it and redraw</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames.toggle_frame">CenterFrames.toggle_frame (player, name[, state])</a></td>
|
||||
<td class="summary">Toggles if the frame is currently open or not, will open if closed and close if open</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames.new_frame">CenterFrames.new_frame (permision_name)</a></td>
|
||||
<td class="summary">Creates a new center frame define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames._prototype:set_auto_focus">CenterFrames._prototype:set_auto_focus ([state=true])</a></td>
|
||||
<td class="summary">Sets the frame to be the current active gui when opened and closes all other frames</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames._prototype:draw_frame">CenterFrames._prototype:draw_frame (player)</a></td>
|
||||
<td class="summary">Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames._prototype:redraw_frame">CenterFrames._prototype:redraw_frame (player)</a></td>
|
||||
<td class="summary">Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames._prototype:toggle_frame">CenterFrames._prototype:toggle_frame (player)</a></td>
|
||||
<td class="summary">Toggles if the frame is open, if open it will close it and if closed it will open it</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#CenterFrames._prototype:event_handler">CenterFrames._prototype:event_handler ([action=update])</a></td>
|
||||
<td class="summary">Creates an event handler that will trigger one of its functions, use with Event.add</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "CenterFrames.get_flow"></a>
|
||||
<strong>CenterFrames.get_flow (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the center flow for a player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the flow for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the center flow
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames.clear_flow"></a>
|
||||
<strong>CenterFrames.clear_flow (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clears the center flow for a player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to clear the flow for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames.draw_frame"></a>
|
||||
<strong>CenterFrames.draw_frame (player, name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Draws the center frame for a player, if already open then will do nothing
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player that will have the frame drawn
|
||||
</li>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the hui that will drawn
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the new frame that was made
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames.redraw_frame"></a>
|
||||
<strong>CenterFrames.redraw_frame (player, name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Draws the center frame for a player, if already open then will destroy it and redraw
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player that will have the frame drawn
|
||||
</li>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the hui that will drawn
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the new frame that was made
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames.toggle_frame"></a>
|
||||
<strong>CenterFrames.toggle_frame (player, name[, state])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Toggles if the frame is currently open or not, will open if closed and close if open
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player that will have the frame toggled
|
||||
</li>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the hui that will be toggled
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when set will force a state for the frame
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
if the frame if no open or closed
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames.new_frame"></a>
|
||||
<strong>CenterFrames.new_frame (permision_name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new center frame define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">permision_name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name that can be used with the permision system
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new center frame define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames._prototype:set_auto_focus"></a>
|
||||
<strong>CenterFrames._prototype:set_auto_focus ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the frame to be the current active gui when opened and closes all other frames
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true will auto close other frames and set this frame as player.opened
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames._prototype:draw_frame"></a>
|
||||
<strong>CenterFrames._prototype:draw_frame (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Draws this frame to the player, if already open does nothing (will call on_draw to draw to the frame)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to draw the frame for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the new frame that was drawn
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames._prototype:redraw_frame"></a>
|
||||
<strong>CenterFrames._prototype:redraw_frame (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Draws this frame to the player, if already open it will remove it and redraw it (will call on_draw to draw to the frame)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to draw the frame for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the new frame that was drawn
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames._prototype:toggle_frame"></a>
|
||||
<strong>CenterFrames._prototype:toggle_frame (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Toggles if the frame is open, if open it will close it and if closed it will open it
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to draw the frame for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
with the gui frame is now open
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "CenterFrames._prototype:event_handler"></a>
|
||||
<strong>CenterFrames._prototype:event_handler ([action=update])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates an event handler that will trigger one of its functions, use with Event.add
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">action</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the action to take on this event
|
||||
(<em>default</em> update)
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
414
doc/modules/expcore.gui.checkboxs.html
Normal file
414
doc/modules/expcore.gui.checkboxs.html
Normal file
@@ -0,0 +1,414 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><strong>expcore.gui.checkboxs</strong></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.checkboxs</code></h1>
|
||||
<p>Gui class define for checkboxs and radiobuttons
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox.new_checkbox">Checkbox.new_checkbox ([name])</a></td>
|
||||
<td class="summary">Creates a new checkbox element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox.new_radiobutton">Checkbox.new_radiobutton ([name])</a></td>
|
||||
<td class="summary">Creates a new radiobutton element define, has all functions checkbox has</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox._prototype_radiobutton:add_as_option">Checkbox._prototype_radiobutton:add_as_option (option_set, option_name)</a></td>
|
||||
<td class="summary">Adds this radiobutton to be an option in the given option set (only one can be true at a time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox._prototype_radiobutton:get_store">Checkbox._prototype_radiobutton:get_store (category, internal)</a></td>
|
||||
<td class="summary">Gets the stored value of the radiobutton or the option set if present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox._prototype_radiobutton:set_store">Checkbox._prototype_radiobutton:set_store (category, value, internal)</a></td>
|
||||
<td class="summary">Sets the stored value of the radiobutton or the option set if present</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox.new_option_set">Checkbox.new_option_set (name, callback, categorize)</a></td>
|
||||
<td class="summary">Registers a new option set that can be linked to radiobutotns (only one can be true at a time)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox.draw_option_set">Checkbox.draw_option_set (name, element)</a></td>
|
||||
<td class="summary">Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Checkbox.reset_radiobuttons">Checkbox.reset_radiobuttons (element[, exclude[, recursive=false]])</a></td>
|
||||
<td class="summary">Sets all radiobutotn in a element to false (unless excluded) and can act recursivly</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Checkbox.new_checkbox"></a>
|
||||
<strong>Checkbox.new_checkbox ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new checkbox element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new checkbox element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox.new_radiobutton"></a>
|
||||
<strong>Checkbox.new_radiobutton ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new radiobutton element define, has all functions checkbox has
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new button element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox._prototype_radiobutton:add_as_option"></a>
|
||||
<strong>Checkbox._prototype_radiobutton:add_as_option (option_set, option_name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds this radiobutton to be an option in the given option set (only one can be true at a time)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">option_set</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the option set to add this element to
|
||||
</li>
|
||||
<li><span class="parameter">option_name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of this option that will be used to idenitife it
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox._prototype_radiobutton:get_store"></a>
|
||||
<strong>Checkbox._prototype_radiobutton:get_store (category, internal)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the stored value of the radiobutton or the option set if present
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">category</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
[opt] the category to get such as player name or force name
|
||||
</li>
|
||||
<li><span class="parameter">internal</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
used to prevent stackover flow
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the value that is stored for this define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox._prototype_radiobutton:set_store"></a>
|
||||
<strong>Checkbox._prototype_radiobutton:set_store (category, value, internal)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the stored value of the radiobutton or the option set if present
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">category</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
[opt] the category to get such as player name or force name
|
||||
</li>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
the value to set for this define, must be valid for its type ie for checkbox etc
|
||||
</li>
|
||||
<li><span class="parameter">internal</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
used to prevent stackover flow
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if the value was set
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox.new_option_set"></a>
|
||||
<strong>Checkbox.new_option_set (name, callback, categorize)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers a new option set that can be linked to radiobutotns (only one can be true at a time)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the option set, must be unique
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the update callback when the value of the option set chagnes
|
||||
callback param - value string - the new selected option for this option set
|
||||
callback param - category string - the category that updated if categorize was used
|
||||
</li>
|
||||
<li><span class="parameter">categorize</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function used to convert an element into a string
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of this option set to be passed to add_as_option
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox.draw_option_set"></a>
|
||||
<strong>Checkbox.draw_option_set (name, element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Draws all radiobuttons that are part of an option set at once (Gui.draw will not work)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the option set to draw the radiobuttons of
|
||||
</li>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the parent element that the radiobuttons will be drawn to
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Checkbox.reset_radiobuttons"></a>
|
||||
<strong>Checkbox.reset_radiobuttons (element[, exclude[, recursive=false]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets all radiobutotn in a element to false (unless excluded) and can act recursivly
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the root gui element to start setting radio buttons from
|
||||
</li>
|
||||
<li><span class="parameter">exclude</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
?string|table the name of the radiobutton to exclude or a of radiobuttons where true will set the state true
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">recursive</span>
|
||||
<span class="types"><span class="type">number</span> or <span class="type">boolean</span></span>
|
||||
if true will recur as much as possible, if a will recur that number of times
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if successful
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
121
doc/modules/expcore.gui.core.html
Normal file
121
doc/modules/expcore.gui.core.html
Normal file
@@ -0,0 +1,121 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><strong>expcore.gui.core</strong></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.core</code></h1>
|
||||
<p>Core gui file for making element defines and element classes (use require 'expcore.gui')
|
||||
see utils.gui for event handlering
|
||||
see expcore.gui.test for examples for element defines
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
366
doc/modules/expcore.gui.dropdown.html
Normal file
366
doc/modules/expcore.gui.dropdown.html
Normal file
@@ -0,0 +1,366 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><strong>expcore.gui.dropdown</strong></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.dropdown</code></h1>
|
||||
<p>Gui class define for dropdowns and list boxs
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown.new_dropdown">Dropdown.new_dropdown ([name])</a></td>
|
||||
<td class="summary">Creates a new dropdown element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown.new_list_box">Dropdown.new_list_box ([name])</a></td>
|
||||
<td class="summary">Creates a new list box element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown._prototype:new_static_options">Dropdown._prototype:new_static_options (options[, ...], the)</a></td>
|
||||
<td class="summary">Adds new static options to the dropdown which will trigger the general callback</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown._prototype:new_dynamic_options">Dropdown._prototype:new_dynamic_options (callback)</a></td>
|
||||
<td class="summary">Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown._prototype:add_option_callback">Dropdown._prototype:add_option_callback (option, callback)</a></td>
|
||||
<td class="summary">Adds a case specific callback which will only run when that option is selected (general case still triggered)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown.select_value">Dropdown.select_value (element, value)</a></td>
|
||||
<td class="summary">Selects the option from a dropdown or list box given the value rather than key</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Dropdown.get_selected_value">Dropdown.get_selected_value (element)</a></td>
|
||||
<td class="summary">Returns the currently selected value rather than index</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Dropdown.new_dropdown"></a>
|
||||
<strong>Dropdown.new_dropdown ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new dropdown element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new dropdown element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Dropdown.new_list_box"></a>
|
||||
<strong>Dropdown.new_list_box ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new list box element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new list box element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Dropdown._prototype:new_static_options"></a>
|
||||
<strong>Dropdown._prototype:new_static_options (options[, ...], the)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds new static options to the dropdown which will trigger the general callback
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">options</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
?string|table either a of option strings or the first option string, with a table values are the options
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
when options is not a you can add the options one after each other
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">the</span>
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
define to allow chaining
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Dropdown._prototype:new_dynamic_options"></a>
|
||||
<strong>Dropdown._prototype:new_dynamic_options (callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a callback which should return a table of values to be added as options for the dropdown (appended after static options)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function that will run to get the options for the dropdown
|
||||
callback param - player LuaPlayer - the player that the element is being drawn to
|
||||
callback param - element LuaGuiElement - the element that is being drawn
|
||||
callback return - table - the values of this table will be appended to the static options of the dropdown
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Dropdown._prototype:add_option_callback"></a>
|
||||
<strong>Dropdown._prototype:add_option_callback (option, callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a case specific callback which will only run when that option is selected (general case still triggered)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">option</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the option to trigger the callback on; if not already added then will be added as an option
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the function that will be called when that option is selected
|
||||
callback param - player LuaPlayer - the player who owns the gui element
|
||||
callback param - element LuaGuiElement - the element which is being effected
|
||||
callback param - value string - the new option that has been selected
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Dropdown.select_value"></a>
|
||||
<strong>Dropdown.select_value (element, value)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Selects the option from a dropdown or list box given the value rather than key
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the element that contains the option
|
||||
</li>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the option to select from the dropdown
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the key where the value was
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Dropdown.get_selected_value"></a>
|
||||
<strong>Dropdown.get_selected_value (element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the currently selected value rather than index
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the gui element that you want to get the value of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the value that is currently selected
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
224
doc/modules/expcore.gui.elem-button.html
Normal file
224
doc/modules/expcore.gui.elem-button.html
Normal file
@@ -0,0 +1,224 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><strong>expcore.gui.elem-button</strong></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.elem-button</code></h1>
|
||||
<p>Gui class defines for elem buttons
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ElemButton.new_elem_button">ElemButton.new_elem_button ([name])</a></td>
|
||||
<td class="summary">Creates a new elem button element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ElemButton._prototype:set_type">ElemButton._prototype:set_type (type)</a></td>
|
||||
<td class="summary">Sets the type of the elem button, the type is required so this must be called at least once</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ElemButton._prototype:set_default">ElemButton._prototype:set_default (value)</a></td>
|
||||
<td class="summary">Sets the default value for the elem button, this may be a function or a string</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "ElemButton.new_elem_button"></a>
|
||||
<strong>ElemButton.new_elem_button ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new elem button element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new elem button element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ElemButton._prototype:set_type"></a>
|
||||
<strong>ElemButton._prototype:set_type (type)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the type of the elem button, the type is required so this must be called at least once
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">type</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the type that this elem button is see factorio api
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">the</span></span>
|
||||
element define to allow for chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ElemButton._prototype:set_default"></a>
|
||||
<strong>ElemButton._prototype:set_default (value)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the default value for the elem button, this may be a function or a string
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a> or <span class="type">function</span></span>
|
||||
string a will be a static default and a function will be called when drawn to get the default
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">the</span></span>
|
||||
element define to allow for chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
119
doc/modules/expcore.gui.html
Normal file
119
doc/modules/expcore.gui.html
Normal file
@@ -0,0 +1,119 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><strong>expcore.gui</strong></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui</code></h1>
|
||||
<p>This file is used to require all the different elements of the gui module
|
||||
each module has an outline here but for more details see their seperate files in ./gui</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
119
doc/modules/expcore.gui.instances.html
Normal file
119
doc/modules/expcore.gui.instances.html
Normal file
@@ -0,0 +1,119 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><strong>expcore.gui.instances</strong></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.instances</code></h1>
|
||||
<p>This file is a breakout from core which forcues on instance management of defines
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
573
doc/modules/expcore.gui.left.html
Normal file
573
doc/modules/expcore.gui.left.html
Normal file
@@ -0,0 +1,573 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><strong>expcore.gui.left</strong></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.left</code></h1>
|
||||
<p>Gui structure define for left frames
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames.get_flow">LeftFrames.get_flow (player)</a></td>
|
||||
<td class="summary">Gets the left frame flow for a player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames.get_frame">LeftFrames.get_frame (name, player)</a></td>
|
||||
<td class="summary">Gets one frame from the left flow by its name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames.get_open">LeftFrames.get_open (player)</a></td>
|
||||
<td class="summary">Gets all open frames for a player, if non are open it will remove the close all button</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames.toggle_frame">LeftFrames.toggle_frame (name, player[, state])</a></td>
|
||||
<td class="summary">Toggles the visiblty of a left frame, or sets its visiblty state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames.new_frame">LeftFrames.new_frame (permision_name)</a></td>
|
||||
<td class="summary">Creates a new left frame define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:set_open_by_default">LeftFrames._prototype:set_open_by_default ([state=true])</a></td>
|
||||
<td class="summary">Sets if the frame is visible when a player joins, can also be a function to return a boolean</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:set_direction">LeftFrames._prototype:set_direction (direction)</a></td>
|
||||
<td class="summary">Sets the direction of the frame, either vertical or horizontal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:get_frame">LeftFrames._prototype:get_frame (player)</a></td>
|
||||
<td class="summary">Gets the frame for this define from the left frame flow</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:is_open">LeftFrames._prototype:is_open (player)</a></td>
|
||||
<td class="summary">Returns if the player currently has this define visible</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:toggle">LeftFrames._prototype:toggle (player)</a></td>
|
||||
<td class="summary">Toggles the visiblty of the left frame</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:update">LeftFrames._prototype:update (player)</a></td>
|
||||
<td class="summary">Updates the contents of the left frame, first tries update callback, oter wise will clear and redraw</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:update_all">LeftFrames._prototype:update_all ([update_offline=false])</a></td>
|
||||
<td class="summary">Updates the frame for all players, see update</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:redraw">LeftFrames._prototype:redraw (player)</a></td>
|
||||
<td class="summary">Redraws the frame by calling on_draw, will always clear the frame</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:redraw_all">LeftFrames._prototype:redraw_all ([update_offline=false])</a></td>
|
||||
<td class="summary">Redraws the frame for all players, see redraw</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#LeftFrames._prototype:event_handler">LeftFrames._prototype:event_handler ([action=update])</a></td>
|
||||
<td class="summary">Creates an event handler that will trigger one of its functions, use with Event.add</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "LeftFrames.get_flow"></a>
|
||||
<strong>LeftFrames.get_flow (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the left frame flow for a player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the flow of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the left frame flow for the player
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames.get_frame"></a>
|
||||
<strong>LeftFrames.get_frame (name, player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets one frame from the left flow by its name
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the gui frame to get
|
||||
</li>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the frame of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the frame in the left frame flow with that name
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames.get_open"></a>
|
||||
<strong>LeftFrames.get_open (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets all open frames for a player, if non are open it will remove the close all button
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the flow of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
contains all the open (and registered) frames for the player
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames.toggle_frame"></a>
|
||||
<strong>LeftFrames.toggle_frame (name, player[, state])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Toggles the visiblty of a left frame, or sets its visiblty state
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the gui frame to toggle
|
||||
</li>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the frame of
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when given will be the state that the visiblty is set to
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
the new state of the visiblity
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames.new_frame"></a>
|
||||
<strong>LeftFrames.new_frame (permision_name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new left frame define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">permision_name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name that can be used with the permision system
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new left frame define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:set_open_by_default"></a>
|
||||
<strong>LeftFrames._prototype:set_open_by_default ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets if the frame is visible when a player joins, can also be a function to return a boolean
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span> or <span class="type">function</span></span>
|
||||
the default state of the visiblty, can be a function
|
||||
state param - player LuaPlayer - the player that has joined the game
|
||||
state param - define_name string - the define name for the frame
|
||||
state return - boolean - false will hide the frame
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:set_direction"></a>
|
||||
<strong>LeftFrames._prototype:set_direction (direction)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the direction of the frame, either vertical or horizontal
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">direction</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the direction to have the elements be added to thef frame
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:get_frame"></a>
|
||||
<strong>LeftFrames._prototype:get_frame (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the frame for this define from the left frame flow
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the frame of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the frame in the left frame flow for this define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:is_open"></a>
|
||||
<strong>LeftFrames._prototype:is_open (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns if the player currently has this define visible
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the frame of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if it is open/visible
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:toggle"></a>
|
||||
<strong>LeftFrames._prototype:toggle (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Toggles the visiblty of the left frame
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to toggle the frame of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
the new state of the visiblity
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:update"></a>
|
||||
<strong>LeftFrames._prototype:update (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Updates the contents of the left frame, first tries update callback, oter wise will clear and redraw
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to update the frame of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:update_all"></a>
|
||||
<strong>LeftFrames._prototype:update_all ([update_offline=false])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Updates the frame for all players, see update
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">update_offline</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true will update the frame for offline players
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:redraw"></a>
|
||||
<strong>LeftFrames._prototype:redraw (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Redraws the frame by calling on_draw, will always clear the frame
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to update the frame of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:redraw_all"></a>
|
||||
<strong>LeftFrames._prototype:redraw_all ([update_offline=false])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Redraws the frame for all players, see redraw
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">update_offline</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true will update the frame for offline players
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "LeftFrames._prototype:event_handler"></a>
|
||||
<strong>LeftFrames._prototype:event_handler ([action=update])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates an event handler that will trigger one of its functions, use with Event.add
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">action</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the action to take on this event
|
||||
(<em>default</em> update)
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
352
doc/modules/expcore.gui.popups.html
Normal file
352
doc/modules/expcore.gui.popups.html
Normal file
@@ -0,0 +1,352 @@
|
||||
<!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="#Fields">Fields</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><strong>expcore.gui.popups</strong></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.popups</code></h1>
|
||||
<p>Gui structure define for popup gui
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames.get_flow">PopupFrames.get_flow (player)</a></td>
|
||||
<td class="summary">Gets the left flow that contains the popup frames</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames.open">PopupFrames.open (define_name, player[, open_time], ...)</a></td>
|
||||
<td class="summary">Opens a popup for the player, can give the amount of time it is open as well as params for the draw function</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames.new_popup">PopupFrames.new_popup ([name])</a></td>
|
||||
<td class="summary">Creates a new popup frame define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames._prototype:set_default_open_time">PopupFrames._prototype:set_default_open_time (amount)</a></td>
|
||||
<td class="summary">Sets the default open time for the popup, will be used if non is provided with open</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames._prototype:open">PopupFrames._prototype:open (player[, open_time], ...)</a></td>
|
||||
<td class="summary">Opens this define for a player, can be given open time and any other params for the draw function</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames.close_progress">PopupFrames.close_progress</a></td>
|
||||
<td class="summary">Progress bar which when depleaded will close the popup frame</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#PopupFrames.close_button">PopupFrames.close_button</a></td>
|
||||
<td class="summary">A button which can be used to close the gui before the timer runs out</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "PopupFrames.get_flow"></a>
|
||||
<strong>PopupFrames.get_flow (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the left flow that contains the popup frames
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to get the flow for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the left flow that contains the popup frames
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PopupFrames.open"></a>
|
||||
<strong>PopupFrames.open (define_name, player[, open_time], ...)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Opens a popup for the player, can give the amount of time it is open as well as params for the draw function
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">define_name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the name of the define that you want to open for the player
|
||||
</li>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to open the popup for
|
||||
</li>
|
||||
<li><span class="parameter">open_time</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the other params that you want to pass to your on_draw event
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the frame that was drawn, the inner gui flow which contains the content
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PopupFrames.new_popup"></a>
|
||||
<strong>PopupFrames.new_popup ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new popup frame define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new popup frame define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PopupFrames._prototype:set_default_open_time"></a>
|
||||
<strong>PopupFrames._prototype:set_default_open_time (amount)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the default open time for the popup, will be used if non is provided with open
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the number of ticks, by default, the popup will be open for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the define to allow for chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PopupFrames._prototype:open"></a>
|
||||
<strong>PopupFrames._prototype:open (player[, open_time], ...)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Opens this define for a player, can be given open time and any other params for the draw function
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to open the popup for
|
||||
</li>
|
||||
<li><span class="parameter">open_time</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the minimum number of ticks you want the popup open for, 0 means no limit, nil will take default
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">...</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the other params that you want to pass to your on_draw event
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the frame that was drawn, the inner gui flow which contains the content
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Fields"></a>Fields</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "PopupFrames.close_progress"></a>
|
||||
<strong>PopupFrames.close_progress</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Progress bar which when depleaded will close the popup frame
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "PopupFrames.close_button"></a>
|
||||
<strong>PopupFrames.close_button</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
A button which can be used to close the gui before the timer runs out
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
557
doc/modules/expcore.gui.progress-bar.html
Normal file
557
doc/modules/expcore.gui.progress-bar.html
Normal file
@@ -0,0 +1,557 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><strong>expcore.gui.progress-bar</strong></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.progress-bar</code></h1>
|
||||
<p>Gui element define for progess bars
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar.set_maximum">ProgressBar.set_maximum (element, amount)</a></td>
|
||||
<td class="summary">Sets the maximum value that represents the end value of the progress bar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar.increment">ProgressBar.increment (element[, amount=1])</a></td>
|
||||
<td class="summary">Increases the value of the progressbar, if a define is given all of its instances are incremented</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar.decrement">ProgressBar.decrement (element[, amount=1])</a></td>
|
||||
<td class="summary">Decreases the value of the progressbar, if a define is given all of its instances are decresed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar.new_progressbar">ProgressBar.new_progressbar ([name])</a></td>
|
||||
<td class="summary">Creates a new progressbar element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:set_default_maximum">ProgressBar._prototype:set_default_maximum (amount)</a></td>
|
||||
<td class="summary">Sets the maximum value that represents the end value of the progress bar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:use_count_down">ProgressBar._prototype:use_count_down ([state=true])</a></td>
|
||||
<td class="summary">Will set the progress bar to start at 1 and trigger when it hits 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:increment">ProgressBar._prototype:increment ([amount=1[, category]])</a></td>
|
||||
<td class="summary">Increases the value of the progressbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:increment_filtered">ProgressBar._prototype:increment_filtered ([amount=1], filter)</a></td>
|
||||
<td class="summary">Increases the value of the progressbar, if the filter condition is met, does not work with store</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:decrement">ProgressBar._prototype:decrement ([amount=1[, category]])</a></td>
|
||||
<td class="summary">Decreases the value of the progressbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:decrement_filtered">ProgressBar._prototype:decrement_filtered ([amount=1], filter)</a></td>
|
||||
<td class="summary">Decreases the value of the progressbar, if the filter condition is met, does not work with store</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:add_element">ProgressBar._prototype:add_element (element[, maximum])</a></td>
|
||||
<td class="summary">Adds an element into the list of instances that will are waiting to complete, does not work with store
|
||||
note use store if you want persistent data, this only stores the elements not the values which they have</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:reset_element">ProgressBar._prototype:reset_element (element)</a></td>
|
||||
<td class="summary">Resets an element, or its store, to be back at the start, either 1 or 0</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:event_counter">ProgressBar._prototype:event_counter ([filter])</a></td>
|
||||
<td class="summary">Event handler factory that counts up by 1 every time the event triggeres, can filter which elements are incremented</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#ProgressBar._prototype:event_countdown">ProgressBar._prototype:event_countdown ([filter])</a></td>
|
||||
<td class="summary">Event handler factory that counts down by 1 every time the event triggeres, can filter which elements are decremented</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "ProgressBar.set_maximum"></a>
|
||||
<strong>ProgressBar.set_maximum (element, amount)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the maximum value that represents the end value of the progress bar
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span> or <a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
either a gui element or a registered define
|
||||
</li>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to have set as the maximum
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar.increment"></a>
|
||||
<strong>ProgressBar.increment (element[, amount=1])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Increases the value of the progressbar, if a define is given all of its instances are incremented
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span> or <a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
either a gui element or a registered define
|
||||
</li>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to increase the progressbar by
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar.decrement"></a>
|
||||
<strong>ProgressBar.decrement (element[, amount=1])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Decreases the value of the progressbar, if a define is given all of its instances are decresed
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span> or <a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
either a gui element or a registered define
|
||||
</li>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to decrease the progressbar by
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar.new_progressbar"></a>
|
||||
<strong>ProgressBar.new_progressbar ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new progressbar element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new progressbar elemente define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:set_default_maximum"></a>
|
||||
<strong>ProgressBar._prototype:set_default_maximum (amount)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the maximum value that represents the end value of the progress bar
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to have set as the maximum
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:use_count_down"></a>
|
||||
<strong>ProgressBar._prototype:use_count_down ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Will set the progress bar to start at 1 and trigger when it hits 0
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true the bar will start filled, to be used with decrease
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:increment"></a>
|
||||
<strong>ProgressBar._prototype:increment ([amount=1[, category]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Increases the value of the progressbar
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to increase the progressbar by
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
<li><span class="parameter">category</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the category that is used with a store
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:increment_filtered"></a>
|
||||
<strong>ProgressBar._prototype:increment_filtered ([amount=1], filter)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Increases the value of the progressbar, if the filter condition is met, does not work with store
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to increase the progressbar by
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
<li><span class="parameter">filter</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the filter to be used
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:decrement"></a>
|
||||
<strong>ProgressBar._prototype:decrement ([amount=1[, category]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Decreases the value of the progressbar
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to decrease the progressbar by
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
<li><span class="parameter">category</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the category that is used with a store
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:decrement_filtered"></a>
|
||||
<strong>ProgressBar._prototype:decrement_filtered ([amount=1], filter)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Decreases the value of the progressbar, if the filter condition is met, does not work with store
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">amount</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the amount to decrease the progressbar by
|
||||
(<em>default</em> 1)
|
||||
</li>
|
||||
<li><span class="parameter">filter</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the filter to be used
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:add_element"></a>
|
||||
<strong>ProgressBar._prototype:add_element (element[, maximum])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds an element into the list of instances that will are waiting to complete, does not work with store
|
||||
note use store if you want persistent data, this only stores the elements not the values which they have
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the element that you want to add into the waiting to complete list
|
||||
</li>
|
||||
<li><span class="parameter">maximum</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the maximum for this element if not given the default for this define is used
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:reset_element"></a>
|
||||
<strong>ProgressBar._prototype:reset_element (element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Resets an element, or its store, to be back at the start, either 1 or 0
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the element that you want to reset the progress of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:event_counter"></a>
|
||||
<strong>ProgressBar._prototype:event_counter ([filter])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Event handler factory that counts up by 1 every time the event triggeres, can filter which elements are incremented
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">filter</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
when given will use filtered incerement
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the event handler
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "ProgressBar._prototype:event_countdown"></a>
|
||||
<strong>ProgressBar._prototype:event_countdown ([filter])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Event handler factory that counts down by 1 every time the event triggeres, can filter which elements are decremented
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">filter</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
when given will use filtered decerement
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
the event handler
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
288
doc/modules/expcore.gui.slider.html
Normal file
288
doc/modules/expcore.gui.slider.html
Normal file
@@ -0,0 +1,288 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><strong>expcore.gui.slider</strong></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.slider</code></h1>
|
||||
<p>Gui class define for silders
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Slider.new_slider">Slider.new_slider ([name])</a></td>
|
||||
<td class="summary">Creates a new slider element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Slider._prototype:use_notches">Slider._prototype:use_notches ([state])</a></td>
|
||||
<td class="summary">Adds notches to the slider</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Slider._prototype:set_range">Slider._prototype:set_range ([min[, max]])</a></td>
|
||||
<td class="summary">Sets the range of a slider, if not used will use default values for a slider</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Slider._prototype:draw_label">Slider._prototype:draw_label (element)</a></td>
|
||||
<td class="summary">Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Slider._prototype:enable_auto_draw_label">Slider._prototype:enable_auto_draw_label ([state=true])</a></td>
|
||||
<td class="summary">Enables auto draw of the label, the label will share the same parent element as the slider</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Slider.new_slider"></a>
|
||||
<strong>Slider.new_slider ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new slider element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new slider element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Slider._prototype:use_notches"></a>
|
||||
<strong>Slider._prototype:use_notches ([state])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds notches to the slider
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true will draw notches onto the slider
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Slider._prototype:set_range"></a>
|
||||
<strong>Slider._prototype:set_range ([min[, max]])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the range of a slider, if not used will use default values for a slider
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">min</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the minimum value that the slider can take
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
<li><span class="parameter">max</span>
|
||||
<span class="types"><span class="type">number</span></span>
|
||||
the maximum value that the slider can take
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Slider._prototype:draw_label"></a>
|
||||
<strong>Slider._prototype:draw_label (element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Draws a new label and links its value to the value of this slider, if no store then it will only show one value per player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">element</span>
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the parent element that the lable will be drawn to
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">LuaGuiElement</span></span>
|
||||
the new label element so that styles can be applied
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Slider._prototype:enable_auto_draw_label"></a>
|
||||
<strong>Slider._prototype:enable_auto_draw_label ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Enables auto draw of the label, the label will share the same parent element as the slider
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when false will disable the auto draw of the label
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
the define to allow chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
120
doc/modules/expcore.gui.test.html
Normal file
120
doc/modules/expcore.gui.test.html
Normal file
@@ -0,0 +1,120 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><strong>expcore.gui.test</strong></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.test</code></h1>
|
||||
<p>This file creates a teste gui that is used to test every input method
|
||||
note that this does not cover every permutation only features in indepentance
|
||||
for example store in most cases is just by player name, but other store methods are tested with checkbox</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
290
doc/modules/expcore.gui.text.html
Normal file
290
doc/modules/expcore.gui.text.html
Normal file
@@ -0,0 +1,290 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><strong>expcore.gui.text</strong></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.text</code></h1>
|
||||
<p>Gui class define for text fields and text boxs
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Text.new_text_field">Text.new_text_field ([name])</a></td>
|
||||
<td class="summary">Creates a new text field element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Text.new_text_box">Text.new_text_box ([name])</a></td>
|
||||
<td class="summary">Creates a new text box element define</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Text._prototype_box:set_selectable">Text._prototype_box:set_selectable ([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to be selectable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Text._prototype_box:set_word_wrap">Text._prototype_box:set_word_wrap ([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to have word wrap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Text._prototype_box:set_read_only">Text._prototype_box:set_read_only ([state=true])</a></td>
|
||||
<td class="summary">Sets the text box to be read only</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Text.new_text_field"></a>
|
||||
<strong>Text.new_text_field ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new text field element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new text field element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Text.new_text_box"></a>
|
||||
<strong>Text.new_text_box ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a new text box element define
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the optional debug name that can be added
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the new text box element define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Text._prototype_box:set_selectable"></a>
|
||||
<strong>Text._prototype_box:set_selectable ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the text box to be selectable
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when false will set the state to false
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
table the define to allow for chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Text._prototype_box:set_word_wrap"></a>
|
||||
<strong>Text._prototype_box:set_word_wrap ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the text box to have word wrap
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when false will set the state to false
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
table the define to allow for chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Text._prototype_box:set_read_only"></a>
|
||||
<strong>Text._prototype_box:set_read_only ([state=true])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the text box to be read only
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">state</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when false will set the state to false
|
||||
(<em>default</em> true)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">self</span></span>
|
||||
table the define to allow for chaining
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
212
doc/modules/expcore.gui.toolbar.html
Normal file
212
doc/modules/expcore.gui.toolbar.html
Normal file
@@ -0,0 +1,212 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><strong>expcore.gui.toolbar</strong></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.gui.toolbar</code></h1>
|
||||
<p>Gui structure for the toolbar (top left)
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Toolbar.new_button">Toolbar.new_button ([name])</a></td>
|
||||
<td class="summary">Adds a new button to the toolbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Toolbar.add_button">Toolbar.add_button (button)</a></td>
|
||||
<td class="summary">Adds an existing buttton to the toolbar</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Toolbar.update">Toolbar.update (player)</a></td>
|
||||
<td class="summary">Updates the player's toolbar with an new buttons or expected change in auth return</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Toolbar.new_button"></a>
|
||||
<strong>Toolbar.new_button ([name])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a new button to the toolbar
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
when given allows an alias to the button for the permission system
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the button define
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Toolbar.add_button"></a>
|
||||
<strong>Toolbar.add_button (button)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds an existing buttton to the toolbar
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">button</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
the button define for the button to be added
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Toolbar.update"></a>
|
||||
<strong>Toolbar.update (player)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Updates the player's toolbar with an new buttons or expected change in auth return
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">player</span>
|
||||
<span class="types"><span class="type">LuaPlayer</span></span>
|
||||
the player to update the toolbar for
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
464
doc/modules/expcore.store.html
Normal file
464
doc/modules/expcore.store.html
Normal file
@@ -0,0 +1,464 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><strong>expcore.store</strong></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>expcore.store</code></h1>
|
||||
<p>Adds an easy way to store and watch for updates to a value
|
||||
[[</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.is_registered">Store.is_registered (location)</a></td>
|
||||
<td class="summary">Check for if a lcoation is registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.uid_location">Store.uid_location ()</a></td>
|
||||
<td class="summary">Returns a unqiue name that can be used for a store</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.register">Store.register (location, callback[, start_value])</a></td>
|
||||
<td class="summary">Registers a new location with an update callback which is triggered when the value updates</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.register_synced">Store.register_synced (location, callback[, start_value])</a></td>
|
||||
<td class="summary">Registers a new cross server synced location with an update callback, and external script is required for cross server</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.add_watch">Store.add_watch (location, callback)</a></td>
|
||||
<td class="summary">Adds a function that will be checked every tick for a change in the returned value, when the value changes it will be saved in the store</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.get">Store.get (location[, no_error=false])</a></td>
|
||||
<td class="summary">Gets the value stored at a location, this location must be registered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.set">Store.set (location, value)</a></td>
|
||||
<td class="summary">Sets the value at a location, this location must be registered, if server synced it will emit the change to file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.get_children">Store.get_children (location)</a></td>
|
||||
<td class="summary">Gets all non nil children at a location, children can be added and removed during runtime
|
||||
this is similar to Store.get but will always return a table even if it is empty</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.get_child">Store.get_child (location, child)</a></td>
|
||||
<td class="summary">Gets the value of the child to a location, children can be added and removed during runtime</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Store.set_child">Store.set_child (location, child, value)</a></td>
|
||||
<td class="summary">Sets the value of the chlid to a location, children can be added and removed during runtime
|
||||
when a child is set it will call the update handler of the parent allowing children be to added at runtime
|
||||
this may be used when a player joins the game and the child is the players name</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Store.is_registered"></a>
|
||||
<strong>Store.is_registered (location)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Check for if a lcoation is registered
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location to test for
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if registered
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.uid_location"></a>
|
||||
<strong>Store.uid_location ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a unqiue name that can be used for a store
|
||||
|
||||
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
a unqiue name
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.register"></a>
|
||||
<strong>Store.register (location, callback[, start_value])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers a new location with an update callback which is triggered when the value updates
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
string a unique that points to the data, string used rather than token to allow migration
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
this callback will be called when the stored value is set to a new value
|
||||
</li>
|
||||
<li><span class="parameter">start_value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
this value will be the inital value that is stored at this location
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.register_synced"></a>
|
||||
<strong>Store.register_synced (location, callback[, start_value])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers a new cross server synced location with an update callback, and external script is required for cross server
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
string a unique that points to the data, string used rather than token to allow migration
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
this callback will be called when the stored value is set to a new value
|
||||
</li>
|
||||
<li><span class="parameter">start_value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
this value will be the inital value that is stored at this location
|
||||
(<em>optional</em>)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.add_watch"></a>
|
||||
<strong>Store.add_watch (location, callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds a function that will be checked every tick for a change in the returned value, when the value changes it will be saved in the store
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location where the data will be saved and compeared to, must already be a registered location
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
<span class="types"><span class="type">function</span></span>
|
||||
this function will be called every tick to check for a change in value
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.get"></a>
|
||||
<strong>Store.get (location[, no_error=false])</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the value stored at a location, this location must be registered
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location to get the data from
|
||||
</li>
|
||||
<li><span class="parameter">no_error</span>
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
when true no error is returned if the location is not registered
|
||||
(<em>default</em> false)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the data which was stored at the location
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.set"></a>
|
||||
<strong>Store.set (location, value)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the value at a location, this location must be registered, if server synced it will emit the change to file
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location to set the data to
|
||||
</li>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the new value to set at the location, value may be reverted if there is a watch callback
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if it was successful
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.get_children"></a>
|
||||
<strong>Store.get_children (location)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets all non nil children at a location, children can be added and removed during runtime
|
||||
this is similar to Store.get but will always return a table even if it is empty
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location to get the children of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.5">table</a></span>
|
||||
a table containg all the children and they values
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.get_child"></a>
|
||||
<strong>Store.get_child (location, child)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Gets the value of the child to a location, children can be added and removed during runtime
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location of which the child is located
|
||||
</li>
|
||||
<li><span class="parameter">child</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the child element to get the value of
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the value which was stored at that location
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Store.set_child"></a>
|
||||
<strong>Store.set_child (location, child, value)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets the value of the chlid to a location, children can be added and removed during runtime
|
||||
when a child is set it will call the update handler of the parent allowing children be to added at runtime
|
||||
this may be used when a player joins the game and the child is the players name
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">location</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the location of which the child is located
|
||||
</li>
|
||||
<li><span class="parameter">child</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.2/manual.html#6.4">string</a></span>
|
||||
the child element to set the value of
|
||||
</li>
|
||||
<li><span class="parameter">value</span>
|
||||
<span class="types"><span class="type">any</span></span>
|
||||
the value to set at this location
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
true if it was successful
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/modules.addons.advanced-start.html
Normal file
118
doc/modules/modules.addons.advanced-start.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><strong>modules.addons.advanced-start</strong></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.addons.advanced-start</code></h1>
|
||||
<p>Adds a better method of player starting items based on production levels.</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
119
doc/modules/modules.addons.chat-popups.html
Normal file
119
doc/modules/modules.addons.chat-popups.html
Normal file
@@ -0,0 +1,119 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><strong>modules.addons.chat-popups</strong></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.addons.chat-popups</code></h1>
|
||||
<p>Creates flying text entities when a player sends a message in chat
|
||||
also displays a ping above users who are named in the message</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
119
doc/modules/modules.addons.damage-popups.html
Normal file
119
doc/modules/modules.addons.damage-popups.html
Normal file
@@ -0,0 +1,119 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><strong>modules.addons.damage-popups</strong></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.addons.damage-popups</code></h1>
|
||||
<p>Displays the amount of dmg that is done by players to entities
|
||||
also shows player health when a player is attacked</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/modules.gui.player-list.html
Normal file
118
doc/modules/modules.gui.player-list.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><strong>modules.gui.player-list</strong></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.gui.player-list</code></h1>
|
||||
<p>Gui left frame define for a player list</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/modules.gui.rocket-info.html
Normal file
118
doc/modules/modules.gui.rocket-info.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><strong>modules.gui.rocket-info</strong></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.gui.rocket-info</code></h1>
|
||||
<p>Adds a rocket infomation gui which shows general stats, milestones and build progress of rockets</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/modules.gui.science-info.html
Normal file
118
doc/modules/modules.gui.science-info.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><strong>modules.gui.science-info</strong></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.gui.science-info</code></h1>
|
||||
<p>Adds a science info gui that shows production usage and net for the different science packs as well as an eta</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
118
doc/modules/modules.gui.task-list.html
Normal file
118
doc/modules/modules.gui.task-list.html
Normal file
@@ -0,0 +1,118 @@
|
||||
<!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>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><strong>modules.gui.task-list</strong></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>modules.gui.task-list</code></h1>
|
||||
<p>Adds a task list to the game which players can add remove and edit items on</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
158
doc/modules/utils.alien_evolution_progress.html
Normal file
158
doc/modules/utils.alien_evolution_progress.html
Normal file
@@ -0,0 +1,158 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><strong>utils.alien_evolution_progress</strong></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.alien_evolution_progress</code></h1>
|
||||
<p>info
|
||||
Original (javascript) version: https://hastebin.com/udakacavap.js
|
||||
Can be tested against: https://wiki.factorio.com/Enemies#Spawn_chances_by_evolution_factor</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#AlienEvolutionProgress.create_spawner_request">AlienEvolutionProgress.create_spawner_request (total_aliens)</a></td>
|
||||
<td class="summary">Creates the spawner_request structure required for AlienEvolutionProgress.get_aliens for all
|
||||
available spawners.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "AlienEvolutionProgress.create_spawner_request"></a>
|
||||
<strong>AlienEvolutionProgress.create_spawner_request (total_aliens)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates the spawner_request structure required for AlienEvolutionProgress.get_aliens for all
|
||||
available spawners. If dividing the total spawners by the total aliens causes a fraction, the
|
||||
fraction will decide a chance to spawn. 1 alien for 2 spawners will have 50% on both.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">total_aliens</span>
|
||||
table
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
452
doc/modules/utils.core.html
Normal file
452
doc/modules/utils.core.html
Normal file
@@ -0,0 +1,452 @@
|
||||
<!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="#Fields">Fields</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><strong>utils.core</strong></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.core</code></h1>
|
||||
<p>Measures distance between pos1 and pos2</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.print_except">Module.print_except (msg, player, color)</a></td>
|
||||
<td class="summary">Takes msg and prints it to all players except provided player</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.print_admins">Module.print_admins (msg, source)</a></td>
|
||||
<td class="summary">Prints a message to all online admins</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.get_actor">Module.get_actor ()</a></td>
|
||||
<td class="summary">Returns a valid string with the name of the actor of a command.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.format_time">Module.format_time (ticks)</a></td>
|
||||
<td class="summary">Takes a time in ticks and returns a string with the time in format "x hour(s) x minute(s)"</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.cant_run">Module.cant_run (name)</a></td>
|
||||
<td class="summary">Prints a message letting the player know they cannot run a command</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.log_command">Module.log_command (actor, command, parameters)</a></td>
|
||||
<td class="summary">Logs the use of a command and its user</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.verify_mult_types">Module.verify_mult_types (arg, arg_types)</a></td>
|
||||
<td class="summary">Asserts the argument is one of type arg_types</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.random_RGB">Module.random_RGB ()</a></td>
|
||||
<td class="summary">Returns a random RGB color as a table</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.set_and_return">Module.set_and_return (tbl, key, value)</a></td>
|
||||
<td class="summary">Sets a table element to value while also returning value.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.move_position">Module.move_position</a></td>
|
||||
<td class="summary">Moves a position according to the parameters given
|
||||
Notice: only accepts cardinal directions as direction</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.opposite_direction">Module.opposite_direction</a></td>
|
||||
<td class="summary">Takes a direction and gives you the opposite</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.is_module_available">Module.is_module_available</a></td>
|
||||
<td class="summary">Takes the string of a module and returns whether is it available or not</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Module.print_except"></a>
|
||||
<strong>Module.print_except (msg, player, color)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Takes msg and prints it to all players except provided player
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">msg</span>
|
||||
<string|table> table if locale is used
|
||||
</li>
|
||||
<li><span class="parameter">player</span>
|
||||
<LuaPlayer> the player not to send the message to
|
||||
</li>
|
||||
<li><span class="parameter">color</span>
|
||||
<table> the color to use for the message, defaults to white
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.print_admins"></a>
|
||||
<strong>Module.print_admins (msg, source)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prints a message to all online admins
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">msg</span>
|
||||
<string|table> table if locale is used
|
||||
</li>
|
||||
<li><span class="parameter">source</span>
|
||||
<LuaPlayer|string|nil> string must be the name of a player, nil for server.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.get_actor"></a>
|
||||
<strong>Module.get_actor ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a valid string with the name of the actor of a command.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.format_time"></a>
|
||||
<strong>Module.format_time (ticks)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Takes a time in ticks and returns a string with the time in format "x hour(s) x minute(s)"
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">ticks</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.cant_run"></a>
|
||||
<strong>Module.cant_run (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Prints a message letting the player know they cannot run a command
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
string name of the command
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.log_command"></a>
|
||||
<strong>Module.log_command (actor, command, parameters)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Logs the use of a command and its user
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">actor</span>
|
||||
string with the actor's name (usually acquired by calling get_actor)
|
||||
</li>
|
||||
<li><span class="parameter">command</span>
|
||||
the command's name as table element
|
||||
</li>
|
||||
<li><span class="parameter">parameters</span>
|
||||
the command's parameters as a table (optional)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.verify_mult_types"></a>
|
||||
<strong>Module.verify_mult_types (arg, arg_types)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Asserts the argument is one of type arg_types
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">arg</span>
|
||||
the variable to check
|
||||
</li>
|
||||
<li><span class="parameter">arg_types</span>
|
||||
the type as a table of sings
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
boolean
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.random_RGB"></a>
|
||||
<strong>Module.random_RGB ()</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns a random RGB color as a table
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.set_and_return"></a>
|
||||
<strong>Module.set_and_return (tbl, key, value)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Sets a table element to value while also returning value.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
table to change the element of
|
||||
</li>
|
||||
<li><span class="parameter">key</span>
|
||||
string
|
||||
</li>
|
||||
<li><span class="parameter">value</span>
|
||||
nil|boolean|number|string|table to set the element to
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
value
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Fields"></a>Fields</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Module.move_position"></a>
|
||||
<strong>Module.move_position</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Moves a position according to the parameters given
|
||||
Notice: only accepts cardinal directions as direction
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">position</span>
|
||||
<table> table containing a map position
|
||||
</li>
|
||||
<li><span class="parameter">direction</span>
|
||||
<defines.direction> north, east, south, west
|
||||
</li>
|
||||
<li><span class="parameter">distance</span>
|
||||
<number>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.opposite_direction"></a>
|
||||
<strong>Module.opposite_direction</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Takes a direction and gives you the opposite
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">direction</span>
|
||||
<defines.direction> north, east, south, west, northeast, northwest, southeast, southwest
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.is_module_available"></a>
|
||||
<strong>Module.is_module_available</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Takes the string of a module and returns whether is it available or not
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<string> the name of the module (ex. 'utils.core')
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
306
doc/modules/utils.debug.html
Normal file
306
doc/modules/utils.debug.html
Normal file
@@ -0,0 +1,306 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><strong>utils.debug</strong></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.debug</code></h1>
|
||||
<p></p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Debug.print">Debug.print (message, stack_traceback)</a></td>
|
||||
<td class="summary">Shows the given message if debug is enabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Debug.get_meta_value">Debug.get_meta_value (object, key)</a></td>
|
||||
<td class="summary">Returns the value of the key inside the object
|
||||
or 'InvalidLuaObject' if the LuaObject is invalid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Debug.object_type">Debug.object_type (object)</a></td>
|
||||
<td class="summary">Returns the Lua data type or the factorio LuaObject type
|
||||
or 'NoHelpLuaObject' if the LuaObject does not have a help function
|
||||
or 'InvalidLuaObject' if the LuaObject is invalid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Debug.print_position">Debug.print_position (position, message)</a></td>
|
||||
<td class="summary">Shows the given message if debug is on.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Debug.cheat">Debug.cheat (callback)</a></td>
|
||||
<td class="summary">Executes the given callback if cheating is enabled.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Debug.is_closure">Debug.is_closure (func)</a></td>
|
||||
<td class="summary">Returns true if the function is a closure, false otherwise.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Debug.print"></a>
|
||||
<strong>Debug.print (message, stack_traceback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Shows the given message if debug is enabled. Uses serpent to print non scalars.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">message</span>
|
||||
<table|string|number|boolean>
|
||||
</li>
|
||||
<li><span class="parameter">stack_traceback</span>
|
||||
<number|nil> levels of stack trace to give, defaults to 1 level if nil
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Debug.get_meta_value"></a>
|
||||
<strong>Debug.get_meta_value (object, key)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the value of the key inside the object
|
||||
or 'InvalidLuaObject' if the LuaObject is invalid.
|
||||
or 'InvalidLuaObjectKey' if the LuaObject does not have an entry at that key
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">object</span>
|
||||
<table> LuaObject or metatable
|
||||
</li>
|
||||
<li><span class="parameter">key</span>
|
||||
<string>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<any>
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Debug.object_type"></a>
|
||||
<strong>Debug.object_type (object)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the Lua data type or the factorio LuaObject type
|
||||
or 'NoHelpLuaObject' if the LuaObject does not have a help function
|
||||
or 'InvalidLuaObject' if the LuaObject is invalid.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">object</span>
|
||||
<any>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
string
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Debug.print_position"></a>
|
||||
<strong>Debug.print_position (position, message)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Shows the given message if debug is on.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">position</span>
|
||||
Position
|
||||
</li>
|
||||
<li><span class="parameter">message</span>
|
||||
string
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Debug.cheat"></a>
|
||||
<strong>Debug.cheat (callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Executes the given callback if cheating is enabled.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">callback</span>
|
||||
function
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Debug.is_closure"></a>
|
||||
<strong>Debug.is_closure (func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns true if the function is a closure, false otherwise.
|
||||
A closure is a function that contains 'upvalues' or in other words
|
||||
has a reference to a local variable defined outside the function's scope.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
boolean
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
568
doc/modules/utils.event.html
Normal file
568
doc/modules/utils.event.html
Normal file
@@ -0,0 +1,568 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><strong>utils.event</strong></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.event</code></h1>
|
||||
<p>This Module allows for registering multiple handlers to the same event, overcoming the limitation of script.register.</p>
|
||||
<p>
|
||||
<p> ** Event.add(event_name, handler) **
|
||||
<p> Handlers added with Event.add must be added at the control stage or in Event.on_init or Event.on_load.
|
||||
Remember that for each player, on_init or on_load is run, never both. So if you can't add the handler in the
|
||||
control stage add the handler in both on_init and on_load.
|
||||
Handlers added with Event.add cannot be removed.
|
||||
For handlers that need to be removed or added at runtime use Event.add_removable.</p>
|
||||
<h3>Usage:</h3>
|
||||
<ul>
|
||||
<li><pre class="example">
|
||||
local Event = require 'utils.event'
|
||||
Event.add(
|
||||
defines.events.on_built_entity,
|
||||
function(event)
|
||||
game.print(serpent.block(event)) -- prints the content of the event table to console.
|
||||
end
|
||||
)
|
||||
|
||||
** Event.add_removable(event_name, token) **
|
||||
|
||||
For conditional event handlers. Event.add_removable can be safely called at runtime without desync risk.
|
||||
Only use this if you need to add the handler at runtime or need to remove the handler, otherwise use Event.add
|
||||
|
||||
Event.add_removable can be safely used at the control stage or in Event.on_init. If used in on_init you don't
|
||||
need to also add in on_load (unlike Event.add).
|
||||
Event.add_removable cannot be called in on_load, doing so will crash the game on loading.
|
||||
Token is used because it's a desync risk to store closures inside the global table.
|
||||
</pre></li>
|
||||
<li><pre class="example">
|
||||
local Token = require 'utils.token'
|
||||
local Event = require 'utils.event'
|
||||
|
||||
Token.register must not be called inside an event handler.
|
||||
local handler =
|
||||
Token.register(
|
||||
function(event)
|
||||
game.print(serpent.block(event)) -- prints the content of the event table to console.
|
||||
end
|
||||
)
|
||||
|
||||
The below code would typically be inside another event or a custom command.
|
||||
Event.add_removable(defines.events.on_built_entity, handler)
|
||||
|
||||
When you no longer need the handler.
|
||||
Event.remove_removable(defines.events.on_built_entity, handler)
|
||||
|
||||
It's not an error to register the same token multiple times to the same event, however when
|
||||
removing only the first occurrence is removed.
|
||||
|
||||
** Event.add_removable_function(event_name, func) **
|
||||
|
||||
Only use this function if you can't use Event.add_removable. i.e you are registering the handler at the console.
|
||||
The same restrictions that apply to Event.add_removable also apply to Event.add_removable_function.
|
||||
func cannot be a closure in this case, as there is no safe way to store closures in the global table.
|
||||
A closure is a function that uses a local variable not defined in the function.
|
||||
</pre></li>
|
||||
<li><pre class="example">
|
||||
local Event = require 'utils.event'
|
||||
|
||||
If you want to remove the handler you will need to keep a reference to it.
|
||||
global.handler = function(event)
|
||||
game.print(serpent.block(event)) -- prints the content of the event table to console.
|
||||
end
|
||||
|
||||
The below code would typically be used at the command console.
|
||||
Event.add_removable_function(defines.events.on_built_entity, global.handler)
|
||||
|
||||
When you no longer need the handler.
|
||||
Event.remove_removable_function(defines.events.on_built_entity, global.handler)
|
||||
|
||||
** Other Events **
|
||||
|
||||
Use Event.on_init(handler) for script.on_init(handler)
|
||||
Use Event.on_load(handler) for script.on_load(handler)
|
||||
|
||||
Use Event.on_nth_tick(tick, handler) for script.on_nth_tick(tick, handler)
|
||||
Favour this event over Event.add(defines.events.on_tick, handler)
|
||||
There are also Event.add_removable_nth_tick(tick, token) and Event.add_removable_nth_tick_function(tick, func)
|
||||
That work the same as above.
|
||||
|
||||
** Custom Scenario Events **
|
||||
|
||||
local Event = require 'utils.event'
|
||||
|
||||
local event_id = script.generate_event_name()
|
||||
|
||||
Event.add(
|
||||
event_id,
|
||||
function(event)
|
||||
game.print(serpent.block(event)) -- prints the content of the event table to console.
|
||||
end
|
||||
)
|
||||
|
||||
The table contains extra information that you want to pass to the handler.
|
||||
script.raise_event(event_id, {extra = 'data'})</pre></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.add">Event.add (event_name, handler)</a></td>
|
||||
<td class="summary">Register a handler for the event_name event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.on_init">Event.on_init (handler)</a></td>
|
||||
<td class="summary">Register a handler for the script.on_init event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.on_load">Event.on_load (handler)</a></td>
|
||||
<td class="summary">Register a handler for the script.on_load event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.on_nth_tick">Event.on_nth_tick (tick, handler)</a></td>
|
||||
<td class="summary">Register a handler for the nth_tick event.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.add_removable">Event.add_removable (event_name, token)</a></td>
|
||||
<td class="summary">Register a token handler that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.remove_removable">Event.remove_removable (event_name, token)</a></td>
|
||||
<td class="summary">Removes a token handler for the given event_name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.add_removable_function">Event.add_removable_function (event_name, func)</a></td>
|
||||
<td class="summary">Register a handler that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.remove_removable_function">Event.remove_removable_function (event_name, func)</a></td>
|
||||
<td class="summary">Removes a handler for the given event_name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.add_removable_nth_tick">Event.add_removable_nth_tick (tick, token)</a></td>
|
||||
<td class="summary">Register a token handler for the nth tick that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.remove_removable_nth_tick">Event.remove_removable_nth_tick (tick, token)</a></td>
|
||||
<td class="summary">Removes a token handler for the nth tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.add_removable_nth_tick_function">Event.add_removable_nth_tick_function (tick, func)</a></td>
|
||||
<td class="summary">Register a handler for the nth tick that can be safely added and removed at runtime.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Event.remove_removable_nth_tick_function">Event.remove_removable_nth_tick_function (tick, func)</a></td>
|
||||
<td class="summary">Removes a handler for the nth tick.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Event.add"></a>
|
||||
<strong>Event.add (event_name, handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler for the event_name event.
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event_name</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">handler</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.on_init"></a>
|
||||
<strong>Event.on_init (handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler for the script.on_init event.
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">handler</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.on_load"></a>
|
||||
<strong>Event.on_load (handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler for the script.on_load event.
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">handler</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.on_nth_tick"></a>
|
||||
<strong>Event.on_nth_tick (tick, handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler for the nth_tick event.
|
||||
This function must be called in the control stage or in Event.on_init or Event.on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
<number> The handler will be called every nth tick
|
||||
</li>
|
||||
<li><span class="parameter">handler</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.add_removable"></a>
|
||||
<strong>Event.add_removable (event_name, token)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a token handler that can be safely added and removed at runtime.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event_name</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">token</span>
|
||||
<number>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.remove_removable"></a>
|
||||
<strong>Event.remove_removable (event_name, token)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes a token handler for the given event_name.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event_name</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">token</span>
|
||||
<number>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.add_removable_function"></a>
|
||||
<strong>Event.add_removable_function (event_name, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler that can be safely added and removed at runtime.
|
||||
The handler must not be a closure, as that is a desync risk.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event_name</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.remove_removable_function"></a>
|
||||
<strong>Event.remove_removable_function (event_name, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes a handler for the given event_name.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">event_name</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.add_removable_nth_tick"></a>
|
||||
<strong>Event.add_removable_nth_tick (tick, token)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a token handler for the nth tick that can be safely added and removed at runtime.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">token</span>
|
||||
<number>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.remove_removable_nth_tick"></a>
|
||||
<strong>Event.remove_removable_nth_tick (tick, token)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes a token handler for the nth tick.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">token</span>
|
||||
<number>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.add_removable_nth_tick_function"></a>
|
||||
<strong>Event.add_removable_nth_tick_function (tick, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler for the nth tick that can be safely added and removed at runtime.
|
||||
The handler must not be a closure, as that is a desync risk.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
<function>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Event.remove_removable_nth_tick_function"></a>
|
||||
<strong>Event.remove_removable_nth_tick_function (tick, func)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes a handler for the nth tick.
|
||||
Do NOT call this method during on_load.
|
||||
See documentation at top of file for details on using events.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">func</span>
|
||||
<function>
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
204
doc/modules/utils.event_core.html
Normal file
204
doc/modules/utils.event_core.html
Normal file
@@ -0,0 +1,204 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><strong>utils.event_core</strong></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.event_core</code></h1>
|
||||
<p>Do not use this function, use Event.add instead as it has safety checks.</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.on_init">Public.on_init (handler)</a></td>
|
||||
<td class="summary">Do not use this function, use Event.on_init instead as it has safety checks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.on_load">Public.on_load (handler)</a></td>
|
||||
<td class="summary">Do not use this function, use Event.on_load instead as it has safety checks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.on_nth_tick">Public.on_nth_tick (tick, handler)</a></td>
|
||||
<td class="summary">Do not use this function, use Event.on_nth_tick instead as it has safety checks.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Public.on_init"></a>
|
||||
<strong>Public.on_init (handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Do not use this function, use Event.on_init instead as it has safety checks.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">handler</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Public.on_load"></a>
|
||||
<strong>Public.on_load (handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Do not use this function, use Event.on_load instead as it has safety checks.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">handler</span>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Public.on_nth_tick"></a>
|
||||
<strong>Public.on_nth_tick (tick, handler)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Do not use this function, use Event.on_nth_tick instead as it has safety checks.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tick</span>
|
||||
|
||||
</li>
|
||||
<li><span class="parameter">handler</span>
|
||||
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
161
doc/modules/utils.math.html
Normal file
161
doc/modules/utils.math.html
Normal file
@@ -0,0 +1,161 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><strong>utils.math</strong></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.math</code></h1>
|
||||
<p>Takes two points and calculates the slope of a line</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#calculate_y_intercept">calculate_y_intercept (x, slope)</a></td>
|
||||
<td class="summary">Calculates the y-intercept of a line</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "calculate_y_intercept"></a>
|
||||
<strong>calculate_y_intercept (x, slope)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Calculates the y-intercept of a line
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">x</span>
|
||||
, y numbers - coordinates of point on line
|
||||
</li>
|
||||
<li><span class="parameter">slope</span>
|
||||
number - the slope of a line
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
number - the y-intercept of a line
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
155
doc/modules/utils.recipe_locker.html
Normal file
155
doc/modules/utils.recipe_locker.html
Normal file
@@ -0,0 +1,155 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><strong>utils.recipe_locker</strong></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.recipe_locker</code></h1>
|
||||
<p>Locks recipes, preventing them from being enabled by research.</p>
|
||||
<p>
|
||||
Does not check if they should be enabled/disabled by existing research.</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.unlock_recipes">Public.unlock_recipes (tbl)</a></td>
|
||||
<td class="summary">Unlocks recipes, allowing them to be enabled by research.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Public.unlock_recipes"></a>
|
||||
<strong>Public.unlock_recipes (tbl)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Unlocks recipes, allowing them to be enabled by research.
|
||||
Does not check if they should be enabled/disabled by existing research.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<table> an array of recipe strings
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
316
doc/modules/utils.state_machine.html
Normal file
316
doc/modules/utils.state_machine.html
Normal file
@@ -0,0 +1,316 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><strong>utils.state_machine</strong></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.state_machine</code></h1>
|
||||
<p>This module provides a classical mealy/moore state machine.</p>
|
||||
<p>
|
||||
Each machine in constructed by calling new()
|
||||
States and Transitions are lazily added to the machine as transition handlers and state tick handlers are registered.
|
||||
However the state machine must be fully defined after init is done. Dynamic machine changes are currently unsupported
|
||||
An example usage can be found here: map_gen\combined\tetris\control.lua</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.transition">Module.transition (self, new_state)</a></td>
|
||||
<td class="summary">Transitions the supplied machine into a given state and executes all transaction_callbacks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.in_state">Module.in_state (self, state)</a></td>
|
||||
<td class="summary">Is this machine in this state?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.machine_tick">Module.machine_tick (self)</a></td>
|
||||
<td class="summary">Invoke a machine tick.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.register_state_tick_callback">Module.register_state_tick_callback (self, state, callback)</a></td>
|
||||
<td class="summary">Register a handler that will be invoked by StateMachine.machine_tick
|
||||
You may register multiple handlers for the same transition
|
||||
NOTICE: This function will invoke an error if called after init.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.register_transition_callback">Module.register_transition_callback (self, state, state, callback)</a></td>
|
||||
<td class="summary">Register a handler that will be invoked by StateMachine.transition
|
||||
You may register multiple handlers for the same transition
|
||||
NOTICE: This function will invoke an error if called after init.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Module.new">Module.new (init_state)</a></td>
|
||||
<td class="summary">Constructs a new state machine</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Module.transition"></a>
|
||||
<strong>Module.transition (self, new_state)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Transitions the supplied machine into a given state and executes all transaction_callbacks
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
StateMachine
|
||||
</li>
|
||||
<li><span class="parameter">new_state</span>
|
||||
number/string The new state to transition to
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.in_state"></a>
|
||||
<strong>Module.in_state (self, state)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Is this machine in this state?
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
StateMachine
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
number/string
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
boolean
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.machine_tick"></a>
|
||||
<strong>Module.machine_tick (self)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Invoke a machine tick. Will execute all in_state_callbacks of the given machine
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
StateMachine the machine, whose handlers will be invoked
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.register_state_tick_callback"></a>
|
||||
<strong>Module.register_state_tick_callback (self, state, callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler that will be invoked by StateMachine.machine_tick
|
||||
You may register multiple handlers for the same transition
|
||||
NOTICE: This function will invoke an error if called after init. Dynamic machine changes are currently unsupported
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
StateMachine the machine
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
number/string The state, that the machine will be in, when callback is invoked
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
function
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.register_transition_callback"></a>
|
||||
<strong>Module.register_transition_callback (self, state, state, callback)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a handler that will be invoked by StateMachine.transition
|
||||
You may register multiple handlers for the same transition
|
||||
NOTICE: This function will invoke an error if called after init. Dynamic machine changes are currently unsupported
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">self</span>
|
||||
StateMachine the machine
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
number/string entering state
|
||||
</li>
|
||||
<li><span class="parameter">state</span>
|
||||
number/string entering state
|
||||
</li>
|
||||
<li><span class="parameter">callback</span>
|
||||
function
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Module.new"></a>
|
||||
<strong>Module.new (init_state)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Constructs a new state machine
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">init_state</span>
|
||||
number/string The starting state of the machine
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
StateMachine The constructed state machine object
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
583
doc/modules/utils.table.html
Normal file
583
doc/modules/utils.table.html
Normal file
@@ -0,0 +1,583 @@
|
||||
<!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="#Fields">Fields</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><strong>utils.table</strong></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.table</code></h1>
|
||||
<p>Searches a table to remove a specific element without an index</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#fast_remove">fast_remove (tbl, index)</a></td>
|
||||
<td class="summary">Removes an item from an array in O(1) time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#add_all">add_all (t1, t2)</a></td>
|
||||
<td class="summary">Adds the contents of table t2 to table t1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#index_of">index_of (t, e)</a></td>
|
||||
<td class="summary">Checks if a table contains an element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#index_of_in_array">index_of_in_array (t, e)</a></td>
|
||||
<td class="summary">Checks if the arrayed portion of a table contains an element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#contains">contains (t, e)</a></td>
|
||||
<td class="summary">Checks if a table contains an element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#array_contains">array_contains (t, e)</a></td>
|
||||
<td class="summary">Checks if the arrayed portion of a table contains an element</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#set">set (t, index, element)</a></td>
|
||||
<td class="summary">Adds an element into a specific index position while shuffling the rest down</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_random_dictionary_entry">get_random_dictionary_entry (t, key)</a></td>
|
||||
<td class="summary">Chooses a random entry from a table
|
||||
because this uses math.random, it cannot be used outside of events</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get_random_weighted">get_random_weighted (weight_table, item_index, weight_index)</a></td>
|
||||
<td class="summary">Chooses a random entry from a weighted table
|
||||
because this uses math.random, it cannot be used outside of events</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#shuffle_table">shuffle_table (t)</a></td>
|
||||
<td class="summary">Creates a fisher-yates shuffle of a sequential number-indexed table
|
||||
because this uses math.random, it cannot be used outside of events if no rng is supplied
|
||||
from: http://www.sdknews.com/cross-platform/corona/tutorial-how-to-shuffle-table-items</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#clear_table">clear_table (t, array)</a></td>
|
||||
<td class="summary">Clears all existing entries in a table</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Fields">Fields</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#inspect">inspect</a></td>
|
||||
<td class="summary">Similar to serpent.block, returns a string with a pretty representation of a table.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#size">size</a></td>
|
||||
<td class="summary">Takes a table and returns the number of entries in the table.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#deep_copy">deep_copy</a></td>
|
||||
<td class="summary">Creates a deepcopy of a table.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#merge">merge</a></td>
|
||||
<td class="summary">Merges multiple tables.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#equals">equals</a></td>
|
||||
<td class="summary">Determines if two tables are structurally equal.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "fast_remove"></a>
|
||||
<strong>fast_remove (tbl, index)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Removes an item from an array in O(1) time.
|
||||
The catch is that fast_remove doesn't guarantee to maintain the order of items in the array.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">tbl</span>
|
||||
<table> arrayed table
|
||||
</li>
|
||||
<li><span class="parameter">index</span>
|
||||
<number> Must be >= 0. The case where index > #tbl is handled.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "add_all"></a>
|
||||
<strong>add_all (t1, t2)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds the contents of table t2 to table t1
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t1</span>
|
||||
<table> to insert into
|
||||
</li>
|
||||
<li><span class="parameter">t2</span>
|
||||
<table> to insert from
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "index_of"></a>
|
||||
<strong>index_of (t, e)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks if a table contains an element
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table>
|
||||
</li>
|
||||
<li><span class="parameter">e</span>
|
||||
<any> table element
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "index_of_in_array"></a>
|
||||
<strong>index_of_in_array (t, e)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks if the arrayed portion of a table contains an element
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table>
|
||||
</li>
|
||||
<li><span class="parameter">e</span>
|
||||
<any> table element
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "contains"></a>
|
||||
<strong>contains (t, e)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks if a table contains an element
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table>
|
||||
</li>
|
||||
<li><span class="parameter">e</span>
|
||||
<any> table element
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "array_contains"></a>
|
||||
<strong>array_contains (t, e)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Checks if the arrayed portion of a table contains an element
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table>
|
||||
</li>
|
||||
<li><span class="parameter">e</span>
|
||||
<any> table element
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "set"></a>
|
||||
<strong>set (t, index, element)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Adds an element into a specific index position while shuffling the rest down
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table> to add into
|
||||
</li>
|
||||
<li><span class="parameter">index</span>
|
||||
<number> the position in the table to add to
|
||||
</li>
|
||||
<li><span class="parameter">element</span>
|
||||
<any> to add to the table
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "get_random_dictionary_entry"></a>
|
||||
<strong>get_random_dictionary_entry (t, key)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Chooses a random entry from a table
|
||||
because this uses math.random, it cannot be used outside of events
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table>
|
||||
</li>
|
||||
<li><span class="parameter">key</span>
|
||||
<boolean> to indicate whether to return the key or value
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<any> a random element of table t
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "get_random_weighted"></a>
|
||||
<strong>get_random_weighted (weight_table, item_index, weight_index)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Chooses a random entry from a weighted table
|
||||
because this uses math.random, it cannot be used outside of events
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">weight_table</span>
|
||||
<table> of tables with items and their weights
|
||||
</li>
|
||||
<li><span class="parameter">item_index</span>
|
||||
<number> of the index of items, defaults to 1
|
||||
</li>
|
||||
<li><span class="parameter">weight_index</span>
|
||||
<number> of the index of the weights, defaults to 2
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<any> table element
|
||||
</ol>
|
||||
|
||||
|
||||
<h3>See also:</h3>
|
||||
<ul>
|
||||
</ul>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "shuffle_table"></a>
|
||||
<strong>shuffle_table (t)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a fisher-yates shuffle of a sequential number-indexed table
|
||||
because this uses math.random, it cannot be used outside of events if no rng is supplied
|
||||
from: http://www.sdknews.com/cross-platform/corona/tutorial-how-to-shuffle-table-items
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table> to shuffle
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "clear_table"></a>
|
||||
<strong>clear_table (t, array)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Clears all existing entries in a table
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">t</span>
|
||||
<table> to clear
|
||||
</li>
|
||||
<li><span class="parameter">array</span>
|
||||
<boolean> to indicate whether the table is an array or not
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2><a name="Fields"></a>Fields</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "inspect"></a>
|
||||
<strong>inspect</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Similar to serpent.block, returns a string with a pretty representation of a table.
|
||||
Notice: This method is not appropriate for saving/restoring tables. It is meant to be used by the programmer mainly while debugging a program.
|
||||
depth sets the maximum depth that will be printed out. When the max depth is reached, inspect will stop parsing tables and just return {...}
|
||||
process is a function which allow altering the passed object before transforming it into a string.
|
||||
A typical way to use it would be to remove certain values so that they don't appear at all.
|
||||
return <string> the prettied table
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">table</span>
|
||||
<table> the table to serialize
|
||||
</li>
|
||||
<li><span class="parameter">options</span>
|
||||
<table> options are depth, newline, indent, process
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "size"></a>
|
||||
<strong>size</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Takes a table and returns the number of entries in the table. (Slower than #table, faster than iterating via pairs)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "deep_copy"></a>
|
||||
<strong>deep_copy</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Creates a deepcopy of a table. Metatables and LuaObjects inside the table are shallow copies.
|
||||
Shallow copies meaning it copies the reference to the object instead of the object itself.
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">object</span>
|
||||
<table> the object to copy
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "merge"></a>
|
||||
<strong>merge</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Merges multiple tables. Tables later in the list will overwrite entries from tables earlier in the list.
|
||||
Ex. merge({{1, 2, 3}, {[2] = 0}, {[3] = 0}}) will return {1, 0, 0}
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">tables</span>
|
||||
<table> takes a table of tables to merge
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "equals"></a>
|
||||
<strong>equals</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Determines if two tables are structurally equal.
|
||||
Notice: tables that are LuaObjects or contain LuaObjects won't be compared correctly, use == operator for LuaObjects
|
||||
|
||||
|
||||
<ul>
|
||||
<li><span class="parameter">tbl1</span>
|
||||
<table>
|
||||
</li>
|
||||
<li><span class="parameter">tbl2</span>
|
||||
<table>
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
195
doc/modules/utils.task.html
Normal file
195
doc/modules/utils.task.html
Normal file
@@ -0,0 +1,195 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><strong>utils.task</strong></li>
|
||||
<li><a href="../modules/utils.timestamp.html">utils.timestamp</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.task</code></h1>
|
||||
<p>Allows you to set a timer (in ticks) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Task.set_timeout">Task.set_timeout (sec, func_token, params)</a></td>
|
||||
<td class="summary">Allows you to set a timer (in seconds) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Task.queue_task">Task.queue_task (func_token, params, weight)</a></td>
|
||||
<td class="summary">Queueing allows you to split up heavy tasks which don't need to be completed in the same tick.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Task.set_timeout"></a>
|
||||
<strong>Task.set_timeout (sec, func_token, params)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Allows you to set a timer (in seconds) after which the tokened function will be run with params given as an argument
|
||||
Cannot be called before init
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">sec</span>
|
||||
<number>
|
||||
</li>
|
||||
<li><span class="parameter">func_token</span>
|
||||
<number> a token for a function store via the token system
|
||||
</li>
|
||||
<li><span class="parameter">params</span>
|
||||
<any> the argument to send to the tokened function
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Task.queue_task"></a>
|
||||
<strong>Task.queue_task (func_token, params, weight)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Queueing allows you to split up heavy tasks which don't need to be completed in the same tick.
|
||||
Queued tasks are generally run 1 per tick. If the queue backs up, more tasks will be processed per tick.
|
||||
Ex. if the task is expected to repeat multiple times (ie. the function returns true and loops several ticks)
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">func_token</span>
|
||||
<number> a token for a function stored via the token system
|
||||
If this function returns `true` it will run again the next tick, delaying other queued tasks (see weight)
|
||||
</li>
|
||||
<li><span class="parameter">params</span>
|
||||
<any> the argument to send to the tokened function
|
||||
</li>
|
||||
<li><span class="parameter">weight</span>
|
||||
<number> (defaults to 1) weight is the number of ticks a task is expected to take.
|
||||
</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.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
217
doc/modules/utils.timestamp.html
Normal file
217
doc/modules/utils.timestamp.html
Normal file
@@ -0,0 +1,217 @@
|
||||
<!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="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../modules/config._file_loader.html">config._file_loader</a></li>
|
||||
<li><a href="../modules/config.action_buttons.html">config.action_buttons</a></li>
|
||||
<li><a href="../modules/config.advanced_start.html">config.advanced_start</a></li>
|
||||
<li><a href="../modules/config.death_logger.html">config.death_logger</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_admin.html">config.expcore-commands.auth_admin</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_roles.html">config.expcore-commands.auth_roles</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.auth_runtime_disable.html">config.expcore-commands.auth_runtime_disable</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_general.html">config.expcore-commands.parse_general</a></li>
|
||||
<li><a href="../modules/config.expcore-commands.parse_roles.html">config.expcore-commands.parse_roles</a></li>
|
||||
<li><a href="../modules/config.permission_groups.html">config.permission_groups</a></li>
|
||||
<li><a href="../modules/config.popup_messages.html">config.popup_messages</a></li>
|
||||
<li><a href="../modules/config.rockets.html">config.rockets</a></li>
|
||||
<li><a href="../modules/config.roles.html">config.roles</a></li>
|
||||
<li><a href="../modules/config.scorched_earth.html">config.scorched_earth</a></li>
|
||||
<li><a href="../modules/config.spawn_area.html">config.spawn_area</a></li>
|
||||
<li><a href="../modules/config.warnings.html">config.warnings</a></li>
|
||||
<li><a href="../modules/control.html">control</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/Public.html">Public</a></li>
|
||||
<li><a href="../modules/expcore.gui.html">expcore.gui</a></li>
|
||||
<li><a href="../modules/expcore.gui.buttons.html">expcore.gui.buttons</a></li>
|
||||
<li><a href="../modules/expcore.gui.center.html">expcore.gui.center</a></li>
|
||||
<li><a href="../modules/expcore.gui.checkboxs.html">expcore.gui.checkboxs</a></li>
|
||||
<li><a href="../modules/expcore.gui.core.html">expcore.gui.core</a></li>
|
||||
<li><a href="../modules/expcore.gui.dropdown.html">expcore.gui.dropdown</a></li>
|
||||
<li><a href="../modules/expcore.gui.elem-button.html">expcore.gui.elem-button</a></li>
|
||||
<li><a href="../modules/expcore.gui.instances.html">expcore.gui.instances</a></li>
|
||||
<li><a href="../modules/expcore.gui.left.html">expcore.gui.left</a></li>
|
||||
<li><a href="../modules/expcore.gui.popups.html">expcore.gui.popups</a></li>
|
||||
<li><a href="../modules/expcore.gui.progress-bar.html">expcore.gui.progress-bar</a></li>
|
||||
<li><a href="../modules/expcore.gui.slider.html">expcore.gui.slider</a></li>
|
||||
<li><a href="../modules/expcore.gui.test.html">expcore.gui.test</a></li>
|
||||
<li><a href="../modules/expcore.gui.text.html">expcore.gui.text</a></li>
|
||||
<li><a href="../modules/expcore.gui.toolbar.html">expcore.gui.toolbar</a></li>
|
||||
<li><a href="../modules/Permissions_Groups.html">Permissions_Groups</a></li>
|
||||
<li><a href="../modules/Commands.html">Commands</a></li>
|
||||
<li><a href="../modules/expcore.store.html">expcore.store</a></li>
|
||||
<li><a href="../modules/modules.addons.advanced-start.html">modules.addons.advanced-start</a></li>
|
||||
<li><a href="../modules/modules.addons.chat-popups.html">modules.addons.chat-popups</a></li>
|
||||
<li><a href="../modules/modules.addons.damage-popups.html">modules.addons.damage-popups</a></li>
|
||||
<li><a href="../modules/modules.gui.player-list.html">modules.gui.player-list</a></li>
|
||||
<li><a href="../modules/modules.gui.rocket-info.html">modules.gui.rocket-info</a></li>
|
||||
<li><a href="../modules/modules.gui.science-info.html">modules.gui.science-info</a></li>
|
||||
<li><a href="../modules/modules.gui.task-list.html">modules.gui.task-list</a></li>
|
||||
<li><a href="../modules/utils.alien_evolution_progress.html">utils.alien_evolution_progress</a></li>
|
||||
<li><a href="../modules/utils.core.html">utils.core</a></li>
|
||||
<li><a href="../modules/utils.debug.html">utils.debug</a></li>
|
||||
<li><a href="../modules/utils.event.html">utils.event</a></li>
|
||||
<li><a href="../modules/utils.event_core.html">utils.event_core</a></li>
|
||||
<li><a href="../modules/utils.math.html">utils.math</a></li>
|
||||
<li><a href="../modules/utils.recipe_locker.html">utils.recipe_locker</a></li>
|
||||
<li><a href="../modules/utils.state_machine.html">utils.state_machine</a></li>
|
||||
<li><a href="../modules/utils.table.html">utils.table</a></li>
|
||||
<li><a href="../modules/utils.task.html">utils.task</a></li>
|
||||
<li><strong>utils.timestamp</strong></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>utils.timestamp</code></h1>
|
||||
<p>source https://github.com/daurnimator/luatz/blob/master/luatz/timetable.lua
|
||||
edited down to just what is needed.</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.to_timetable">Public.to_timetable (sec)</a></td>
|
||||
<td class="summary">Converts unix epoch timestamp into table {year: number, month: number, day: number, hour: number, min: number, sec: number}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.from_timetable">Public.from_timetable (timetable)</a></td>
|
||||
<td class="summary">Converts timetable into unix epoch timestamp</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Public.to_string">Public.to_string (secs)</a></td>
|
||||
<td class="summary">Converts unix epoch timestamp into human readable string.</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
|
||||
<h2><a name="Functions"></a>Functions</h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Public.to_timetable"></a>
|
||||
<strong>Public.to_timetable (sec)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts unix epoch timestamp into table {year: number, month: number, day: number, hour: number, min: number, sec: number}
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">sec</span>
|
||||
<number> unix epoch timestamp
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
{year: number, month: number, day: number, hour: number, min: number, sec: number}
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Public.from_timetable"></a>
|
||||
<strong>Public.from_timetable (timetable)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts timetable into unix epoch timestamp
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">timetable</span>
|
||||
<table> {year: number, month: number, day: number, hour: number, min: number, sec: number}
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
number
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "Public.to_string"></a>
|
||||
<strong>Public.to_string (secs)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Converts unix epoch timestamp into human readable string.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">secs</span>
|
||||
<type> unix epoch timestamp
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
string
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</div> <!-- id="content" -->
|
||||
</div> <!-- id="main" -->
|
||||
<div id="about">
|
||||
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
|
||||
<i style="float:right;">Last updated 2019-05-29 22:22:59 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user