mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2025-12-27 11:35:22 +09:00
Ldoc compliant
This commit is contained in:
Cooldude2606
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>
|
||||
Reference in New Issue
Block a user