nalc/plantlife_modpack
1
0
Fork 0
forked from mtcontrib/plantlife_modpack
Code Issues Pull Requests Releases Wiki Activity

another minor rewording of the api

Browse Source
This commit is contained in:
Vanessa Ezekowitz
2013-01-30 19:09:21 -05:00
parent 60ceed2eb1
commit 1554d8fcf4
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
API.txt
View File

@@ -24,15 +24,15 @@ plantslib:spawn_on_surfaces() and so forth.
===== =====
spawn_on_surfaces(options) spawn_on_surfaces(biome)
spawn_on_surfaces(sdelay, splant, sradius, schance, ssurface, savoid) spawn_on_surfaces(sdelay, splant, sradius, schance, ssurface, savoid)
The first function is an ABM-based spawner function originally created as This first function is an ABM-based spawner function originally created as
part of Ironzorg's flowers mod. It has since been largely extended and part of Ironzorg's flowers mod. It has since been largely extended and
expanded. There are two ways to call this function: You can either pass it expanded. There are two ways to call this function: You can either pass it
several individual string and number parameters to use the legacy interface, several individual string and number parameters to use the legacy interface,
or you can pass a single table with all of your options spelled out nicely to or you can pass a single biome definition as a table, with all of your options
use the current method. spelled out nicely. This is the preferred method.
When used with the legacy interface, you must specify the parameters exactly When used with the legacy interface, you must specify the parameters exactly
in order, with the first five being mandatory (even if some are set to nil), in order, with the first five being mandatory (even if some are set to nil),
@@ -57,10 +57,10 @@ savoid: Table with a list of groups and/or node names to avoid when
spawning the plant, such as {"group:flowers", "default:tree"}. spawning the plant, such as {"group:flowers", "default:tree"}.
When passed a table as the argument, and thus using the modern calling method, When passed a table as the argument, and thus using the modern calling method,
you must pass at least four arguments as regular keyed entries in the table, you must pass a number of arguments in the form of an ordinary keyed-value
in any order: table. Below is a list of everything supported by this function:
options={ biome = {
spawn_plants = something, -- [*] String or table; see below. spawn_plants = something, -- [*] String or table; see below.
spawn_delay = number, -- same as sdelay, above. spawn_delay = number, -- same as sdelay, above.
spawn_chance = number, -- same as schance, above. spawn_chance = number, -- same as schance, above.