AntumMT/mod-asm_spawneggs-cd2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Re-generate HTML docs

Browse Source
This commit is contained in:
Jordan Irwin 2021-05-25 16:40:52 -07:00
parent 5a72143d90
commit 2ccf2e6766
1 changed files with 47 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
docs/api.html
View File

@ -54,11 +54,15 @@
<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="name" nowrap><a href="#asm.getEgg">asm.getEgg (entity)</a></td>
<td class="summary">Retrieves egg that spawns specified entity.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#asm.registerEggRecipe">asm.registerEggRecipe (name, ingredients)</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="name" nowrap><a href="#asm.registerEgg">asm.registerEgg (def)</a></td>
<td class="summary">Registers new egg in game.</td>
</tr>
</table>
@ -77,9 +81,36 @@
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "asm.getEgg"></a>
<strong>asm.getEgg (entity)</strong>
</dt>
<dd>
Retrieves egg that spawns specified entity.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">entity</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Entity name spawned by egg.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
Egg name or <code>nil</code>.
</ol>
</dd>
<dt>
<a name = "asm.registerEggRecipe"></a>
<strong>asm.registerEggRecipe (<i>name</i>, <i>ingredients</i>)</strong>
<strong>asm.registerEggRecipe (name, ingredients)</strong>
</dt>
<dd>
Adds a craft recipe for an egg. </p>
@ -89,10 +120,10 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">name</span>
<li><span class="parameter">name</span>
Name of spawnegg that will be created from recipe.
</li>
<li><span class="parameter">ingredients</span>
<li><span class="parameter">ingredients</span>
Items used for recipe in addition to <code>spawneggs:egg</code>. Can be string or list.
</li>
</ul>
@ -104,7 +135,7 @@
</dd>
<dt>
<a name = "asm.registerEgg"></a>
<strong>asm.registerEgg (<i>def</i>)</strong>
<strong>asm.registerEgg (def)</strong>
</dt>
<dd>
Registers new egg in game. </p>
@ -114,7 +145,7 @@
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">def</span>
<li><span class="parameter">def</span>
<a href="api.html#EggDef">EggDef</a> table.
</li>
</ul>
@ -138,25 +169,27 @@
<h3>Fields:</h3>
<ul>
<li><span class="parameter">name</span>
<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>
<li><span class="parameter">title</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.
(<em>optional</em>)
</li>
<li><span class="parameter">inventory_image</span>
<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>
<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>
<li><span class="parameter">ingredients</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>.
(<em>optional</em>)
</li>
</ul>
@ -171,8 +204,8 @@
</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>
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-05-25 16:39:54 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>