minetest-australopithecus
/
minetest-australopithecus-artisanry
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changed to LDoc.

master
Robert Zenz 2015-08-14 22:07:54 +02:00
parent 3b566f6e7d
commit d655f218fa
13 changed files with 1284 additions and 1723 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -9,7 +9,7 @@ clean:
.PHONY: doc
doc:
luadoc -d $(doc) mods/artisanry
ldoc --dir=$(doc) mods/artisanry
.SILENT .PHONY: test
test: $(test)/*.lua

244
doc/files/mods/artisanry/artisanry.html
View File

@ -1,244 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Luadocs for mods/artisanry/artisanry.lua</title>
<link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</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">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../../../index.html">Index</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li><strong>mods/artisanry/artisanry.lua</strong></li>
<li>
<a href="../../../files/mods/artisanry/artisanryui.html">mods/artisanry/artisanryui.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/artisanryutil.html">mods/artisanry/artisanryutil.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/blueprint.html">mods/artisanry/blueprint.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/init.html">mods/artisanry/init.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/artisanry/artisanry.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Artisanry:get_blueprints">Artisanry:get_blueprints</a>&nbsp;(input)</td>
<td class="summary">Gets all BluePrints matching the given input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Artisanry:get_blueprints_from_output">Artisanry:get_blueprints_from_output</a>&nbsp;(output)</td>
<td class="summary">Gets all BluePrints that match the given output.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Artisanry:new">Artisanry:new</a>&nbsp;()</td>
<td class="summary">Creates a new instance of Artisanry.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Artisanry:register">Artisanry:register</a>&nbsp;(result, input)</td>
<td class="summary">Registers the given input for the given result.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="Artisanry:get_blueprints"></a><strong>Artisanry:get_blueprints</strong>&nbsp;(input)</dt>
<dd>
Gets all BluePrints matching the given input.
<h3>Parameters</h3>
<ul>
<li>
input: The input, a 2D of strings or ItemStacks. Might be nil to retrieve all BluePrints.
</li>
</ul>
<h3>Return value:</h3>
All matching BluePrints.
</dd>
<dt><a name="Artisanry:get_blueprints_from_output"></a><strong>Artisanry:get_blueprints_from_output</strong>&nbsp;(output)</dt>
<dd>
Gets all BluePrints that match the given output.
<h3>Parameters</h3>
<ul>
<li>
output: The output. Can either be an ItemStack, item string or id.
</li>
</ul>
<h3>Return value:</h3>
The List containing all Blueprints that match the given output.
</dd>
<dt><a name="Artisanry:new"></a><strong>Artisanry:new</strong>&nbsp;()</dt>
<dd>
Creates a new instance of Artisanry.
<h3>Return value:</h3>
A new instance of Artisanry.
</dd>
<dt><a name="Artisanry:register"></a><strong>Artisanry:register</strong>&nbsp;(result, input)</dt>
<dd>
Registers the given input for the given result.
<h3>Parameters</h3>
<ul>
<li>
result: The result of the input, an item string.
</li>
<li>
input: The 2D array of item strings or ItemStacks.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

429
doc/files/mods/artisanry/artisanryui.html
View File

@ -1,429 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Luadocs for mods/artisanry/artisanryui.lua</title>
<link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</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">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../../../index.html">Index</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="../../../files/mods/artisanry/artisanry.html">mods/artisanry/artisanry.lua</a>
</li>
<li><strong>mods/artisanry/artisanryui.lua</strong></li>
<li>
<a href="../../../files/mods/artisanry/artisanryutil.html">mods/artisanry/artisanryutil.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/blueprint.html">mods/artisanry/blueprint.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/init.html">mods/artisanry/init.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/artisanry/artisanryui.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.activate">ArtisanryUI.activate</a>&nbsp;(artisanry)</td>
<td class="summary">Activates the ArtinsaryUI.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.build_formspec">ArtisanryUI.build_formspec</a>&nbsp;(player)</td>
<td class="summary">Builds the formspec for the ArtisanryUI inventory.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.create_inventory">ArtisanryUI.create_inventory</a>&nbsp;()</td>
<td class="summary">Creates a detached inventory that is used.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.has_changed">ArtisanryUI.has_changed</a>&nbsp;(player, inventory_name)</td>
<td class="summary">Checks if the inventory has changed compared to the saved hash.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.put_hash">ArtisanryUI.put_hash</a>&nbsp;(player, inventory_name)</td>
<td class="summary">Puts the hash of the inventory, for using it later.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.replace_inventories">ArtisanryUI.replace_inventories</a>&nbsp;()</td>
<td class="summary">Replaces the inventory of every currently connected player with the ArtisanryUI one.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.replace_inventory">ArtisanryUI.replace_inventory</a>&nbsp;(player)</td>
<td class="summary">Replaces the inventory of the given player with the ArtisanryUI one.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.update_from_input_inventory">ArtisanryUI.update_from_input_inventory</a>&nbsp;(player)</td>
<td class="summary">Updates from the input inventory of the given player.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.update_from_output_inventory">ArtisanryUI.update_from_output_inventory</a>&nbsp;(player)</td>
<td class="summary">Updates from the output inventory of the given player.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.update_inventory">ArtisanryUI.update_inventory</a>&nbsp;(player, force_update)</td>
<td class="summary">Updates the inventory of the given player.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="ArtisanryUI.activate"></a><strong>ArtisanryUI.activate</strong>&nbsp;(artisanry)</dt>
<dd>
Activates the ArtinsaryUI. This function replaces all inventories of all currently coneccted players and also registers a callback to replace the inventory of every new player.
<h3>Parameters</h3>
<ul>
<li>
artisanry: The Artisanry instance to use.
</li>
</ul>
</dd>
<dt><a name="ArtisanryUI.build_formspec"></a><strong>ArtisanryUI.build_formspec</strong>&nbsp;(player)</dt>
<dd>
Builds the formspec for the ArtisanryUI inventory.
<h3>Parameters</h3>
<ul>
<li>
player: The player.
</li>
</ul>
<h3>Return value:</h3>
The formspec for the inventory.
</dd>
<dt><a name="ArtisanryUI.create_inventory"></a><strong>ArtisanryUI.create_inventory</strong>&nbsp;()</dt>
<dd>
Creates a detached inventory that is used.
<h3>Return value:</h3>
The detached inventory.
</dd>
<dt><a name="ArtisanryUI.has_changed"></a><strong>ArtisanryUI.has_changed</strong>&nbsp;(player, inventory_name)</dt>
<dd>
Checks if the inventory has changed compared to the saved hash.
<h3>Parameters</h3>
<ul>
<li>
player: The Player object that owns the inventory.
</li>
<li>
inventory_name: The name of the inventory.
</li>
</ul>
<h3>Return value:</h3>
true if the inventory has changed since the last check. Also true if there is no saved hash for this inventory.
</dd>
<dt><a name="ArtisanryUI.put_hash"></a><strong>ArtisanryUI.put_hash</strong>&nbsp;(player, inventory_name)</dt>
<dd>
Puts the hash of the inventory, for using it later.
<h3>Parameters</h3>
<ul>
<li>
player: The Player object that owns the inventory.
</li>
<li>
inventory_name: The name of the inventory.
</li>
</ul>
</dd>
<dt><a name="ArtisanryUI.replace_inventories"></a><strong>ArtisanryUI.replace_inventories</strong>&nbsp;()</dt>
<dd>
Replaces the inventory of every currently connected player with the ArtisanryUI one.
</dd>
<dt><a name="ArtisanryUI.replace_inventory"></a><strong>ArtisanryUI.replace_inventory</strong>&nbsp;(player)</dt>
<dd>
Replaces the inventory of the given player with the ArtisanryUI one.
<h3>Parameters</h3>
<ul>
<li>
player: The player for which to replace the inventory.
</li>
</ul>
</dd>
<dt><a name="ArtisanryUI.update_from_input_inventory"></a><strong>ArtisanryUI.update_from_input_inventory</strong>&nbsp;(player)</dt>
<dd>
Updates from the input inventory of the given player.
<h3>Parameters</h3>
<ul>
<li>
player: The player for which to update the inventories.
</li>
</ul>
</dd>
<dt><a name="ArtisanryUI.update_from_output_inventory"></a><strong>ArtisanryUI.update_from_output_inventory</strong>&nbsp;(player)</dt>
<dd>
Updates from the output inventory of the given player.
<h3>Parameters</h3>
<ul>
<li>
player: The player for which to update the inventories.
</li>
</ul>
</dd>
<dt><a name="ArtisanryUI.update_inventory"></a><strong>ArtisanryUI.update_inventory</strong>&nbsp;(player, force_update)</dt>
<dd>
Updates the inventory of the given player.
<h3>Parameters</h3>
<ul>
<li>
player: The player for which to update the inventory.
</li>
<li>
force_update: Optional. If an update should be forced.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

287
doc/files/mods/artisanry/artisanryutil.html
View File

@ -1,287 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Luadocs for mods/artisanry/artisanryutil.lua</title>
<link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</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">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../../../index.html">Index</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="../../../files/mods/artisanry/artisanry.html">mods/artisanry/artisanry.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/artisanryui.html">mods/artisanry/artisanryui.lua</a>
</li>
<li><strong>mods/artisanry/artisanryutil.lua</strong></li>
<li>
<a href="../../../files/mods/artisanry/blueprint.html">mods/artisanry/blueprint.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/init.html">mods/artisanry/init.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/artisanry/artisanryutil.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#artisanryutil.as_stacks">artisanryutil.as_stacks</a>&nbsp;(input)</td>
<td class="summary">Converts the given input from strings to ItemStacks.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#artisanryutil.convert">artisanryutil.convert</a>&nbsp;(input, The)</td>
<td class="summary">Reduces and converts the given input to ItemStacks.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#artisanryutil.flat_to_grid">artisanryutil.flat_to_grid</a>&nbsp;(flat)</td>
<td class="summary">Converts the given data from a flat array to a 2D array.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#artisanryutil.is_empty_item">artisanryutil.is_empty_item</a>&nbsp;(item)</td>
<td class="summary">Checks if the given item is empty.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#artisanryutil.is_empty_stacks">artisanryutil.is_empty_stacks</a>&nbsp;(input)</td>
<td class="summary">Checks if the given array of ItemStacks is empty, meaning either all are nil, or all are empty.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="artisanryutil.as_stacks"></a><strong>artisanryutil.as_stacks</strong>&nbsp;(input)</dt>
<dd>
Converts the given input from strings to ItemStacks. If the values are already ItemStacks, they are only copied.
<h3>Parameters</h3>
<ul>
<li>
input: The input to convert.
</li>
</ul>
<h3>Return value:</h3>
The input as ItemStacks.
</dd>
<dt><a name="artisanryutil.convert"></a><strong>artisanryutil.convert</strong>&nbsp;(input, The)</dt>
<dd>
Reduces and converts the given input to ItemStacks.
<h3>Parameters</h3>
<ul>
<li>
input: The input to convert.
</li>
<li>
The: converted input.
</li>
</ul>
</dd>
<dt><a name="artisanryutil.flat_to_grid"></a><strong>artisanryutil.flat_to_grid</strong>&nbsp;(flat)</dt>
<dd>
Converts the given data from a flat array to a 2D array.
<h3>Parameters</h3>
<ul>
<li>
flat: The data to convert.
</li>
</ul>
<h3>Return value:</h3>
The grid data.
</dd>
<dt><a name="artisanryutil.is_empty_item"></a><strong>artisanryutil.is_empty_item</strong>&nbsp;(item)</dt>
<dd>
Checks if the given item is empty. That means if it is either nil, an empty string or an ItemStack that is empty.
<h3>Parameters</h3>
<ul>
<li>
item: The item to check.
</li>
</ul>
<h3>Return value:</h3>
true if the item can be considered empty.
</dd>
<dt><a name="artisanryutil.is_empty_stacks"></a><strong>artisanryutil.is_empty_stacks</strong>&nbsp;(input)</dt>
<dd>
Checks if the given array of ItemStacks is empty, meaning either all are nil, or all are empty.
<h3>Parameters</h3>
<ul>
<li>
input: The array of ItemStacks.
</li>
</ul>
<h3>Return value:</h3>
true if all are nil or empty.
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

281
doc/files/mods/artisanry/blueprint.html
View File

@ -1,281 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Luadocs for mods/artisanry/blueprint.lua</title>
<link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</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">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../../../index.html">Index</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="../../../files/mods/artisanry/artisanry.html">mods/artisanry/artisanry.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/artisanryui.html">mods/artisanry/artisanryui.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/artisanryutil.html">mods/artisanry/artisanryutil.lua</a>
</li>
<li><strong>mods/artisanry/blueprint.lua</strong></li>
<li>
<a href="../../../files/mods/artisanry/init.html">mods/artisanry/init.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/artisanry/blueprint.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Blueprint:count">Blueprint:count</a>&nbsp;(input)</td>
<td class="summary">Gets the count how often this output can be produced from the given input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:get_input">Blueprint:get_input</a>&nbsp;()</td>
<td class="summary">Gets the input for this Blueprint.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:get_result">Blueprint:get_result</a>&nbsp;(input)</td>
<td class="summary">Gets the result for this Blueprint.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:match">Blueprint:match</a>&nbsp;(input)</td>
<td class="summary">Matches this blueprint against the given input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:new">Blueprint:new</a>&nbsp;(result, input)</td>
<td class="summary">Creates a new instance of Blueprint.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="Blueprint:count"></a><strong>Blueprint:count</strong>&nbsp;(input)</dt>
<dd>
Gets the count how often this output can be produced from the given input. The input must match.
<h3>Parameters</h3>
<ul>
<li>
input: The input, already matched against this Blueprint.
</li>
</ul>
<h3>Return value:</h3>
The count how often this output can be produced.
</dd>
<dt><a name="Blueprint:get_input"></a><strong>Blueprint:get_input</strong>&nbsp;()</dt>
<dd>
Gets the input for this Blueprint.
<h3>Return value:</h3>
The input of this Blueprint, a 2D array..
</dd>
<dt><a name="Blueprint:get_result"></a><strong>Blueprint:get_result</strong>&nbsp;(input)</dt>
<dd>
Gets the result for this Blueprint.
<h3>Parameters</h3>
<ul>
<li>
input: Optional. The input stack, will be used to determine the count of the result.
</li>
</ul>
<h3>Return value:</h3>
The result, an ItemStack.
</dd>
<dt><a name="Blueprint:match"></a><strong>Blueprint:match</strong>&nbsp;(input)</dt>
<dd>
Matches this blueprint against the given input.
<h3>Parameters</h3>
<ul>
<li>
input: The input, already reduced and converted to ItemStacks.
</li>
</ul>
<h3>Return value:</h3>
true if this blueprint matches the given input.
</dd>
<dt><a name="Blueprint:new"></a><strong>Blueprint:new</strong>&nbsp;(result, input)</dt>
<dd>
Creates a new instance of Blueprint.
<h3>Parameters</h3>
<ul>
<li>
result: The result of the blueprint, an item string like "sand 5" or "glass".
</li>
<li>
input: The input for the blueprint, a 2D array with 5 rows and columns.
</li>
</ul>
<h3>Return value:</h3>
The new instance of Blueprint.
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

106
doc/files/mods/artisanry/init.html
View File

@ -1,106 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Luadocs for mods/artisanry/init.lua</title>
<link rel="stylesheet" href="../../../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</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">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../../../index.html">Index</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="../../../files/mods/artisanry/artisanry.html">mods/artisanry/artisanry.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/artisanryui.html">mods/artisanry/artisanryui.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/artisanryutil.html">mods/artisanry/artisanryutil.lua</a>
</li>
<li>
<a href="../../../files/mods/artisanry/blueprint.html">mods/artisanry/blueprint.lua</a>
</li>
<li><strong>mods/artisanry/init.lua</strong></li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/artisanry/init.lua</code></h1>
<br/>
<br/>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

131
doc/index.html
View File

@ -1,121 +1,74 @@
<?xml version="1.0" encoding="UTF-8"?>
<!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> Luadocs Index</title>
<link rel="stylesheet" href="luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
<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_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>
<h1>LuaDoc</h1>
<ul>
<li><strong>Index</strong></li>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="modules/artisanry.html">artisanry</a></li>
<li><a href="modules/blueprint.html">blueprint</a></li>
<li><a href="modules/artisanryutil.html">artisanryutil</a></li>
<li><a href="modules/artisanryui.html">artisanryui</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="files/mods/artisanry/artisanry.html">mods/artisanry/artisanry.lua</a>
</li>
<li>
<a href="files/mods/artisanry/artisanryui.html">mods/artisanry/artisanryui.lua</a>
</li>
<li>
<a href="files/mods/artisanry/artisanryutil.html">mods/artisanry/artisanryutil.lua</a>
</li>
<li>
<a href="files/mods/artisanry/blueprint.html">mods/artisanry/blueprint.lua</a>
</li>
<li>
<a href="files/mods/artisanry/init.html">mods/artisanry/init.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
</div>
<div id="content">
<h2>Files</h2>
<table class="file_list">
<!--<tr><td colspan="2">Files</td></tr>-->
<tr>
<td class="name"><a href="files/mods/artisanry/artisanry.html">mods/artisanry/artisanry.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/artisanry/artisanryui.html">mods/artisanry/artisanryui.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/artisanry/artisanryutil.html">mods/artisanry/artisanryutil.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/artisanry/blueprint.html">mods/artisanry/blueprint.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/artisanry/init.html">mods/artisanry/init.lua</a></td>
<td class="summary"></td>
</tr>
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/artisanry.html">artisanry</a></td>
<td class="summary">The main Artisanry object that holds and manages all receipts.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/blueprint.html">blueprint</a></td>
<td class="summary">The Blueprint is a receipt used by Artisanry.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/artisanryutil.html">artisanryutil</a></td>
<td class="summary">Converts the given input from strings to ItemStacks.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/artisanryui.html">artisanryui</a></td>
<td class="summary">ArtisanryUI is a static, global object that allows to replace the inventory
with the Artisanry one.</td>
</tr>
</table>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

302
doc/ldoc.css Normal file
View File

@ -0,0 +1,302 @@
/* 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; }
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: 18em;
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: 18em;
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; }
/* styles for prettification of source */
pre .comment { color: #558817; }
pre .constant { color: #a8660d; }
pre .escape { color: #844631; }
pre .keyword { color: #2239a8; font-weight: bold; }
pre .library { color: #0e7c6b; }
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
pre .string { color: #a8660d; }
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; }

286
doc/luadoc.css
View File

@ -1,286 +0,0 @@
body {
margin-left: 1em;
margin-right: 1em;
font-family: arial, helvetica, geneva, sans-serif;
background-color:#ffffff; margin:0px;
}
code {
font-family: "Andale Mono", monospace;
}
tt {
font-family: "Andale Mono", monospace;
}
body, td, th { font-size: 11pt; }
h1, h2, h3, h4 { margin-left: 0em; }
textarea, pre, tt { font-size:10pt; }
body, td, th { color:#000000; }
small { font-size:0.85em; }
h1 { font-size:1.5em; }
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 }
img { border-width: 0px; }
h3 { padding-top: 1em; }
p { margin-left: 1em; }
p.name {
font-family: "Andale Mono", monospace;
padding-top: 1em;
margin-left: 0em;
}
blockquote { margin-left: 3em; }
pre.example {
background-color: rgb(245, 245, 245);
border-top-width: 1px;
border-right-width: 1px;
border-bottom-width: 1px;
border-left-width: 1px;
border-top-style: solid;
border-right-style: solid;
border-bottom-style: solid;
border-left-style: solid;
border-top-color: silver;
border-right-color: silver;
border-bottom-color: silver;
border-left-color: silver;
padding: 1em;
margin-left: 1em;
margin-right: 1em;
font-family: "Andale Mono", monospace;
font-size: smaller;
}
hr {
margin-left: 0em;
background: #00007f;
border: 0px;
height: 1px;
}
ul { list-style-type: disc; }
table.index { border: 1px #00007f; }
table.index td { text-align: left; vertical-align: top; }
table.index ul { padding-top: 0em; margin-top: 0em; }
table {
border: 1px solid black;
border-collapse: collapse;
margin-left: auto;
margin-right: auto;
}
th {
border: 1px solid black;
padding: 0.5em;
}
td {
border: 1px solid black;
padding: 0.5em;
}
div.header, div.footer { margin-left: 0em; }
#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;
}
#product_logo
{
}
#product_name
{
}
#product_description
{
}
#main
{
background-color: #f0f0f0;
border-left: 2px solid #cccccc;
}
#navigation
{
float: left;
width: 18em;
margin: 0;
vertical-align: top;
background-color: #f0f0f0;
overflow:visible;
}
#navigation h1 {
background-color:#e7e7e7;
font-size:1.1em;
color:#000000;
text-align:left;
margin:0px;
padding:0.2em;
border-top:1px solid #dddddd;
border-bottom:1px solid #dddddd;
}
#navigation ul
{
font-size:1em;
list-style-type: none;
padding: 0;
margin: 1px;
}
#navigation li
{
text-indent: -1em;
margin: 0em 0em 0em 0.5em;
display: block;
padding: 3px 0px 0px 12px;
}
#navigation li li a
{
padding: 0px 3px 0px -1em;
}
#content
{
margin-left: 18em;
padding: 1em;
border-left: 2px solid #cccccc;
border-right: 2px solid #cccccc;
background-color: #ffffff;
}
#about
{
clear: both;
margin: 0;
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 { margin-left: 0px; padding: 1em; border-left: 0px; border-right: 0px; background-color: #ffffff; }
#navigation { display: none;
}
pre.example {
font-family: "Andale Mono", monospace;
font-size: 10pt;
page-break-inside: avoid;
}
}
table.module_list td
{
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.module_list td.name { background-color: #f0f0f0; }
table.module_list td.summary { width: 100%; }
table.file_list
{
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.file_list td
{
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.file_list td.name { background-color: #f0f0f0; }
table.file_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; }
table.function_list td.summary { width: 100%; }
table.table_list
{
border-width: 1px;
border-style: solid;
border-color: #cccccc;
border-collapse: collapse;
}
table.table_list td
{
border-width: 1px;
padding: 3px;
border-style: solid;
border-color: #cccccc;
}
table.table_list td.name { background-color: #f0f0f0; }
table.table_list td.summary { width: 100%; }
dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.function dd {padding-bottom: 1em;}
dl.function h3 {padding: 0; margin: 0; font-size: medium;}
dl.table dt {border-top: 1px solid #ccc; padding-top: 1em;}
dl.table dd {padding-bottom: 1em;}
dl.table h3 {padding: 0; margin: 0; font-size: medium;}
#TODO: make module_list, file_list, function_list, table_list inherit from a list

185
doc/modules/artisanry.html Normal file
View File

@ -0,0 +1,185 @@
<!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><strong>artisanry</strong></li>
<li><a href="../modules/blueprint.html">blueprint</a></li>
<li><a href="../modules/artisanryutil.html">artisanryutil</a></li>
<li><a href="../modules/artisanryui.html">artisanryui</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>artisanry</code></h1>
<p>The main Artisanry object that holds and manages all receipts.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Artisanry:new">Artisanry:new ()</a></td>
<td class="summary">Creates a new instance of Artisanry.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Artisanry:get_blueprints">Artisanry:get_blueprints (input)</a></td>
<td class="summary">Gets all BluePrints matching the given input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Artisanry:get_blueprints_from_output">Artisanry:get_blueprints_from_output (output)</a></td>
<td class="summary">Gets all BluePrints that match the given output.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Artisanry:register">Artisanry:register (result, input)</a></td>
<td class="summary">Registers the given input for the given result.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Artisanry:new"></a>
<strong>Artisanry:new ()</strong>
</dt>
<dd>
Creates a new instance of Artisanry.
<h3>Returns:</h3>
<ol>
A new instance of Artisanry.
</ol>
</dd>
<dt>
<a name = "Artisanry:get_blueprints"></a>
<strong>Artisanry:get_blueprints (input)</strong>
</dt>
<dd>
Gets all BluePrints matching the given input.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
The input, a 2D of strings or ItemStacks. Might be nil to
retrieve all BluePrints.
</li>
</ul>
<h3>Returns:</h3>
<ol>
All matching BluePrints.
</ol>
</dd>
<dt>
<a name = "Artisanry:get_blueprints_from_output"></a>
<strong>Artisanry:get_blueprints_from_output (output)</strong>
</dt>
<dd>
Gets all BluePrints that match the given output.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">output</span>
The output. Can either be an ItemStack, item string or id.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The List containing all Blueprints that match the given output.
</ol>
</dd>
<dt>
<a name = "Artisanry:register"></a>
<strong>Artisanry:register (result, input)</strong>
</dt>
<dd>
Registers the given input for the given result.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">result</span>
The result of the input, an item string.
</li>
<li><span class="parameter">input</span>
The 2D array of item strings or ItemStacks.
</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.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

335
doc/modules/artisanryui.html Normal file
View File

@ -0,0 +1,335 @@
<!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/artisanry.html">artisanry</a></li>
<li><a href="../modules/blueprint.html">blueprint</a></li>
<li><a href="../modules/artisanryutil.html">artisanryutil</a></li>
<li><strong>artisanryui</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>artisanryui</code></h1>
<p>ArtisanryUI is a static, global object that allows to replace the inventory
with the Artisanry one.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.activate">ArtisanryUI.activate (artisanry)</a></td>
<td class="summary">Activates the ArtinsaryUI.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.build_formspec">ArtisanryUI.build_formspec (player)</a></td>
<td class="summary">Builds the formspec for the ArtisanryUI inventory.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.create_inventory">ArtisanryUI.create_inventory ()</a></td>
<td class="summary">Creates a detached inventory that is used.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.has_changed">ArtisanryUI.has_changed (player, inventory_name)</a></td>
<td class="summary">Checks if the inventory has changed compared to the saved hash.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.put_hash">ArtisanryUI.put_hash (player, inventory_name)</a></td>
<td class="summary">Puts the hash of the inventory, for using it later.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.replace_inventories">ArtisanryUI.replace_inventories ()</a></td>
<td class="summary">Replaces the inventory of every currently connected player with
the ArtisanryUI one.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.replace_inventory">ArtisanryUI.replace_inventory (player)</a></td>
<td class="summary">Replaces the inventory of the given player with the ArtisanryUI one.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.update_inventory">ArtisanryUI.update_inventory (player, force_update)</a></td>
<td class="summary">Updates the inventory of the given player.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.update_from_input_inventory">ArtisanryUI.update_from_input_inventory (player)</a></td>
<td class="summary">Updates from the input inventory of the given player.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ArtisanryUI.update_from_output_inventory">ArtisanryUI.update_from_output_inventory (player)</a></td>
<td class="summary">Updates from the output inventory of the given player.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "ArtisanryUI.activate"></a>
<strong>ArtisanryUI.activate (artisanry)</strong>
</dt>
<dd>
Activates the ArtinsaryUI.
<p> This function replaces all inventories of all currently coneccted players
and also registers a callback to replace the inventory of every new player.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">artisanry</span>
The Artisanry instance to use.
</li>
</ul>
</dd>
<dt>
<a name = "ArtisanryUI.build_formspec"></a>
<strong>ArtisanryUI.build_formspec (player)</strong>
</dt>
<dd>
Builds the formspec for the ArtisanryUI inventory.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The player.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The formspec for the inventory.
</ol>
</dd>
<dt>
<a name = "ArtisanryUI.create_inventory"></a>
<strong>ArtisanryUI.create_inventory ()</strong>
</dt>
<dd>
Creates a detached inventory that is used.
<h3>Returns:</h3>
<ol>
The detached inventory.
</ol>
</dd>
<dt>
<a name = "ArtisanryUI.has_changed"></a>
<strong>ArtisanryUI.has_changed (player, inventory_name)</strong>
</dt>
<dd>
Checks if the inventory has changed compared to the saved hash.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The Player object that owns the inventory.
</li>
<li><span class="parameter">inventory_name</span>
The name of the inventory.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if the inventory has changed since the last check. Also true if
there is no saved hash for this inventory.
</ol>
</dd>
<dt>
<a name = "ArtisanryUI.put_hash"></a>
<strong>ArtisanryUI.put_hash (player, inventory_name)</strong>
</dt>
<dd>
Puts the hash of the inventory, for using it later.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The Player object that owns the inventory.
</li>
<li><span class="parameter">inventory_name</span>
The name of the inventory.
</li>
</ul>
</dd>
<dt>
<a name = "ArtisanryUI.replace_inventories"></a>
<strong>ArtisanryUI.replace_inventories ()</strong>
</dt>
<dd>
Replaces the inventory of every currently connected player with
the ArtisanryUI one.
</dd>
<dt>
<a name = "ArtisanryUI.replace_inventory"></a>
<strong>ArtisanryUI.replace_inventory (player)</strong>
</dt>
<dd>
Replaces the inventory of the given player with the ArtisanryUI one.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The player for which to replace the inventory.
</li>
</ul>
</dd>
<dt>
<a name = "ArtisanryUI.update_inventory"></a>
<strong>ArtisanryUI.update_inventory (player, force_update)</strong>
</dt>
<dd>
Updates the inventory of the given player.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The player for which to update the inventory.
</li>
<li><span class="parameter">force_update</span>
Optional. If an update should be forced.
</li>
</ul>
</dd>
<dt>
<a name = "ArtisanryUI.update_from_input_inventory"></a>
<strong>ArtisanryUI.update_from_input_inventory (player)</strong>
</dt>
<dd>
Updates from the input inventory of the given player.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The player for which to update the inventories.
</li>
</ul>
</dd>
<dt>
<a name = "ArtisanryUI.update_from_output_inventory"></a>
<strong>ArtisanryUI.update_from_output_inventory (player)</strong>
</dt>
<dd>
Updates from the output inventory of the given player.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">player</span>
The player for which to update the inventories.
</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.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

196
doc/modules/artisanryutil.html Normal file
View File

@ -0,0 +1,196 @@
<!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/artisanry.html">artisanry</a></li>
<li><a href="../modules/blueprint.html">blueprint</a></li>
<li><strong>artisanryutil</strong></li>
<li><a href="../modules/artisanryui.html">artisanryui</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>artisanryutil</code></h1>
<p>Converts the given input from strings to ItemStacks.</p>
<p> If the values are
already ItemStacks, they are only copied.
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#convert">convert (input, The)</a></td>
<td class="summary">Reduces and converts the given input to ItemStacks.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#flat_to_grid">flat_to_grid (flat)</a></td>
<td class="summary">Converts the given data from a flat array to a 2D array.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_empty_item">is_empty_item (item)</a></td>
<td class="summary">Checks if the given item is empty.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#is_empty_stacks">is_empty_stacks (input)</a></td>
<td class="summary">Checks if the given array of ItemStacks is empty, meaning either all
are nil, or all are empty.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "convert"></a>
<strong>convert (input, The)</strong>
</dt>
<dd>
Reduces and converts the given input to ItemStacks.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
The input to convert.
</li>
<li><span class="parameter">The</span>
converted input.
</li>
</ul>
</dd>
<dt>
<a name = "flat_to_grid"></a>
<strong>flat_to_grid (flat)</strong>
</dt>
<dd>
Converts the given data from a flat array to a 2D array.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">flat</span>
The data to convert.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The grid data.
</ol>
</dd>
<dt>
<a name = "is_empty_item"></a>
<strong>is_empty_item (item)</strong>
</dt>
<dd>
Checks if the given item is empty. That means if it is either nil, an empty
string or an ItemStack that is empty.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">item</span>
The item to check.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if the item can be considered empty.
</ol>
</dd>
<dt>
<a name = "is_empty_stacks"></a>
<strong>is_empty_stacks (input)</strong>
</dt>
<dd>
Checks if the given array of ItemStacks is empty, meaning either all
are nil, or all are empty.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
The array of ItemStacks.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if all are nil or empty.
</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.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>

223
doc/modules/blueprint.html Normal file
View File

@ -0,0 +1,223 @@
<!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/artisanry.html">artisanry</a></li>
<li><strong>blueprint</strong></li>
<li><a href="../modules/artisanryutil.html">artisanryutil</a></li>
<li><a href="../modules/artisanryui.html">artisanryui</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>blueprint</code></h1>
<p>The Blueprint is a receipt used by Artisanry.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Blueprint:new">Blueprint:new (result, input)</a></td>
<td class="summary">Creates a new instance of Blueprint.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:count">Blueprint:count (input)</a></td>
<td class="summary">Gets the count how often this output can be produced from the given
input.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:get_input">Blueprint:get_input ()</a></td>
<td class="summary">Gets the input for this Blueprint.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:get_result">Blueprint:get_result (input)</a></td>
<td class="summary">Gets the result for this Blueprint.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Blueprint:match">Blueprint:match (input)</a></td>
<td class="summary">Matches this blueprint against the given input.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "Blueprint:new"></a>
<strong>Blueprint:new (result, input)</strong>
</dt>
<dd>
Creates a new instance of Blueprint.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">result</span>
The result of the blueprint, an item string like "sand 5"
or "glass".
</li>
<li><span class="parameter">input</span>
The input for the blueprint, a 2D array with 5 rows and columns.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The new instance of Blueprint.
</ol>
</dd>
<dt>
<a name = "Blueprint:count"></a>
<strong>Blueprint:count (input)</strong>
</dt>
<dd>
Gets the count how often this output can be produced from the given
input. The input must match.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
The input, already matched against this Blueprint.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The count how often this output can be produced.
</ol>
</dd>
<dt>
<a name = "Blueprint:get_input"></a>
<strong>Blueprint:get_input ()</strong>
</dt>
<dd>
Gets the input for this Blueprint.
<h3>Returns:</h3>
<ol>
The input of this Blueprint, a 2D array..
</ol>
</dd>
<dt>
<a name = "Blueprint:get_result"></a>
<strong>Blueprint:get_result (input)</strong>
</dt>
<dd>
Gets the result for this Blueprint.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
Optional. The input stack, will be used to determine
the count of the result.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The result, an ItemStack.
</ol>
</dd>
<dt>
<a name = "Blueprint:match"></a>
<strong>Blueprint:match (input)</strong>
</dt>
<dd>
Matches this blueprint against the given input.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">input</span>
The input, already reduced and converted to ItemStacks.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if this blueprint matches the given input.
</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.2</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>