2015-04-07 21:31:40 +02:00

368 lines
5.8 KiB
HTML

<?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 utils/mapmanipulator.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/utils/blockedcache.html">utils/blockedcache.lua</a>
</li>
<li>
<a href="../../files/utils/blockutil.html">utils/blockutil.lua</a>
</li>
<li>
<a href="../../files/utils/color.html">utils/color.lua</a>
</li>
<li>
<a href="../../files/utils/constants.html">utils/constants.lua</a>
</li>
<li>
<a href="../../files/utils/fisheryates.html">utils/fisheryates.lua</a>
</li>
<li>
<a href="../../files/utils/init.html">utils/init.lua</a>
</li>
<li>
<a href="../../files/utils/interpolate.html">utils/interpolate.lua</a>
</li>
<li>
<a href="../../files/utils/list.html">utils/list.lua</a>
</li>
<li>
<a href="../../files/utils/log.html">utils/log.lua</a>
</li>
<li><strong>utils/mapmanipulator.lua</strong></li>
<li>
<a href="../../files/utils/mathutil.html">utils/mathutil.lua</a>
</li>
<li>
<a href="../../files/utils/noisemanager.html">utils/noisemanager.lua</a>
</li>
<li>
<a href="../../files/utils/pathutil.html">utils/pathutil.lua</a>
</li>
<li>
<a href="../../files/utils/stopwatch.html">utils/stopwatch.lua</a>
</li>
<li>
<a href="../../files/utils/stringutil.html">utils/stringutil.lua</a>
</li>
<li>
<a href="../../files/utils/tableutil.html">utils/tableutil.lua</a>
</li>
<li>
<a href="../../files/utils/tango.html">utils/tango.lua</a>
</li>
<li>
<a href="../../files/utils/test.html">utils/test.lua</a>
</li>
<li>
<a href="../../files/utils/textureutil.html">utils/textureutil.lua</a>
</li>
<li>
<a href="../../files/utils/transform.html">utils/transform.lua</a>
</li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h1>File <code>utils/mapmanipulator.lua</code></h1>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#MapManipulator:get_area">MapManipulator:get_area</a>&nbsp;()</td>
<td class="summary">Gets the VoxelArea for the current VoxelManip.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapManipulator:get_data">MapManipulator:get_data</a>&nbsp;()</td>
<td class="summary">Gets the data from the VoxelManip object.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapManipulator:get_node">MapManipulator:get_node</a>&nbsp;(x, z, y)</td>
<td class="summary">Gets the node at the given location.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapManipulator:new">MapManipulator:new</a>&nbsp;()</td>
<td class="summary">Creates a new instance of MapManipulator.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapManipulator:set_data">MapManipulator:set_data</a>&nbsp;(data)</td>
<td class="summary">Sets the data into the VoxelManip object.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#MapManipulator:set_node">MapManipulator:set_node</a>&nbsp;(x, z, y, node)</td>
<td class="summary">Sets the node at the given location.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="MapManipulator:get_area"></a><strong>MapManipulator:get_area</strong>&nbsp;()</dt>
<dd>
Gets the VoxelArea for the current VoxelManip.
<h3>Return value:</h3>
The VoxelArea.
</dd>
<dt><a name="MapManipulator:get_data"></a><strong>MapManipulator:get_data</strong>&nbsp;()</dt>
<dd>
Gets the data from the VoxelManip object. The data is an array that can be accessed by using the VoxelArea object.
<h3>Return value:</h3>
The data.
</dd>
<dt><a name="MapManipulator:get_node"></a><strong>MapManipulator:get_node</strong>&nbsp;(x, z, y)</dt>
<dd>
Gets the node at the given location.
<h3>Parameters</h3>
<ul>
<li>
x: The x coordinate (width).
</li>
<li>
z: the z coordinate (depth).
</li>
<li>
y: The y coordinate (height).
</li>
</ul>
<h3>Return value:</h3>
The node at the given location.
</dd>
<dt><a name="MapManipulator:new"></a><strong>MapManipulator:new</strong>&nbsp;()</dt>
<dd>
Creates a new instance of MapManipulator.
<h3>Return value:</h3>
A new instance.
</dd>
<dt><a name="MapManipulator:set_data"></a><strong>MapManipulator:set_data</strong>&nbsp;(data)</dt>
<dd>
Sets the data into the VoxelManip object. Will also correct and update the lighting, the liquids and flush the map.
<h3>Parameters</h3>
<ul>
<li>
data: Optional. The data to set. If nil the cached data will be used.
</li>
</ul>
</dd>
<dt><a name="MapManipulator:set_node"></a><strong>MapManipulator:set_node</strong>&nbsp;(x, z, y, node)</dt>
<dd>
Sets the node at the given location.
<h3>Parameters</h3>
<ul>
<li>
x: The x coordinate (width).
</li>
<li>
z: the z coordinate (depth).
</li>
<li>
y: The y coordinate (height).
</li>
<li>
node: The node to set.
</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>