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

Changed to LDoc.

master
Robert Zenz 2015-08-14 22:10:01 +02:00
parent 0af1559152
commit f0b047ad45
12 changed files with 1172 additions and 1854 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/worldgen_utils
ldoc --dir=$(doc) mods/worldgen_utils
.SILENT .PHONY: test
test: $(test)/*.lua

106
doc/files/mods/worldgen_utils/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/worldgen_utils/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><strong>mods/worldgen_utils/init.lua</strong></li>
<li>
<a href="../../../files/mods/worldgen_utils/ramps/rampgen.html">mods/worldgen_utils/ramps/rampgen.lua</a>
</li>
<li>
<a href="../../../files/mods/worldgen_utils/ramps/rampplacer.html">mods/worldgen_utils/ramps/rampplacer.lua</a>
</li>
<li>
<a href="../../../files/mods/worldgen_utils/ramps/ramputil.html">mods/worldgen_utils/ramps/ramputil.lua</a>
</li>
<li>
<a href="../../../files/mods/worldgen_utils/worldgenutil.html">mods/worldgen_utils/worldgenutil.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/worldgen_utils/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>

300
doc/files/mods/worldgen_utils/ramps/rampgen.html
View File

@ -1,300 +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/worldgen_utils/ramps/rampgen.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/worldgen_utils/init.html">mods/worldgen_utils/init.lua</a>
</li>
<li><strong>mods/worldgen_utils/ramps/rampgen.lua</strong></li>
<li>
<a href="../../../../files/mods/worldgen_utils/ramps/rampplacer.html">mods/worldgen_utils/ramps/rampplacer.lua</a>
</li>
<li>
<a href="../../../../files/mods/worldgen_utils/ramps/ramputil.html">mods/worldgen_utils/ramps/ramputil.lua</a>
</li>
<li>
<a href="../../../../files/mods/worldgen_utils/worldgenutil.html">mods/worldgen_utils/worldgenutil.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/worldgen_utils/ramps/rampgen.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#rampgen.init_templates">rampgen.init_templates</a>&nbsp;()</td>
<td class="summary">Initializes the templates.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rampgen.is_air">rampgen.is_air</a>&nbsp;(node)</td>
<td class="summary">Checks if the given node is "air".</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rampgen.mask_value_equals">rampgen.mask_value_equals</a>&nbsp;(actual, mask)</td>
<td class="summary">Equals function for the mask values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rampgen.run">rampgen.run</a>&nbsp;(manipulator, minp, maxp, nodes)</td>
<td class="summary">Runs the RampGen and creates ramps in the world.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#rampgen.run_on_node">rampgen.run_on_node</a>&nbsp;(manipulator, x, z, y, nodes)</td>
<td class="summary">Creates a ramp (or not) on the given location.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="rampgen.init_templates"></a><strong>rampgen.init_templates</strong>&nbsp;()</dt>
<dd>
Initializes the templates.
</dd>
<dt><a name="rampgen.is_air"></a><strong>rampgen.is_air</strong>&nbsp;(node)</dt>
<dd>
Checks if the given node is "air".
<h3>Parameters</h3>
<ul>
<li>
node: The node to check.
</li>
</ul>
<h3>Return value:</h3>
true if the node is air.
</dd>
<dt><a name="rampgen.mask_value_equals"></a><strong>rampgen.mask_value_equals</strong>&nbsp;(actual, mask)</dt>
<dd>
Equals function for the mask values.
<h3>Parameters</h3>
<ul>
<li>
actual: The atual value, generated from the map.
</li>
<li>
mask: The mask value, from the templates.
</li>
</ul>
<h3>Return value:</h3>
true if the values equal.
</dd>
<dt><a name="rampgen.run"></a><strong>rampgen.run</strong>&nbsp;(manipulator, minp, maxp, nodes)</dt>
<dd>
Runs the RampGen and creates ramps in the world.
<h3>Parameters</h3>
<ul>
<li>
manipulator: The MapManipulator to use.
</li>
<li>
minp: The minimum point.
</li>
<li>
maxp: The maximum point.
</li>
<li>
nodes: The lookup table for the ramp creation. The lookup table consists of entries with the ID of the node as key and the three ramps. Example: { 45 = { param_floor = true, param_ceiling = true, ramp = ramp_node, inner = inner_corner_node, outer = outer_corner_node }}
</li>
</ul>
</dd>
<dt><a name="rampgen.run_on_node"></a><strong>rampgen.run_on_node</strong>&nbsp;(manipulator, x, z, y, nodes)</dt>
<dd>
Creates a ramp (or not) on the given location.
<h3>Parameters</h3>
<ul>
<li>
manipulator: The MapManipulator to use.
</li>
<li>
x: The x coordinate.
</li>
<li>
z: The z coordinate.
</li>
<li>
y: The y coordinate.
</li>
<li>
nodes: The lookup table for the ramp creation. The lookup table consists of entries with the ID of the node as key and the three ramps. Example: { 45 = { param_floor = true, param_ceiling = true, ramp = ramp_node, inner = inner_corner_node, outer = outer_corner_node }}
</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>

412
doc/files/mods/worldgen_utils/ramps/rampplacer.html
View File

@ -1,412 +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/worldgen_utils/ramps/rampplacer.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/worldgen_utils/init.html">mods/worldgen_utils/init.lua</a>
</li>
<li>
<a href="../../../../files/mods/worldgen_utils/ramps/rampgen.html">mods/worldgen_utils/ramps/rampgen.lua</a>
</li>
<li><strong>mods/worldgen_utils/ramps/rampplacer.lua</strong></li>
<li>
<a href="../../../../files/mods/worldgen_utils/ramps/ramputil.html">mods/worldgen_utils/ramps/ramputil.lua</a>
</li>
<li>
<a href="../../../../files/mods/worldgen_utils/worldgenutil.html">mods/worldgen_utils/worldgenutil.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/worldgen_utils/ramps/rampplacer.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#RampPlacer.is_air">RampPlacer.is_air</a>&nbsp;(node)</td>
<td class="summary">Checks if the given node is "air".</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer.mask_value_equals">RampPlacer.mask_value_equals</a>&nbsp;(actual, mask)</td>
<td class="summary">Equals function for the mask values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:new">RampPlacer:new</a>&nbsp;()</td>
<td class="summary">Creates a new instance of RampPlacer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:place_ramp">RampPlacer:place_ramp</a>&nbsp;(x, z, y, manipulator, template, node_info, node_mask, below_air, above_air)</td>
<td class="summary">Places a ramp here if possible.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:register_ramp">RampPlacer:register_ramp</a>&nbsp;(node, ramp_node, inner_corner_node, outer_corner_node, floor, ceiling)</td>
<td class="summary">Registers a ramp with this RampPlacer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:run">RampPlacer:run</a>&nbsp;(manipulator, minp, maxp)</td>
<td class="summary">Places ramps in the given area.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:run_on_node">RampPlacer:run_on_node</a>&nbsp;(manipulator, x, z, y)</td>
<td class="summary">Places a ramp (or not) on the given location.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="RampPlacer.is_air"></a><strong>RampPlacer.is_air</strong>&nbsp;(node)</dt>
<dd>
Checks if the given node is "air".
<h3>Parameters</h3>
<ul>
<li>
node: The node to check.
</li>
</ul>
<h3>Return value:</h3>
true if the node is air.
</dd>
<dt><a name="RampPlacer.mask_value_equals"></a><strong>RampPlacer.mask_value_equals</strong>&nbsp;(actual, mask)</dt>
<dd>
Equals function for the mask values.
<h3>Parameters</h3>
<ul>
<li>
actual: The atual value, generated from the map.
</li>
<li>
mask: The mask value, from the templates.
</li>
</ul>
<h3>Return value:</h3>
true if the values equal.
</dd>
<dt><a name="RampPlacer:new"></a><strong>RampPlacer:new</strong>&nbsp;()</dt>
<dd>
Creates a new instance of RampPlacer.
<h3>Return value:</h3>
A new instance of RampPlacer.
</dd>
<dt><a name="RampPlacer:place_ramp"></a><strong>RampPlacer:place_ramp</strong>&nbsp;(x, z, y, manipulator, template, node_info, node_mask, below_air, above_air)</dt>
<dd>
Places a ramp here if possible.
<h3>Parameters</h3>
<ul>
<li>
x: The x coordinate.
</li>
<li>
z: The z coordinate.
</li>
<li>
y: The y coordinate.
</li>
<li>
manipulator: The manipulator.
</li>
<li>
template: The ramp template to use.
</li>
<li>
node_info: The node information to use.
</li>
<li>
node_mask:
</li>
<li>
below_air: If the node is below air.
</li>
<li>
above_air: If the node is above air.
</li>
</ul>
<h3>Return value:</h3>
true If a ramp is placed.
</dd>
<dt><a name="RampPlacer:register_ramp"></a><strong>RampPlacer:register_ramp</strong>&nbsp;(node, ramp_node, inner_corner_node, outer_corner_node, floor, ceiling)</dt>
<dd>
Registers a ramp with this RampPlacer.
<h3>Parameters</h3>
<ul>
<li>
node: The base node.
</li>
<li>
ramp_node: The ramp node.
</li>
<li>
inner_corner_node: The inner corner node.
</li>
<li>
outer_corner_node: The outer corner node.
</li>
<li>
floor: If ramps should appear on the floor.
</li>
<li>
ceiling: If ramps should appear on the ceiling.
</li>
</ul>
</dd>
<dt><a name="RampPlacer:run"></a><strong>RampPlacer:run</strong>&nbsp;(manipulator, minp, maxp)</dt>
<dd>
Places ramps in the given area.
<h3>Parameters</h3>
<ul>
<li>
manipulator: The MapManipulator to use.
</li>
<li>
minp: The minimum point.
</li>
<li>
maxp: The maximum point.
</li>
</ul>
</dd>
<dt><a name="RampPlacer:run_on_node"></a><strong>RampPlacer:run_on_node</strong>&nbsp;(manipulator, x, z, y)</dt>
<dd>
Places a ramp (or not) on the given location.
<h3>Parameters</h3>
<ul>
<li>
manipulator: The MapManipulator to use.
</li>
<li>
x: The x coordinate.
</li>
<li>
z: The z coordinate.
</li>
<li>
y: The y coordinate.
</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>

454
doc/files/mods/worldgen_utils/ramps/ramputil.html
View File

@ -1,454 +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/worldgen_utils/ramps/ramputil.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/worldgen_utils/init.html">mods/worldgen_utils/init.lua</a>
</li>
<li>
<a href="../../../../files/mods/worldgen_utils/ramps/rampgen.html">mods/worldgen_utils/ramps/rampgen.lua</a>
</li>
<li>
<a href="../../../../files/mods/worldgen_utils/ramps/rampplacer.html">mods/worldgen_utils/ramps/rampplacer.lua</a>
</li>
<li><strong>mods/worldgen_utils/ramps/ramputil.lua</strong></li>
<li>
<a href="../../../../files/mods/worldgen_utils/worldgenutil.html">mods/worldgen_utils/worldgenutil.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/worldgen_utils/ramps/ramputil.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#ramputil.create_inner_corner_nodebox">ramputil.create_inner_corner_nodebox</a>&nbsp;(detail)</td>
<td class="summary">Creates the nodebox for an inner corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_inner_steep_corner_nodebox">ramputil.create_inner_steep_corner_nodebox</a>&nbsp;(detail)</td>
<td class="summary">Creates the nodebox for an inner steep corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_lookup_table">ramputil.create_lookup_table</a>&nbsp;(node_name, ramp_name, inner_corner_name, outer_corner_name)</td>
<td class="summary">Creates the lookup table for the given nodes which is used by rampgen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_outer_corner_nodebox">ramputil.create_outer_corner_nodebox</a>&nbsp;(detail)</td>
<td class="summary">Creates the nodebox for an outer corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_outer_steep_corner_nodebox">ramputil.create_outer_steep_corner_nodebox</a>&nbsp;(detail)</td>
<td class="summary">Creates the nodebox for an outer steep corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_ramp_from_node">ramputil.create_ramp_from_node</a>&nbsp;(node, use_mesh, nodebox_detail)</td>
<td class="summary">Creates ramps (ramp, inner and outer corner) for the given node.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_ramp_nodebox">ramputil.create_ramp_nodebox</a>&nbsp;(detail)</td>
<td class="summary">Creates the nodebox for a ramp.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.create_steep_ramp_nodebox">ramputil.create_steep_ramp_nodebox</a>&nbsp;(detail)</td>
<td class="summary">Creates the nodebox for a steep ramp.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#ramputil.register_ramps_for_node">ramputil.register_ramps_for_node</a>&nbsp;(node, base_name, use_mesh, nodebox_detail)</td>
<td class="summary">Creates and registers ramps (ramp, inner and outer corner) for the given node.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="ramputil.create_inner_corner_nodebox"></a><strong>ramputil.create_inner_corner_nodebox</strong>&nbsp;(detail)</dt>
<dd>
Creates the nodebox for an inner corner.
<h3>Parameters</h3>
<ul>
<li>
detail: The level of detail, basically how many steps the ramp will have.
</li>
</ul>
<h3>Return value:</h3>
The nodebox for an inner corner.
</dd>
<dt><a name="ramputil.create_inner_steep_corner_nodebox"></a><strong>ramputil.create_inner_steep_corner_nodebox</strong>&nbsp;(detail)</dt>
<dd>
Creates the nodebox for an inner steep corner.
<h3>Parameters</h3>
<ul>
<li>
detail: The level of detail, basically how many steps the ramp will have.
</li>
</ul>
<h3>Return value:</h3>
The nodebox for an inner steep corner.
</dd>
<dt><a name="ramputil.create_lookup_table"></a><strong>ramputil.create_lookup_table</strong>&nbsp;(node_name, ramp_name, inner_corner_name, outer_corner_name)</dt>
<dd>
Creates the lookup table for the given nodes which is used by rampgen.
<h3>Parameters</h3>
<ul>
<li>
node_name: The name of the node,
</li>
<li>
ramp_name: The name of the ramp.
</li>
<li>
inner_corner_name: The name of the inner corner part.
</li>
<li>
outer_corner_name: The name of the outer corner part.
</li>
</ul>
<h3>Return value:</h3>
The lookup table for these nodes.
</dd>
<dt><a name="ramputil.create_outer_corner_nodebox"></a><strong>ramputil.create_outer_corner_nodebox</strong>&nbsp;(detail)</dt>
<dd>
Creates the nodebox for an outer corner.
<h3>Parameters</h3>
<ul>
<li>
detail: The level of detail, basically how many steps the ramp will have.
</li>
</ul>
<h3>Return value:</h3>
The nodebox for an outer corner.
</dd>
<dt><a name="ramputil.create_outer_steep_corner_nodebox"></a><strong>ramputil.create_outer_steep_corner_nodebox</strong>&nbsp;(detail)</dt>
<dd>
Creates the nodebox for an outer steep corner.
<h3>Parameters</h3>
<ul>
<li>
detail: The level of detail, basically how many steps the ramp will have.
</li>
</ul>
<h3>Return value:</h3>
The nodebox for an outer steep corner.
</dd>
<dt><a name="ramputil.create_ramp_from_node"></a><strong>ramputil.create_ramp_from_node</strong>&nbsp;(node, use_mesh, nodebox_detail)</dt>
<dd>
Creates ramps (ramp, inner and outer corner) for the given node.
<h3>Parameters</h3>
<ul>
<li>
node: The node description (table), or the node name.
</li>
<li>
use_mesh: If the created nodes should use a mesh instead of nodeboxes.
</li>
<li>
nodebox_detail: The detail level of the nodeboxes. Even if a mesh is used, the nodebox is still created for the collision box.
</li>
</ul>
<h3>Return value:</h3>
The node descriptions for the ramp, inner and outer corner.
</dd>
<dt><a name="ramputil.create_ramp_nodebox"></a><strong>ramputil.create_ramp_nodebox</strong>&nbsp;(detail)</dt>
<dd>
Creates the nodebox for a ramp.
<h3>Parameters</h3>
<ul>
<li>
detail: The level of detail, basically how many steps the ramp will have.
</li>
</ul>
<h3>Return value:</h3>
The nodebox for a ramp.
</dd>
<dt><a name="ramputil.create_steep_ramp_nodebox"></a><strong>ramputil.create_steep_ramp_nodebox</strong>&nbsp;(detail)</dt>
<dd>
Creates the nodebox for a steep ramp.
<h3>Parameters</h3>
<ul>
<li>
detail: The level of detail, basically how many steps the ramp will have.
</li>
</ul>
<h3>Return value:</h3>
The nodebox for a steep ramp.
</dd>
<dt><a name="ramputil.register_ramps_for_node"></a><strong>ramputil.register_ramps_for_node</strong>&nbsp;(node, base_name, use_mesh, nodebox_detail)</dt>
<dd>
Creates and registers ramps (ramp, inner and outer corner) for the given node.
<h3>Parameters</h3>
<ul>
<li>
node: The node description (table), or the node name.
</li>
<li>
base_name: The base name for the new nodes.
</li>
<li>
use_mesh: If the created nodes should use a mesh instead of nodeboxes.
</li>
<li>
nodebox_detail: The detail level of the nodeboxes. Even if a mesh is used, the nodebox is still created for the collision box.
</li>
</ul>
<h3>Return value:</h3>
The lookup entry used by rampmaker. That's a table that holds the three nodes.
</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>

206
doc/files/mods/worldgen_utils/worldgenutil.html
View File

@ -1,206 +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/worldgen_utils/worldgenutil.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/worldgen_utils/init.html">mods/worldgen_utils/init.lua</a>
</li>
<li>
<a href="../../../files/mods/worldgen_utils/ramps/rampgen.html">mods/worldgen_utils/ramps/rampgen.lua</a>
</li>
<li>
<a href="../../../files/mods/worldgen_utils/ramps/rampplacer.html">mods/worldgen_utils/ramps/rampplacer.lua</a>
</li>
<li>
<a href="../../../files/mods/worldgen_utils/ramps/ramputil.html">mods/worldgen_utils/ramps/ramputil.lua</a>
</li>
<li><strong>mods/worldgen_utils/worldgenutil.lua</strong></li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>mods/worldgen_utils/worldgenutil.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#worldgenutil.iterate2d">worldgenutil.iterate2d</a>&nbsp;(minp, maxp, action, action_x)</td>
<td class="summary">Iterates over all two dimensions, from the given minimum point to the given maximum point.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#worldgenutil.iterate3d">worldgenutil.iterate3d</a>&nbsp;(minp, maxp, action, action_x, action_z)</td>
<td class="summary">Iterates over all three dimensions, from the given minimum point to the given maximum point.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="worldgenutil.iterate2d"></a><strong>worldgenutil.iterate2d</strong>&nbsp;(minp, maxp, action, action_x)</dt>
<dd>
Iterates over all two dimensions, from the given minimum point to the given maximum point.
<h3>Parameters</h3>
<ul>
<li>
minp: The minimum point.
</li>
<li>
maxp: The maximum point.
</li>
<li>
action: The action to execute on every point.
</li>
<li>
action_x: Optional. The action to execute on every x step.
</li>
</ul>
</dd>
<dt><a name="worldgenutil.iterate3d"></a><strong>worldgenutil.iterate3d</strong>&nbsp;(minp, maxp, action, action_x, action_z)</dt>
<dd>
Iterates over all three dimensions, from the given minimum point to the given maximum point.
<h3>Parameters</h3>
<ul>
<li>
minp: The minimum point.
</li>
<li>
maxp: The maximum point.
</li>
<li>
action: The action to execute on every point.
</li>
<li>
action_x: Optional. The action to execute on every x step.
</li>
<li>
action_z: Optional. The action to execute on every z step.
</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>

125
doc/index.html
View File

@ -1,121 +1,68 @@
<?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/worldgenutil.html">worldgenutil</a></li>
<li><a href="modules/ramps.rampplacer.html">ramps.rampplacer</a></li>
<li><a href="modules/ramps.ramputil.html">ramps.ramputil</a></li>
</ul>
<!-- Module list -->
<!-- File list -->
<h1>Files</h1>
<ul>
<li>
<a href="files/mods/worldgen_utils/init.html">mods/worldgen_utils/init.lua</a>
</li>
<li>
<a href="files/mods/worldgen_utils/ramps/rampgen.html">mods/worldgen_utils/ramps/rampgen.lua</a>
</li>
<li>
<a href="files/mods/worldgen_utils/ramps/rampplacer.html">mods/worldgen_utils/ramps/rampplacer.lua</a>
</li>
<li>
<a href="files/mods/worldgen_utils/ramps/ramputil.html">mods/worldgen_utils/ramps/ramputil.lua</a>
</li>
<li>
<a href="files/mods/worldgen_utils/worldgenutil.html">mods/worldgen_utils/worldgenutil.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/worldgen_utils/init.html">mods/worldgen_utils/init.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/worldgen_utils/ramps/rampgen.html">mods/worldgen_utils/ramps/rampgen.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/worldgen_utils/ramps/rampplacer.html">mods/worldgen_utils/ramps/rampplacer.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/worldgen_utils/ramps/ramputil.html">mods/worldgen_utils/ramps/ramputil.lua</a></td>
<td class="summary"></td>
</tr>
<tr>
<td class="name"><a href="files/mods/worldgen_utils/worldgenutil.html">mods/worldgen_utils/worldgenutil.lua</a></td>
<td class="summary"></td>
</tr>
<h2>Modules</h2>
<table class="module_list">
<tr>
<td class="name" nowrap><a href="modules/worldgenutil.html">worldgenutil</a></td>
<td class="summary">Provides various utility functions for generation worlds.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ramps.rampplacer.html">ramps.rampplacer</a></td>
<td class="summary">RampPlacer is an object that allows to place ramps in the world.</td>
</tr>
<tr>
<td class="name" nowrap><a href="modules/ramps.ramputil.html">ramps.ramputil</a></td>
<td class="summary">Utility functions for the creation and registration of ramps.</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

312
doc/modules/ramps.rampplacer.html Normal file
View File

@ -0,0 +1,312 @@
<!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/worldgenutil.html">worldgenutil</a></li>
<li><strong>ramps.rampplacer</strong></li>
<li><a href="../modules/ramps.ramputil.html">ramps.ramputil</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>ramps.rampplacer</code></h1>
<p>RampPlacer is an object that allows to place ramps in the world.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#RampPlacer:new">RampPlacer:new ()</a></td>
<td class="summary">Creates a new instance of RampPlacer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer.is_air">RampPlacer.is_air (node)</a></td>
<td class="summary">Checks if the given node is "air".</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer.mask_value_equals">RampPlacer.mask_value_equals (actual, mask)</a></td>
<td class="summary">Equals function for the mask values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:place_ramp">RampPlacer:place_ramp (x, z, y, manipulator, template, node_info, below_air, above_air)</a></td>
<td class="summary">Places a ramp here if possible.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:register_ramp">RampPlacer:register_ramp (node, ramp_node, inner_corner_node, outer_corner_node, floor, ceiling)</a></td>
<td class="summary">Registers a ramp with this RampPlacer.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:run">RampPlacer:run (manipulator, minp, maxp)</a></td>
<td class="summary">Places ramps in the given area.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#RampPlacer:run_on_node">RampPlacer:run_on_node (manipulator, x, z, y)</a></td>
<td class="summary">Places a ramp (or not) on the given location.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "RampPlacer:new"></a>
<strong>RampPlacer:new ()</strong>
</dt>
<dd>
Creates a new instance of RampPlacer.
<h3>Returns:</h3>
<ol>
A new instance of RampPlacer.
</ol>
</dd>
<dt>
<a name = "RampPlacer.is_air"></a>
<strong>RampPlacer.is_air (node)</strong>
</dt>
<dd>
Checks if the given node is "air".
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">node</span>
The node to check.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if the node is air.
</ol>
</dd>
<dt>
<a name = "RampPlacer.mask_value_equals"></a>
<strong>RampPlacer.mask_value_equals (actual, mask)</strong>
</dt>
<dd>
Equals function for the mask values.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">actual</span>
The atual value, generated from the map.
</li>
<li><span class="parameter">mask</span>
The mask value, from the templates.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true if the values equal.
</ol>
</dd>
<dt>
<a name = "RampPlacer:place_ramp"></a>
<strong>RampPlacer:place_ramp (x, z, y, manipulator, template, node_info, below_air, above_air)</strong>
</dt>
<dd>
Places a ramp here if possible.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">x</span>
The x coordinate.
</li>
<li><span class="parameter">z</span>
The z coordinate.
</li>
<li><span class="parameter">y</span>
The y coordinate.
</li>
<li><span class="parameter">manipulator</span>
The manipulator.
</li>
<li><span class="parameter">template</span>
The ramp template to use.
</li>
<li><span class="parameter">node_info</span>
The node information to use.
</li>
<li><span class="parameter">below_air</span>
If the node is below air.
</li>
<li><span class="parameter">above_air</span>
If the node is above air.
</li>
</ul>
<h3>Returns:</h3>
<ol>
true If a ramp is placed.
</ol>
</dd>
<dt>
<a name = "RampPlacer:register_ramp"></a>
<strong>RampPlacer:register_ramp (node, ramp_node, inner_corner_node, outer_corner_node, floor, ceiling)</strong>
</dt>
<dd>
Registers a ramp with this RampPlacer.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">node</span>
The base node.
</li>
<li><span class="parameter">ramp_node</span>
The ramp node.
</li>
<li><span class="parameter">inner_corner_node</span>
The inner corner node.
</li>
<li><span class="parameter">outer_corner_node</span>
The outer corner node.
</li>
<li><span class="parameter">floor</span>
If ramps should appear on the floor.
</li>
<li><span class="parameter">ceiling</span>
If ramps should appear on the ceiling.
</li>
</ul>
</dd>
<dt>
<a name = "RampPlacer:run"></a>
<strong>RampPlacer:run (manipulator, minp, maxp)</strong>
</dt>
<dd>
Places ramps in the given area.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">manipulator</span>
The MapManipulator to use.
</li>
<li><span class="parameter">minp</span>
The minimum point.
</li>
<li><span class="parameter">maxp</span>
The maximum point.
</li>
</ul>
</dd>
<dt>
<a name = "RampPlacer:run_on_node"></a>
<strong>RampPlacer:run_on_node (manipulator, x, z, y)</strong>
</dt>
<dd>
Places a ramp (or not) on the given location.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">manipulator</span>
The MapManipulator to use.
</li>
<li><span class="parameter">x</span>
The x coordinate.
</li>
<li><span class="parameter">z</span>
The z coordinate.
</li>
<li><span class="parameter">y</span>
The y coordinate.
</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>

373
doc/modules/ramps.ramputil.html Normal file
View File

@ -0,0 +1,373 @@
<!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/worldgenutil.html">worldgenutil</a></li>
<li><a href="../modules/ramps.rampplacer.html">ramps.rampplacer</a></li>
<li><strong>ramps.ramputil</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>ramps.ramputil</code></h1>
<p>Utility functions for the creation and registration of ramps.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#create_inner_corner_nodebox">create_inner_corner_nodebox (detail)</a></td>
<td class="summary">Creates the nodebox for an inner corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_inner_steep_corner_nodebox">create_inner_steep_corner_nodebox (detail)</a></td>
<td class="summary">Creates the nodebox for an inner steep corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_lookup_table">create_lookup_table (node_name, ramp_name, inner_corner_name, outer_corner_name)</a></td>
<td class="summary">Creates the lookup table for the given nodes which is used by rampgen.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_outer_corner_nodebox">create_outer_corner_nodebox (detail)</a></td>
<td class="summary">Creates the nodebox for an outer corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_outer_steep_corner_nodebox">create_outer_steep_corner_nodebox (detail)</a></td>
<td class="summary">Creates the nodebox for an outer steep corner.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_ramp_from_node">create_ramp_from_node (node, use_mesh, nodebox_detail)</a></td>
<td class="summary">Creates ramps (ramp, inner and outer corner) for the given node.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_ramp_nodebox">create_ramp_nodebox (detail)</a></td>
<td class="summary">Creates the nodebox for a ramp.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#create_steep_ramp_nodebox">create_steep_ramp_nodebox (detail)</a></td>
<td class="summary">Creates the nodebox for a steep ramp.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#register_ramps_for_node">register_ramps_for_node (node, base_name, use_mesh, nodebox_detail)</a></td>
<td class="summary">Creates and registers ramps (ramp, inner and outer corner) for the given
node.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "create_inner_corner_nodebox"></a>
<strong>create_inner_corner_nodebox (detail)</strong>
</dt>
<dd>
Creates the nodebox for an inner corner.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">detail</span>
The level of detail, basically how many steps the ramp will
have.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The nodebox for an inner corner.
</ol>
</dd>
<dt>
<a name = "create_inner_steep_corner_nodebox"></a>
<strong>create_inner_steep_corner_nodebox (detail)</strong>
</dt>
<dd>
Creates the nodebox for an inner steep corner.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">detail</span>
The level of detail, basically how many steps the ramp will
have.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The nodebox for an inner steep corner.
</ol>
</dd>
<dt>
<a name = "create_lookup_table"></a>
<strong>create_lookup_table (node_name, ramp_name, inner_corner_name, outer_corner_name)</strong>
</dt>
<dd>
Creates the lookup table for the given nodes which is used by rampgen.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">node_name</span>
The name of the node,
</li>
<li><span class="parameter">ramp_name</span>
The name of the ramp.
</li>
<li><span class="parameter">inner_corner_name</span>
The name of the inner corner part.
</li>
<li><span class="parameter">outer_corner_name</span>
The name of the outer corner part.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The lookup table for these nodes.
</ol>
</dd>
<dt>
<a name = "create_outer_corner_nodebox"></a>
<strong>create_outer_corner_nodebox (detail)</strong>
</dt>
<dd>
Creates the nodebox for an outer corner.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">detail</span>
The level of detail, basically how many steps the ramp will
have.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The nodebox for an outer corner.
</ol>
</dd>
<dt>
<a name = "create_outer_steep_corner_nodebox"></a>
<strong>create_outer_steep_corner_nodebox (detail)</strong>
</dt>
<dd>
Creates the nodebox for an outer steep corner.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">detail</span>
The level of detail, basically how many steps the ramp will
have.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The nodebox for an outer steep corner.
</ol>
</dd>
<dt>
<a name = "create_ramp_from_node"></a>
<strong>create_ramp_from_node (node, use_mesh, nodebox_detail)</strong>
</dt>
<dd>
Creates ramps (ramp, inner and outer corner) for the given node.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">node</span>
The node description (table), or the node name.
</li>
<li><span class="parameter">use_mesh</span>
If the created nodes should use a mesh instead of nodeboxes.
</li>
<li><span class="parameter">nodebox_detail</span>
The detail level of the nodeboxes. Even if a mesh is
used, the nodebox is still created for the collision
box.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The node descriptions for the ramp, inner and outer corner.
</ol>
</dd>
<dt>
<a name = "create_ramp_nodebox"></a>
<strong>create_ramp_nodebox (detail)</strong>
</dt>
<dd>
Creates the nodebox for a ramp.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">detail</span>
The level of detail, basically how many steps the ramp will
have.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The nodebox for a ramp.
</ol>
</dd>
<dt>
<a name = "create_steep_ramp_nodebox"></a>
<strong>create_steep_ramp_nodebox (detail)</strong>
</dt>
<dd>
Creates the nodebox for a steep ramp.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">detail</span>
The level of detail, basically how many steps the ramp will
have.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The nodebox for a steep ramp.
</ol>
</dd>
<dt>
<a name = "register_ramps_for_node"></a>
<strong>register_ramps_for_node (node, base_name, use_mesh, nodebox_detail)</strong>
</dt>
<dd>
Creates and registers ramps (ramp, inner and outer corner) for the given
node.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">node</span>
The node description (table), or the node name.
</li>
<li><span class="parameter">base_name</span>
The base name for the new nodes.
</li>
<li><span class="parameter">use_mesh</span>
If the created nodes should use a mesh instead of nodeboxes.
</li>
<li><span class="parameter">nodebox_detail</span>
The detail level of the nodeboxes. Even if a mesh is
used, the nodebox is still created for the collision
box.
</li>
</ul>
<h3>Returns:</h3>
<ol>
The lookup entry used by rampmaker. That's a table that holds
the three nodes.
</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>

148
doc/modules/worldgenutil.html Normal file
View File

@ -0,0 +1,148 @@
<!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>worldgenutil</strong></li>
<li><a href="../modules/ramps.rampplacer.html">ramps.rampplacer</a></li>
<li><a href="../modules/ramps.ramputil.html">ramps.ramputil</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>worldgenutil</code></h1>
<p>Provides various utility functions for generation worlds.</p>
<p></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#iterate2d">iterate2d (minp, maxp, action, action_x)</a></td>
<td class="summary">Iterates over all two dimensions, from the given minimum point to the
given maximum point.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#iterate3d">iterate3d (minp, maxp, action, action_x, action_z)</a></td>
<td class="summary">Iterates over all three dimensions, from the given minimum point to the
given maximum point.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "iterate2d"></a>
<strong>iterate2d (minp, maxp, action, action_x)</strong>
</dt>
<dd>
Iterates over all two dimensions, from the given minimum point to the
given maximum point.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">minp</span>
The minimum point.
</li>
<li><span class="parameter">maxp</span>
The maximum point.
</li>
<li><span class="parameter">action</span>
The action to execute on every point.
</li>
<li><span class="parameter">action_x</span>
Optional. The action to execute on every x step.
</li>
</ul>
</dd>
<dt>
<a name = "iterate3d"></a>
<strong>iterate3d (minp, maxp, action, action_x, action_z)</strong>
</dt>
<dd>
Iterates over all three dimensions, from the given minimum point to the
given maximum point.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">minp</span>
The minimum point.
</li>
<li><span class="parameter">maxp</span>
The maximum point.
</li>
<li><span class="parameter">action</span>
The action to execute on every point.
</li>
<li><span class="parameter">action_x</span>
Optional. The action to execute on every x step.
</li>
<li><span class="parameter">action_z</span>
Optional. The action to execute on every z step.
</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>