From 2ccf2e6766b26e2f7f9d2bf8a03acad4376d427a Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Tue, 25 May 2021 16:40:52 -0700 Subject: [PATCH] Re-generate HTML docs --- docs/api.html | 61 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 47 insertions(+), 14 deletions(-) diff --git a/docs/api.html b/docs/api.html index bc4c3f0..91d1318 100644 --- a/docs/api.html +++ b/docs/api.html @@ -54,11 +54,15 @@

Functions

- + + + + + - +
asm.registerEggRecipe (name, ingredients)asm.getEgg (entity)Retrieves egg that spawns specified entity.
asm.registerEggRecipe (name, ingredients) Adds a craft recipe for an egg.
asm.registerEgg (def)asm.registerEgg (def) Registers new egg in game.
@@ -77,9 +81,36 @@

Functions

+
+ + asm.getEgg (entity) +
+
+ Retrieves egg that spawns specified entity. + + +

Parameters:

+
    +
  • entity + string + Entity name spawned by egg. +
  • +
+ +

Returns:

+
    + + string + Egg name or nil. +
+ + + + +
- asm.registerEggRecipe (name, ingredients) + asm.registerEggRecipe (name, ingredients)
Adds a craft recipe for an egg.

@@ -89,10 +120,10 @@

Parameters:

    -
  • name +
  • name Name of spawnegg that will be created from recipe.
  • -
  • ingredients +
  • ingredients Items used for recipe in addition to spawneggs:egg. Can be string or list.
@@ -104,7 +135,7 @@
- asm.registerEgg (def) + asm.registerEgg (def)
Registers new egg in game.

@@ -114,7 +145,7 @@

Parameters:

@@ -138,25 +169,27 @@

Fields:

    -
  • name +
  • name string Name of the egg. Will be appended to "spawneggs:".
  • -
  • title (optional) +
  • title string Description displayed for item. + (optional)
  • -
  • inventory_image +
  • inventory_image string Image displayed in inventory.
  • -
  • spawn +
  • spawn string Entity that will be spawned from egg.
  • -
  • ingredients (optional) +
  • ingredients table Ingredients to use, in addition to spawneggs:egg, to register craft recipe. Can be a table or string. + (optional)
@@ -171,8 +204,8 @@
-generated by LDoc 1.4.6-antum-2 -Last updated 2021-05-05 15:11:46 +generated by LDoc 1.4.6 +Last updated 2021-05-25 16:39:54