mod-asm_spawneggs/docs/api.html

180 lines
4.4 KiB
HTML

<!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>Another Spawneggs Mod for Minetest</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>asm_spawneggs</h1>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Tables">Tables</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><strong>api.lua</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>api.lua</code></h1>
<p>API</p>
<p>
</p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#asm.registerEggRecipe">asm.registerEggRecipe (<i>name</i>, <i>ingredients</i>)</a></td>
<td class="summary">Adds a craft recipe for an egg.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#asm.registerEgg">asm.registerEgg (<i>def</i>)</a></td>
<td class="summary">Registers new egg in game.</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#EggDef">EggDef</a></td>
<td class="summary">Egg definition table.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "asm.registerEggRecipe"></a>
<strong>asm.registerEggRecipe (<i>name</i>, <i>ingredients</i>)</strong>
</dt>
<dd>
Adds a craft recipe for an egg. </p>
<p> Alias: <em>asm.addEggRecipe</em>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
Name of spawnegg that will be created from recipe.
</li>
<li><span class="parameter">ingredients</span>
Items used for recipe in addition to <code>spawneggs:egg</code>. Can be string or list.
</li>
</ul>
</dd>
<dt>
<a name = "asm.registerEgg"></a>
<strong>asm.registerEgg (<i>def</i>)</strong>
</dt>
<dd>
Registers new egg in game. </p>
<p> Alias: <em>asm.addEgg</em>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">def</span>
<a href="api.html#EggDef">EggDef</a> table.
</li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "EggDef"></a>
<strong>EggDef</strong>
</dt>
<dd>
Egg definition table.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Name of the egg. Will be appended to "spawneggs:".
</li>
<li><span class="parameter">title (<em>optional</em>)</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Description displayed for item.
</li>
<li><span class="parameter">inventory_image</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Image displayed in inventory.
</li>
<li><span class="parameter">spawn</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Entity that will be spawned from egg.
</li>
<li><span class="parameter">ingredients (<em>optional</em>)</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
Ingredients to use, in addition to <code>spawneggs:egg</code>, to register craft recipe. Can be a <a href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a> or <a href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a>.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc">LDoc 1.4.6-antum-2</a></i>
<i style="float:right;">Last updated 2021-05-05 15:11:46 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>