aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-27 19:45:22 +09:00
Code Issues Packages Projects Releases Wiki Activity
Files
f5619165f6f7290289e81577413e39c8a6ed73e0
factorio-scenario-ExpCluster/doc/modules/utils.table.html
Cooldude2606 f5619165f6 Added production to control
2019-07-20 23:44:48 +01:00

1291 lines
36 KiB
HTML
Raw Blame History

<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>utils.table module</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../spectre.min.css" type="text/css" />
<link rel="stylesheet" href="../spectre-icons.min.css" type="text/css" />
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div class="container grid-1280">
<div class="columns">
<!-- sidebar start -->
<div id="sidebar" class="column col-3 col-sm-12">
<div class="sidebar-custom">
<div class="project-infobox">
<!-- project title -->
<a href="../index.html"><h1>ExpGaming Scenario</h1></a>
<!-- project description -->
<p class="project-desc">Explosive Gaming's server scenario for 0.17</p>
<!-- project full description -->
</div>
<!-- sidebar navigation -->
<!-- list of items in a module -->
<ul class="nav nav-module-contents">
<li class="nav-item">
<h2>Sections</h2>
<ul class="nav">
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
</ul>
</li>
</ul>
<ul class="nav nav-modules">
<li class="nav-item">
<h2>Modules</h2>
<ul class="nav">
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config._file_loader.html"><span class="module-name-item">config._file_loader</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.action_buttons.html"><span class="module-name-item">config.action_buttons</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.advanced_start.html"><span class="module-name-item">config.advanced_start</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.bonuses.html"><span class="module-name-item">config.bonuses</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.chat_reply.html"><span class="module-name-item">config.chat_reply</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.death_logger.html"><span class="module-name-item">config.death_logger</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.discord_alerts.html"><span class="module-name-item">config.discord_alerts</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.expcore-commands.auth_admin.html"><span class="module-name-item">config.expcore-commands.auth_admin</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.expcore-commands.auth_roles.html"><span class="module-name-item">config.expcore-commands.auth_roles</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.expcore-commands.auth_runtime_disable.html"><span class="module-name-item">config.expcore-commands.auth_runtime_disable</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.expcore-commands.parse_general.html"><span class="module-name-item">config.expcore-commands.parse_general</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.expcore-commands.parse_roles.html"><span class="module-name-item">config.expcore-commands.parse_roles</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.permission_groups.html"><span class="module-name-item">config.permission_groups</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.popup_messages.html"><span class="module-name-item">config.popup_messages</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.rockets.html"><span class="module-name-item">config.rockets</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.roles.html"><span class="module-name-item">config.roles</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.scorched_earth.html"><span class="module-name-item">config.scorched_earth</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.spawn_area.html"><span class="module-name-item">config.spawn_area</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.warnings.html"><span class="module-name-item">config.warnings</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/config.warps.html"><span class="module-name-item">config.warps</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/control.html"><span class="module-name-item">control</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.commands.html"><span class="module-name-item">expcore.commands</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.common.html"><span class="module-name-item">expcore.common</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.html"><span class="module-name-item">expcore.gui</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.concepts.center.html"><span class="module-name-item">expcore.gui.concepts.center</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.concepts.left.html"><span class="module-name-item">expcore.gui.concepts.left</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.concepts.popups.html"><span class="module-name-item">expcore.gui.concepts.popups</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.concepts.toolbar.html"><span class="module-name-item">expcore.gui.concepts.toolbar</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.core.html"><span class="module-name-item">expcore.gui.core</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.buttons.html"><span class="module-name-item">expcore.gui.elements.buttons</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.checkboxs.html"><span class="module-name-item">expcore.gui.elements.checkboxs</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.dropdown.html"><span class="module-name-item">expcore.gui.elements.dropdown</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.elem-button.html"><span class="module-name-item">expcore.gui.elements.elem-button</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.progress-bar.html"><span class="module-name-item">expcore.gui.elements.progress-bar</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.slider.html"><span class="module-name-item">expcore.gui.elements.slider</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.elements.text.html"><span class="module-name-item">expcore.gui.elements.text</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.instances.html"><span class="module-name-item">expcore.gui.instances</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.prototype.html"><span class="module-name-item">expcore.gui.prototype</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.gui.test.html"><span class="module-name-item">expcore.gui.test</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.permission_groups.html"><span class="module-name-item">expcore.permission_groups</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.roles.html"><span class="module-name-item">expcore.roles</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.store.html"><span class="module-name-item">expcore.store</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/expcore.sudo.html"><span class="module-name-item">expcore.sudo</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.advanced-start.html"><span class="module-name-item">modules.addons.advanced-start</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.chat-popups.html"><span class="module-name-item">modules.addons.chat-popups</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.addons.damage-popups.html"><span class="module-name-item">modules.addons.damage-popups</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.player-list.html"><span class="module-name-item">modules.gui.player-list</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.rocket-info.html"><span class="module-name-item">modules.gui.rocket-info</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.science-info.html"><span class="module-name-item">modules.gui.science-info</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/modules.gui.task-list.html"><span class="module-name-item">modules.gui.task-list</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.alien_evolution_progress.html"><span class="module-name-item">utils.alien_evolution_progress</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.core.html"><span class="module-name-item">utils.core</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.debug.html"><span class="module-name-item">utils.debug</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.event.html"><span class="module-name-item">utils.event</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.event_core.html"><span class="module-name-item">utils.event_core</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.math.html"><span class="module-name-item">utils.math</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.recipe_locker.html"><span class="module-name-item">utils.recipe_locker</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.state_machine.html"><span class="module-name-item">utils.state_machine</span></a></div></li>
<li class="nav-item active"><div class="nav-item-block-active block"><a href="../modules/utils.table.html"><span class="module-name-item">utils.table</span></a><i class="icon icon-arrow-left icon-arrow-left-custom"></i></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.task.html"><span class="module-name-item">utils.task</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../modules/utils.timestamp.html"><span class="module-name-item">utils.timestamp</span></a></div></li>
</ul>
</li>
</ul>
<ul class="nav nav-modules">
<li class="nav-item">
<h2>Control</h2>
<ul class="nav">
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Jail.html"><span class="module-name-item">Jail</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Production.html"><span class="module-name-item">Production</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Reports.html"><span class="module-name-item">Reports</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../control/Warnings.html"><span class="module-name-item">Warnings</span></a></div></li>
</ul>
</li>
</ul>
<ul class="nav nav-modules">
<li class="nav-item">
<h2>Topics</h2>
<ul class="nav">
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/readme.md.html"><span class="module-name-item">readme.md</span></a></div></li>
<li class="nav-item"><div class="nav-item-block-inactive block"><a href="../topics/license.html"><span class="module-name-item">license</span></a></div></li>
</ul>
</li>
</ul>
</div>
<div class="up-to-top">
<!-- list of items in a module -->
<ul class="nav nav-module-contents">
<li class="nav-item">
<h4>Jump to Section</h4>
<ul class="nav">
<li class="nav-item"><a href="#Functions"><span class="fragment-hashtag">#</span> Functions</a></li>
<li class="nav-item"><a href="#Fields"><span class="fragment-hashtag">#</span> Fields</a></li>
</ul>
</li>
</ul>
<a href="#">Top <i class="icon icon-upward"></i></a>
</div>
</div>
<!-- sidebar end -->
<!-- content body start -->
<div class="column col-9 col-sm-12">
<!-- module list on the main page start -->
<!-- module list on the main page end -->
<!-- module contents -->
<!-- module content header start -->
<h2><span class="body-module-name"><strong><em>utils.table</em></strong></span> module</h2>
<p>Searches a table to remove a specific element without an index</p>
<p></p>
<!-- module info start -->
<!-- module info end -->
<!-- module usage start -->
<!-- module usage end -->
<!-- module content header end -->
<!-- module section list start -->
<table class="section-content-list">
<thead>
<h3><a href="#Functions">Functions</a></h3>
<span></span>
</thead>
<tbody>
<tr>
<td class="name"><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"><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"><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"><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"><a href="#contains">contains(t, e)</a></td>
<td class="summary">Checks if a table contains an element</td>
</tr>
<tr>
<td class="name"><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"><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"><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"><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"><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"><a href="#clear_table">clear_table(t, array)</a></td>
<td class="summary">Clears all existing entries in a table</td>
</tr>
</tbody>
</table>
<table class="section-content-list">
<thead>
<h3><a href="#Fields">Fields</a></h3>
<span></span>
</thead>
<tbody>
<tr>
<td class="name"><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"><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"><a href="#deep_copy">deep_copy</a></td>
<td class="summary">Creates a deepcopy of a table.</td>
</tr>
<tr>
<td class="name"><a href="#merge">merge</a></td>
<td class="summary">Merges multiple tables.</td>
</tr>
<tr>
<td class="name"><a href="#equals">equals</a></td>
<td class="summary">Determines if two tables are structurally equal.</td>
</tr>
</tbody>
</table>
<!-- module section list end -->
<br />
<!-- section start -->
<h3><span id="Functions" class="section-title"><a href="#Functions">Functions</a></span></h3>
<dl class="section-body-container">
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#fast_remove" class="fragment-hashtag">#</a>
<span class="section-item-title" id="fast_remove">fast_remove(tbl, index)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Removes an item from an array in O(1) time.</p>
<p class="section-item-description">
The catch is that fast_remove doesn't guarantee to maintain the order of items in the array.</p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>tbl</em></strong>
<strong> : </strong>
<table> arrayed table
</li>
<li class="section-subitem-li">
<strong><em>index</em></strong>
<strong> : </strong>
<number> Must be >= 0. The case where index > #tbl is handled.
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#add_all" class="fragment-hashtag">#</a>
<span class="section-item-title" id="add_all">add_all(t1, t2)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Adds the contents of table t2 to table t1</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t1</em></strong>
<strong> : </strong>
<table> to insert into
</li>
<li class="section-subitem-li">
<strong><em>t2</em></strong>
<strong> : </strong>
<table> to insert from
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#index_of" class="fragment-hashtag">#</a>
<span class="section-item-title" id="index_of">index_of(t, e)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Checks if a table contains an element</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table>
</li>
<li class="section-subitem-li">
<strong><em>e</em></strong>
<strong> : </strong>
<any> table element
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#index_of_in_array" class="fragment-hashtag">#</a>
<span class="section-item-title" id="index_of_in_array">index_of_in_array(t, e)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Checks if the arrayed portion of a table contains an element</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table>
</li>
<li class="section-subitem-li">
<strong><em>e</em></strong>
<strong> : </strong>
<any> table element
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#contains" class="fragment-hashtag">#</a>
<span class="section-item-title" id="contains">contains(t, e)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Checks if a table contains an element</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table>
</li>
<li class="section-subitem-li">
<strong><em>e</em></strong>
<strong> : </strong>
<any> table element
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#array_contains" class="fragment-hashtag">#</a>
<span class="section-item-title" id="array_contains">array_contains(t, e)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Checks if the arrayed portion of a table contains an element</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table>
</li>
<li class="section-subitem-li">
<strong><em>e</em></strong>
<strong> : </strong>
<any> table element
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#set" class="fragment-hashtag">#</a>
<span class="section-item-title" id="set">set(t, index, element)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Adds an element into a specific index position while shuffling the rest down</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table> to add into
</li>
<li class="section-subitem-li">
<strong><em>index</em></strong>
<strong> : </strong>
<number> the position in the table to add to
</li>
<li class="section-subitem-li">
<strong><em>element</em></strong>
<strong> : </strong>
<any> to add to the table
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#get_random_dictionary_entry" class="fragment-hashtag">#</a>
<span class="section-item-title" id="get_random_dictionary_entry">get_random_dictionary_entry(t, key)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Chooses a random entry from a table
because this uses math.random, it cannot be used outside of events</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table>
</li>
<li class="section-subitem-li">
<strong><em>key</em></strong>
<strong> : </strong>
<boolean> to indicate whether to return the key or value
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<strong>Returns:</strong>
<ul>
<li>
<span class="return-text"><any> a random element of table t</span>
</li>
</ul>
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#get_random_weighted" class="fragment-hashtag">#</a>
<span class="section-item-title" id="get_random_weighted">get_random_weighted(weight_table, item_index, weight_index)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Chooses a random entry from a weighted table
because this uses math.random, it cannot be used outside of events</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>weight_table</em></strong>
<strong> : </strong>
<table> of tables with items and their weights
</li>
<li class="section-subitem-li">
<strong><em>item_index</em></strong>
<strong> : </strong>
<number> of the index of items, defaults to 1
</li>
<li class="section-subitem-li">
<strong><em>weight_index</em></strong>
<strong> : </strong>
<number> of the index of the weights, defaults to 2
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<strong>Returns:</strong>
<ul>
<li>
<span class="return-text"><any> table element</span>
</li>
</ul>
<!-- returns end -->
<!-- see also start -->
<strong>See also:</strong>
<ul>
</ul>
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#shuffle_table" class="fragment-hashtag">#</a>
<span class="section-item-title" id="shuffle_table">shuffle_table(t)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-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</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table> to shuffle
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#clear_table" class="fragment-hashtag">#</a>
<span class="section-item-title" id="clear_table">clear_table(t, array)</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Clears all existing entries in a table</p>
<p class="section-item-description"></p>
<!-- parameters start -->
<strong>Parameters:</strong>
<ul>
<li class="section-subitem-li">
<strong><em>t</em></strong>
<strong> : </strong>
<table> to clear
</li>
<li class="section-subitem-li">
<strong><em>array</em></strong>
<strong> : </strong>
<boolean> to indicate whether the table is an array or not
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
</dl>
<h3><span id="Fields" class="section-title"><a href="#Fields">Fields</a></span></h3>
<dl class="section-body-container">
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#inspect" class="fragment-hashtag">#</a>
<span class="section-item-title" id="inspect">inspect</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Similar to serpent.block, returns a string with a pretty representation of a table.</p>
<p class="section-item-description">
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</p>
<!-- parameters start -->
<ul>
<li class="section-subitem-module-field-li">
<strong><em>table</em></strong>
<strong> : </strong>
<table> the table to serialize
</li>
<li class="section-subitem-module-field-li">
<strong><em>options</em></strong>
<strong> : </strong>
<table> options are depth, newline, indent, process
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#size" class="fragment-hashtag">#</a>
<span class="section-item-title" id="size">size</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Takes a table and returns the number of entries in the table.</p>
<p class="section-item-description"> (Slower than #table, faster than iterating via pairs)</p>
<!-- parameters start -->
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#deep_copy" class="fragment-hashtag">#</a>
<span class="section-item-title" id="deep_copy">deep_copy</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Creates a deepcopy of a table.</p>
<p class="section-item-description"> Metatables and LuaObjects inside the table are shallow copies.
Shallow copies meaning it copies the reference to the object instead of the object itself.</p>
<!-- parameters start -->
<ul>
<li class="section-subitem-module-field-li">
<strong><em>object</em></strong>
<strong> : </strong>
<table> the object to copy
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#merge" class="fragment-hashtag">#</a>
<span class="section-item-title" id="merge">merge</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Merges multiple tables.</p>
<p class="section-item-description"> 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}</p>
<!-- parameters start -->
<ul>
<li class="section-subitem-module-field-li">
<strong><em>tables</em></strong>
<strong> : </strong>
<table> takes a table of tables to merge
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
<dt>
<div class="divider divider-custom"></div>
<div class="block section-item-header">
<a href="#equals" class="fragment-hashtag">#</a>
<span class="section-item-title" id="equals">equals</span>
</div>
</dt>
<dd>
<div class="section-item-body">
<p class="section-item-summary">Determines if two tables are structurally equal.</p>
<p class="section-item-description">
Notice: tables that are LuaObjects or contain LuaObjects won't be compared correctly, use == operator for LuaObjects</p>
<!-- parameters start -->
<ul>
<li class="section-subitem-module-field-li">
<strong><em>tbl1</em></strong>
<strong> : </strong>
<table>
</li>
<li class="section-subitem-module-field-li">
<strong><em>tbl2</em></strong>
<strong> : </strong>
<table>
</li>
</ul>
<!-- parameters end -->
<!-- returns start -->
<!-- returns end -->
<!-- see also start -->
<!-- see also end -->
<!-- usage start -->
<!-- usage end -->
</dd>
</dl>
<!-- section end -->
</div>
</div>
</div>
<div class="footer container grid-1280">
<div class="divider divider-custom"></div>
<div class="footer-columns columns">
<div class="sidebar-footer column col-3 col-sm-12">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc </a></i>
</div>
<div class="content-footer column col-9 col-sm-12">
<i>Last updated 2019-07-20 23:44:09 UTC</i>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink