Documentation
Contents
Menu
LUA
LUA companion library.

#### Info:

- Release: 1.0.0
- Author: Steven Jackson (2014)

##### Summary:

Jump To: Math ⋙

math.parsefloat (value, decimal) | Integer float utility for lua.

Jump To: Pickle ⋙

Pickle | Global class used by pickle/unpickle functions.
pickle (t) | A table serialization utility for lua.
unpickle (s) | Un-serialization tool (pretty sure thats not a word).

Jump To: String ⋙

string.encode (data) | Base64 encoding tool.
string.decode (data) | Base64 decoding tool.
string.explode (data, delim) | String to array utility.
prettify | PRETTY PRINT FOR TABLES

Jump To: Table ⋙

table.tostring (tbl, pretty) | Dump table contents to string
table.copy (targetTable, deepCopy, mergeTable) | Copy all table data from a source to another table

###### Math UTILITIES

math.parsefloat (value, decimal)
  Integer float utility for lua.
  Parameters:

  value | The integer amount to be adjusted.
  decimal | Number of decimal places allowed.

  Returns:
  floating point integer

###### Pickle UTILITIES

Pickle
  Global class used by pickle/unpickle functions.
  Fields:

  clone |

pickle (t)
  A table serialization utility for lua.
  Parameters:

  t | A table to be serialized.

  Returns:
  serialized table data
unpickle (s)
  Un-serialization tool (pretty sure thats not a word).
  Parameters:

  s | A serialized table to be reversed.

  Returns:
  serialized table data

###### String UTILITIES

string.encode (data)
  Base64 encoding tool.
  Parameters:

  data | string data to be encoded.

  Returns:
  encoded string
string.decode (data)
  Base64 decoding tool.
  Parameters:

  data | encoded string to be decoded.

  Returns:
  decoded string
string.explode (data, delim)
  String to array utility.
  Parameters:

  data | string to be converted to table data.
  delim | Character delimiter to separate the string by.

  Returns:
  table data
prettify
  PRETTY PRINT FOR TABLES

###### Table UTILITIES

table.tostring (tbl, pretty)
  Dump table contents to string
  Parameters:

  tbl | A table to be stringified.
  pretty | Flag to syntactically format the result.

  Returns:
  string value
table.copy (targetTable, deepCopy, mergeTable)
  Copy all table data from a source to another table
  Parameters:

  targetTable | The recipient of the copied data.
  deepCopy | Flag the use of DEEP copying.
  mergeTable | The origin of the copied data.

  Returns:
  copied data