<!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>SVUI Guide</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
<!-- Fonts -->
<link href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,thin,light,bolditalic,black,medium&lang=en" rel="stylesheet" type="text/css">
</head>
<body id="page-top" data-spy="scroll" data-target=".layout-header">
<div class="skinned-page"></div>
<div id="message-depot"></div>
<!-- BEGIN LAYOUT -->
<div class="layout js-layout js-skins layout-overlay-drawer-button layout-shadow layout-fixed-header layout-fixed-drawer">
<!-- BEGIN NAV // -->
<div class="layout-header">
<div class="layout-header-row">
<span class="layout-title">Documentation</span>
<div class="layout-spacer"></div>
<nav class="navigation">
</nav>
</div>
</div>
<div class="layout-drawer">
<span class="navigation-title" style="padding:">Contents</span>
<nav class="navigation" style="padding-top:0 !important;">
<div class="navigation-subtitle">Libraries</div>
<a href="../libraries/Librarian.html" class="navigation-link">Librarian</a>
<a href="../libraries/LUA.html" class="navigation-link current-link">LUA</a>
<a href="#Math" class="navigation-link"> Math </a>
<a href="#Pickle" class="navigation-link"> Pickle </a>
<a href="#String" class="navigation-link"> String </a>
<a href="#Table" class="navigation-link"> Table </a>
<div class="navigation-spacer"></div>
<a href="../libraries/AceVillain.html" class="navigation-link">AceVillain</a>
<div class="navigation-spacer"></div>
<div class="navigation-subtitle">Addons</div>
<a href="../index.html" class="navigation-link">SVUI_Core</a>
<div class="navigation-spacer"></div>
<div class="navigation-subtitle">Manual</div>
<a href="../manual/doc.md.html" class="navigation-link">doc</a>
<div class="navigation-spacer"></div>
</nav>
</div>
<span class="layout-title floating-title no-desktop">Menu</span>
<div class="layout-drawer-button">
<i class="layout-drawer-button-icon menu-icon"></i>
</div>
<!-- END NAV // -->
<!-- BEGIN CONTENT // -->
<div class="layout-content">
<section style="padding:0;">
<div class="grid">
<div class="cell cell-12-col">
<div class="container">
<div class="comic">
<div class="card">
<div class="card-header flex--expand">
<div class="card-header-title flex--centered">
<span class="badge" data-badge="File">LUA</span>
</div>
</div>
<div class="card-actions flex--expand">
<div class="card-header-subtitle flex--centered">LUA companion library.</div>
</div>
<div class="card-section">
<div class="section-dialog">
<h4 class="section-label">Info:</h4>
<ul>
<li>
</li>
<li><strong>Release</strong>: 1.0.0</li>
<li><strong>Author</strong>: Steven Jackson (2014)</li>
<hr />
</ul>
<h5 class="section-label">Summary:</h5>
<div style="padding:6px 0px;"><a href="#Math" style="color:#ff5500">Jump To: Math ⋙</a></div>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#math.parsefloat">math.parsefloat (value, decimal)</a></td>
<td class="summary">Integer float utility for lua.</td>
</tr>
</table>
<div style="padding:6px 0px;"><a href="#Pickle" style="color:#ff5500">Jump To: Pickle ⋙</a></div>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Pickle">Pickle</a></td>
<td class="summary">Global class used by pickle/unpickle functions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#pickle">pickle (t)</a></td>
<td class="summary">A table serialization utility for lua.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#unpickle">unpickle (s)</a></td>
<td class="summary">Un-serialization tool (pretty sure thats not a word).</td>
</tr>
</table>
<div style="padding:6px 0px;"><a href="#String" style="color:#ff5500">Jump To: String ⋙</a></div>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#string.encode">string.encode (data)</a></td>
<td class="summary">Base64 encoding tool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#string.decode">string.decode (data)</a></td>
<td class="summary">Base64 decoding tool.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#string.explode">string.explode (data, delim)</a></td>
<td class="summary">String to array utility.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#prettify">prettify</a></td>
<td class="summary">PRETTY PRINT FOR TABLES</td>
</tr>
</table>
<div style="padding:6px 0px;"><a href="#Table" style="color:#ff5500">Jump To: Table ⋙</a></div>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#table.tostring">table.tostring (tbl, pretty)</a></td>
<td class="summary">Dump table contents to string</td>
</tr>
<tr>
<td class="name" nowrap><a href="#table.copy">table.copy (targetTable, deepCopy, mergeTable)</a></td>
<td class="summary">Copy all table data from a source to another table</td>
</tr>
</table>
<hr />
<br />
<br />
<h6 class="section-label" id="Math">Math
<small>
UTILITIES
</small>
</h6>
<dl class="function">
<dt id="math.parsefloat">
<strong>math.parsefloat (value, decimal)</strong>
</dt>
<dd>
Integer float utility for lua.
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>value</strong><td>
The integer amount to be adjusted.
</td></tr>
<tr><td style="width:20% !important;"><strong>decimal</strong><td>
Number of decimal places allowed.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
floating point integer
</ol>
</dd>
</dl>
<h6 class="section-label" id="Pickle">Pickle
<small>
UTILITIES
</small>
</h6>
<dl class="function">
<dt id="Pickle">
<strong>Pickle</strong>
</dt>
<dd>
Global class used by pickle/unpickle functions.
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Fields:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>clone</strong><td>
</td></tr>
</tbody></table>
</dd>
<dt id="pickle">
<strong>pickle (t)</strong>
</dt>
<dd>
A table serialization utility for lua.
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>t</strong><td>
A table to be serialized.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
serialized table data
</ol>
</dd>
<dt id="unpickle">
<strong>unpickle (s)</strong>
</dt>
<dd>
Un-serialization tool (pretty sure thats not a word).
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>s</strong><td>
A serialized table to be reversed.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
serialized table data
</ol>
</dd>
</dl>
<h6 class="section-label" id="String">String
<small>
UTILITIES
</small>
</h6>
<dl class="function">
<dt id="string.encode">
<strong>string.encode (data)</strong>
</dt>
<dd>
Base64 encoding tool.
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>data</strong><td>
string data to be encoded.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
encoded string
</ol>
</dd>
<dt id="string.decode">
<strong>string.decode (data)</strong>
</dt>
<dd>
Base64 decoding tool.
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>data</strong><td>
encoded string to be decoded.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
decoded string
</ol>
</dd>
<dt id="string.explode">
<strong>string.explode (data, delim)</strong>
</dt>
<dd>
String to array utility.
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>data</strong><td>
string to be converted to table data.
</td></tr>
<tr><td style="width:20% !important;"><strong>delim</strong><td>
Character delimiter to separate the string by.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
table data
</ol>
</dd>
<dt id="prettify">
<strong>prettify</strong>
</dt>
<dd>
PRETTY PRINT FOR TABLES
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</dd>
</dl>
<h6 class="section-label" id="Table">Table
<small>
UTILITIES
</small>
</h6>
<dl class="function">
<dt id="table.tostring">
<strong>table.tostring (tbl, pretty)</strong>
</dt>
<dd>
Dump table contents to string
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>tbl</strong><td>
A table to be stringified.
</td></tr>
<tr><td style="width:20% !important;"><strong>pretty</strong><td>
Flag to syntactically format the result.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
string value
</ol>
</dd>
<dt id="table.copy">
<strong>table.copy (targetTable, deepCopy, mergeTable)</strong>
</dt>
<dd>
Copy all table data from a source to another table
<br />
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
</tbody>
</table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Parameters:</strong></div>
<table>
<tbody>
<tr><td style="width:20% !important;"><strong>targetTable</strong><td>
The recipient of the copied data.
</td></tr>
<tr><td style="width:20% !important;"><strong>deepCopy</strong><td>
Flag the use of DEEP copying.
</td></tr>
<tr><td style="width:20% !important;"><strong>mergeTable</strong><td>
The origin of the copied data.
</td></tr>
</tbody></table>
<div style="padding:12px 0 6px;font-size:15px;"><strong>Returns:</strong></div>
<ol>
copied data
</ol>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<!-- END CONTENT -->
<!-- BEGIN FOOTER // -->
<footer>
<div class="right-section">
<ul class="link-list">
<li>
<span style="color:#5fafff">Last updated 2015-08-26 14:32:22</span>
</li>
</ul>
</div>
</footer>
<!-- END FOOTER // -->
</div>
<!-- END LAYOUT -->
<!-- Core JavaScript -->
<script src="http://supervillainui.com/js/app.min.js"></script>
<script src="http://supervillainui.com/js/extended/jquery-1.11.0.js"></script>
<script src="http://supervillainui.com/js/extended/jquery.easing.min.js"></script>
<script src="http://supervillainui.com/js/extended/jquery.swipebox.min.js"></script>
</body>
</html>