Update README & docs

master
Jordan Irwin 2021-05-05 06:41:16 -07:00
parent b44525fb8c
commit ee5c59f066
2 changed files with 14 additions and 25 deletions

View File

@ -5,7 +5,7 @@
Mod for adding entity spawning eggs to game with a very simple application. It is used only for creating new "eggs" that will spawn a specified entity when used by a player.
There are two function: *<span style="color:darkgreen;">asm.addEgg</span>* & *<span style="color:darkgreen;">asm.addEggRecipe</span>* (see: [API][api])
There are two function: *<span style="color:darkgreen;">asm.registerEgg</span>* & *<span style="color:darkgreen;">asm.registerEggRecipe</span>* (see: [API][api])
---
### Licensing:

View File

@ -54,17 +54,13 @@
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#as.addEggRecipe">as.addEggRecipe (<i>name</i>, <i>ingredients</i>)</a></td>
<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>
<tr>
<td class="name" nowrap><a href="#asm.addEgg">asm.addEgg ()</a></td>
<td class="summary">Alias for <a href="api.html#asm.registerEgg">asm.registerEgg</a>.</td>
</tr>
</table>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
@ -82,11 +78,13 @@
<dl class="function">
<dt>
<a name = "as.addEggRecipe"></a>
<strong>as.addEggRecipe (<i>name</i>, <i>ingredients</i>)</strong>
<a name = "asm.registerEggRecipe"></a>
<strong>asm.registerEggRecipe (<i>name</i>, <i>ingredients</i>)</strong>
</dt>
<dd>
Adds a craft recipe for an egg.
Adds a craft recipe for an egg. </p>
<p> Alias: <em>asm.addEggRecipe</em>
<h3>Parameters:</h3>
@ -109,7 +107,9 @@
<strong>asm.registerEgg (<i>def</i>)</strong>
</dt>
<dd>
Registers new egg in game.
Registers new egg in game. </p>
<p> Alias: <em>asm.addEgg</em>
<h3>Parameters:</h3>
@ -123,20 +123,6 @@
</dd>
<dt>
<a name = "asm.addEgg"></a>
<strong>asm.addEgg ()</strong>
</dt>
<dd>
Alias for <a href="api.html#asm.registerEgg">asm.registerEgg</a>.
</dd>
</dl>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
@ -161,6 +147,9 @@
<li><span class="parameter">spawn</span>
Entity that will be spawned from egg.
</li>
<li><span class="parameter">ingredients</span>
Ingredients to us, in addition to <code>spawneggs:egg</code>, to register craft recipe (optional).
</li>
</ul>
@ -175,7 +164,7 @@
</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 05:41:44 </i>
<i style="float:right;">Last updated 2021-05-05 06:41:02 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>