Added a function to let one spawn plants at mapgen time,

but it's slow as molasses in January.  Not recommended for
general use yet.

API.txt

@@ -1,31 +1,40 @@
 This document briefly describes the Plantlife API.
 
+Last revision: 2013-01-18
+
 =========
 Functions
 =========
 
-There are five main functions defined by the main "plants_lib" mod:
+All functions in plants lib are declared locally to avoid namespace collisions
+with other mods.  They are accessible via the "plantslib" method, e.g.
+plantslib:spawn_on_surfaces() and so forth.
+
+There are three main functions defined by the main "plants_lib" mod:
 
 spawn_on_surfaces()
+generate_on_surfaces()
 grow_plants()
-plant_valid_wall()
+
-is_node_loaded()
+There are also several internal, helper functions that can be called if so
-dbg()
+desired, but they are not really intended for use by other mods and may change
+at any time.  See init.lua for more.
 
 -----
+
 The first of these, spawn_on_surfaces() is defined with quite a large number
 of variables.  All of the variables below, if specified at all, must be
 specified exactly in the order given here.  This function has no return value.
 
 spawn_on_surfaces = function(sdelay, splant, sradius, schance, ssurface,
-		    savoid, seed_diff, lightmin, lightmax, nneighbors, ocount,
+	savoid, seed_diff, lightmin, lightmax, nneighbors, ocount, facedir,
-			facedir, depthmax, altitudemin, altitudemax, tempmin, tempmax)
+	depthmax, altitudemin, altitudemax, sbiome, sbiomesize, sbiomecount, 
+	airsize, aircount, tempmin, tempmax)
 
 The first several of these are all required, and are from the last version of
 the flowers mod, so this part of the API should be the same as before.
 
-sdelay:				The value passed to the ABM's interval parameter, usually
+sdelay:		The value passed to the ABM's interval parameter, in seconds.
-					in the 1000-3000 range.
 splant:		The node name of the item to spawn (e.g.
 		"flowers:flower_rose").  Note that if the plant is
 		"poisonivy:seedling", and it's next to a wall at spawn
@@ -35,7 +44,8 @@ splant:				The node name of the item to spawn (e.g.
 sradius:	Don't spawn within this many nodes of the avoid items
 		mentioned below.
 schance:	The value passed to the ABM's chance parameter, normally
-					in the 10-100 range.
+		in the 10-100 range (1-in-X chance of operating on a given
+		node, e.g. 1-in-10).
 ssurface:	Table with the names of the nodes on which to spawn the
 		plant in question, such as {"default:sand",
 		"default:dirt_with_grass"}.  It is not recommended to put
@@ -49,8 +59,9 @@ savoid:				Table with a list of groups and/or node names to avoid
 		"default:tree"}.
 
 From here down are several optional parameters.  You can use as many as you
-need, but you must specify them in order (so if you want lightmax, you need
+need, but you must specify them in order.  To keep the default values for
-lightmin and seed_diff also, but not the rest).
+those parameters you don't wish to alter, set them to nil in your function
+call.
 
 seed_diff:	The Perlin seed difference value passed to the
 		minetest.env:get_perlin() function.  Used along with the
@@ -101,7 +112,16 @@ By default, if a biome node, size, and count are not defined, the biome
 checking is disabled.  Same holds true for the nneighbors bit above that.
 
 -----
-The second function, grow_plants() is used to turn the spawned nodes above
+
+XXXXXXXXXX  FIX ME FIX ME FIX ME
+XXXXXXXXXX
+XXXXXXXXXX  Document the mapgen-based spawning function
+XXXXXXXXXX
+XXXXXXXXXX  FIX ME FIX ME FIX ME
+
+-----
+
+The third function, grow_plants() is used to turn the spawned nodes above
 into something else over time.  This function has no return value, and is
 defined like so:
 
@@ -137,8 +157,8 @@ grow_vertically:	Set this to true if the plant needs to grow vertically, as
 		in climbing poison ivy.  Defaults to false.
 height_limit:	Just how tall can a vertically-growing plant go?  Set this
 		accordingly.  The mod will search straight down from the
-					position being spawned at to find a ground node, below.
+		position being spawned at to find a ground node, set via the
-					Defaults to 62000 (unlimited).
+		parameter below. Defaults to 62000 (unlimited).
 ground_nodes:	What nodes should be treated as "the ground" below a
 		vertically-growing plant.  Usually this will be the same
 		as the grow_nodes table, but might also include, for
@@ -161,18 +181,21 @@ seed_diff:			The Perlin seed diff to be use to calculate the noise
 		that's being grown.
 
 -----
-plant_valid_wall() expects only a single parameter, "pos", which is the usual
+
-table indicating the coordinates around which to search for adjacent walls.
+Of the few helper functions, plant_valid_wall() expects only a single
-This function returns the location of the first wall found as a facedir value,
+parameter, "pos", which is the usual table indicating the coordinates around
-or nil if there are no adjacent walls.
+which to search for adjacent walls.  This function returns the location of the
+first wall found as a facedir value, or nil if there are no adjacent walls.
 
 -----
+
 is_node_loaded() is defined in exactly the same manner (that is, "node_pos" is
 a set of coordinates), and acts as a wrapper for the
 minetest.env:get_node_or_nil(node_pos) function.  Returns true if the node in
 question is already loaded, or false if not.
 
 -----
+
 dbg() is a simple debug output function which takes one string parameter.  It
 just checks if plantlife_debug is true and outputs the phrase "[Plantlife] "
 followed by the supplied string, via the print() function.

flowers/init.lua

@@ -2,9 +2,7 @@
 
 local spawn_delay = 2000 -- 2000
 local spawn_chance = 100 -- 100
-local grow_delay = 1000 -- 1000
+local flowers_seed_diff = plantslib.plantlife_seed_diff+20
-local grow_chance = 10 -- 10
-local flowers_seed_diff = plantlife_seed_diff+20
 
 local flowers_list = {
 	{ "Rose",		"rose", 		spawn_delay,	10,	spawn_chance	, 10},
@@ -66,7 +64,7 @@ for i in ipairs(flowers_list) do
 		}
 	})
 
-	spawn_on_surfaces(delay, "flowers:flower_"..flower, radius, chance, "default:dirt_with_grass", {"group:flower", "group:poisonivy"}, flowers_seed_diff)
+	plantslib:spawn_on_surfaces(delay, "flowers:flower_"..flower, radius, chance, "default:dirt_with_grass", {"group:flower", "group:poisonivy"}, flowers_seed_diff)
 end
 
 minetest.register_node(":flowers:flower_waterlily", {
@@ -105,11 +103,11 @@ minetest.register_node(":flowers:flower_seaweed", {
 	},	
 })
 
-spawn_on_surfaces(spawn_delay/2, "flowers:flower_waterlily", 3,   spawn_chance*2, "default:water_source"   , {"group:flower"}, flowers_seed_diff, 10, nil, nil,                         nil, nil, 4)
+plantslib:spawn_on_surfaces(spawn_delay/2, "flowers:flower_waterlily", 3,   spawn_chance*2, "default:water_source"   , {"group:flower"}, flowers_seed_diff, 10, nil, nil,                         nil, nil, 4)
 
-spawn_on_surfaces(spawn_delay*2, "flowers:flower_seaweed"  , 0.1, spawn_chance*2, "default:water_source"   , {"group:flower"}, flowers_seed_diff,  4,  10, {"default:dirt_with_grass"},   0,   1)
+plantslib:spawn_on_surfaces(spawn_delay*2, "flowers:flower_seaweed"  , 0.1, spawn_chance*2, "default:water_source"   , {"group:flower"}, flowers_seed_diff,  4,  10, {"default:dirt_with_grass"},   0,   1)
-spawn_on_surfaces(spawn_delay*2, "flowers:flower_seaweed"  , 0.1, spawn_chance*2, "default:dirt_with_grass", {"group:flower"}, flowers_seed_diff,  4,  10, {"default:water_source"}   ,   1,   1)
+plantslib:spawn_on_surfaces(spawn_delay*2, "flowers:flower_seaweed"  , 0.1, spawn_chance*2, "default:dirt_with_grass", {"group:flower"}, flowers_seed_diff,  4,  10, {"default:water_source"}   ,   1,   1)
-spawn_on_surfaces(spawn_delay*2, "flowers:flower_seaweed"  , 0.1, spawn_chance*2, "default:stone"          , {"group:flower"}, flowers_seed_diff,  4,  10, {"default:water_source"}   ,   6,   1)
+plantslib:spawn_on_surfaces(spawn_delay*2, "flowers:flower_seaweed"  , 0.1, spawn_chance*2, "default:stone"          , {"group:flower"}, flowers_seed_diff,  4,  10, {"default:water_source"}   ,   6,   1)
 
 
 minetest.register_craftitem(":flowers:flower_pot", {

junglegrass/init.lua

@@ -4,7 +4,7 @@ local spawn_delay = 2000 -- 2000
 local spawn_chance = 100 -- 100
 local grow_delay = 1000 -- 1000
 local grow_chance = 10 -- 10
-local junglegrass_seed_diff = plantlife_seed_diff
+local junglegrass_seed_diff = plantslib.plantlife_seed_diff
 
 local grasses_list = {
         {"junglegrass:shortest","junglegrass:short" },
@@ -68,12 +68,12 @@ minetest.register_node(':junglegrass:shortest', {
 	},
 })
 
-spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance, "default:dirt_with_grass", {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
+plantslib:spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance, "default:dirt_with_grass", {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
-spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance*2, "default:sand"           , {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
+plantslib:spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance*2, "default:sand"           , {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
-spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance*3, "default:desert_sand"    , {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
+plantslib:spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance*3, "default:desert_sand"    , {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
-spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance*3, "default:desert_sand"    , {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
+plantslib:spawn_on_surfaces(spawn_delay*2, "junglegrass:shortest", 4, spawn_chance*3, "default:desert_sand"    , {"group:junglegrass", "default:junglegrass", "default:dry_shrub"}, junglegrass_seed_diff, 5)
 
 for i in ipairs(grasses_list) do
-	grow_plants(grow_delay, grow_chance/2, grasses_list[i][1], grasses_list[i][2], "default:desert_sand", {"default:dirt_with_grass", "default:sand", "default:desert_sand"})
+	plantslib:grow_plants(grow_delay, grow_chance/2, grasses_list[i][1], grasses_list[i][2], "default:desert_sand", {"default:dirt_with_grass", "default:sand", "default:desert_sand"})
 end
 

plants_lib/init.lua

@@ -1,17 +1,17 @@
 -- Plantlife library mod by Vanessa Ezekowitz
--- 2013-01-00
+-- 2013-01-18
 --
 -- License:  WTFPL
 --
 -- I got the temperature map idea from "hmmmm", values used for it came from
+-- Splizard's snow mod.
 --
 
-
 -- Various settings - most of these probably won't need to be changed
 
-plantlife_seed_diff = 329	-- needs to be global so other mods can see it
+plantslib = {}
 
-local plantlife_debug = true  -- ...unless you want the modpack to spam the console ;-)
+plantslib.plantlife_seed_diff = 329	-- needs to be global so other mods can see it
 
 local perlin_octaves = 3
 local perlin_persistence = 0.6
@@ -28,13 +28,7 @@ local plantlife_limit = 0.1 -- compared against perlin noise.  lower = more abun
 
 math.randomseed(os.time())
 
-local dbg = function(s)
+function plantslib:is_node_loaded(node_pos)
-	if plantlife_debug then
-		print("[Plantlife] " .. s)
-	end
-end
-
-local is_node_loaded = function(node_pos)
 	n = minetest.env:get_node_or_nil(node_pos)
 	if (n == nil) or (n.name == "ignore") then
 		return false
@@ -42,9 +36,67 @@ local is_node_loaded = function(node_pos)
 	return true
 end
 
+-- Spawn plants using the map generator
+
+function plantslib:register_generate_plant(biome)
+		minetest.register_on_generated(plantslib:search_for_surfaces(minp, maxp, biome))
+end
+
+function plantslib:search_for_surfaces(minp, maxp, biome)
+	return function(minp, maxp, blockseed)
+		print("Started checking generated mapblock...")
+		local searchnodes = minetest.env:find_nodes_in_area(minp, maxp, biome.surface)
+		local surfacenodes = {}
+		local numsurfacenodes = 0
+		for i in ipairs(searchnodes) do
+			local pos = searchnodes[i]
+			local p_top = { x = pos.x, y = pos.y + 1, z = pos.z }
+			if minetest.env:get_node(p_top).name == "air" then
+				table.insert(surfacenodes, pos)
+				numsurfacenodes = numsurfacenodes + 1
+			end
+		end
+		
+		print("Found "..numsurfacenodes.." surface nodes in map block {"..dump(minp)..":"..dump(maxp).."} to check.")
+
+		if biome.seed_diff == nil then biome.seed_diff = 0 end
+		if biome.neighbors == nil then biome.neighbors = biome.surface end
+		if biome.ncount == nil then biome.ncount = -1 end
+		if biome.min_elevation == nil then biome.min_elevation = -31000 end
+		if biome.max_elevation == nil then biome.max_elevation = 31000 end
+		if biome.near_nodes_size == nil then biome.near_nodes_size = 0 end
+		if biome.near_nodes_count == nil then biome.near_nodes_count = 1 end
+		if biome.temp_min == nil then biome.temp_min = -1 end
+		if biome.temp_max == nil then biome.temp_max = 1 end
+
+		for i in ipairs(surfacenodes) do
+			local pos = surfacenodes[i]
+			local p_top = {x = pos.x, y = pos.y + 1, z = pos.z}
+			local perlin1 = minetest.env:get_perlin(biome.seed_diff, perlin_octaves, perlin_persistence, perlin_scale)
+			local perlin2 = minetest.env:get_perlin(temperature_seeddiff, temperature_octaves, temperature_persistence, temperature_scale)
+			local noise1 = perlin1:get2d({x=p_top.x, y=p_top.z})
+			local noise2 = perlin2:get2d({x=p_top.x, y=p_top.z})
+			if minetest.env:find_node_near(p_top, biome.radius + math.random(-1.5,1.5), biome.avoid) == nil
+			  and noise1 > plantlife_limit
+			  and noise2 >= biome.temp_min
+			  and noise2 <= biome.temp_max
+			  and (biome.ncount == -1 or table.getn(minetest.env:find_nodes_in_area({x=pos.x-1, y=pos.y, z=pos.z-1}, {x=pos.x+1, y=pos.y, z=pos.z+1}, biome.neighbors)) > biome.ncount)
+			  and (biome.near_nodes == nil or table.getn(minetest.env:find_nodes_in_area({x=pos.x-biome.near_nodes_size, y=pos.y-1, z=pos.z-biome.near_nodes_size}, {x=pos.x+biome.near_nodes_size, y=pos.y+1, z=pos.z+biome.near_nodes_size}, biome.near_nodes)) >= biome.near_nodes_count)
+			  and pos.y >= biome.min_elevation
+			  and pos.y <= biome.max_elevation
+			  and (biome.water_depth == nil or minetest.env:get_node({ x = pos.x, y = pos.y-biome.water_depth-1, z = pos.z }).name ~= "default:water_source")
+			  then 
+				minetest.log("verbose", "Call function: "..biome.exec_funct.."("..dump(pos)..")")
+				assert(loadstring(biome.exec_funct.."("..dump(pos)..")"))()
+			end
+		end
+		print("Finished checking generated mapblock.")
+	end
+end
+
 -- The spawning ABM
 
-spawn_on_surfaces = function(
+function plantslib:spawn_on_surfaces(
 		sdelay,
 		splant,
 		sradius,
@@ -97,7 +149,7 @@ spawn_on_surfaces = function(
 			if noise1 > plantlife_limit 
 			  and noise2 >= tempmin
 			  and noise2 <= tempmax
-			  and is_node_loaded(p_top) then
+			  and plantslib:is_node_loaded(p_top) then
 				local n_light = minetest.env:get_node_light(p_top, nil)
 				if minetest.env:find_node_near(p_top, sradius + math.random(-1.5,2), savoid) == nil
 				  and n_light >= lightmin
@@ -110,16 +162,16 @@ spawn_on_surfaces = function(
 				  and pos.y >= altmin
 				  and pos.y <= altmax
 					then
-						local walldir = plant_valid_wall(p_top)
+						local walldir = plantslib:plant_valid_wall(p_top)
 						if splant == "poisonivy:seedling" and walldir ~= nil then
-							dbg("Spawn: poisonivy:climbing at "..dump(p_top).." on "..ssurface)
+							minetest.log("verbose", "Spawn: poisonivy:climbing at "..dump(p_top).." on "..ssurface)
 							minetest.env:add_node(p_top, { name = "poisonivy:climbing", param2 = walldir })
 						else
 							local deepnode = minetest.env:get_node({ x = pos.x, y = pos.y-depthmax-1, z = pos.z }).name
 							if (ssurface ~= "default:water_source")
 								or (ssurface == "default:water_source"
 								and deepnode ~= "default:water_source") then
-								dbg("Spawn: "..splant.." at "..dump(p_top).." on "..ssurface)
+								minetest.log("verbose", "Spawn: "..splant.." at "..dump(p_top).." on "..ssurface)
 								minetest.env:add_node(p_top, { name = splant, param2 = facedir })
 							end
 						end
@@ -131,7 +183,7 @@ end
 
 -- The growing ABM
 
-grow_plants = function(
+function plantslib:grow_plants(
 		gdelay,
 		gchance,
 		gplant,
@@ -162,30 +214,30 @@ grow_plants = function(
 			if grow_function == nil then
 				if string.find(dump(grow_nodes), n_bot.name) ~= nil and n_top.name == "air" then
 					if grow_vertically then
-						if find_first_node(pos, height_limit, ground_nodes) ~= nil then
+						if plantslib:find_first_node(pos, height_limit, ground_nodes) ~= nil then
 							if need_wall then
-								local walldir=plant_valid_wall(p_top)
+								local walldir=plantslib:plant_valid_wall(p_top)
 								if walldir ~= nil then
-									dbg("Grow: "..gplant.." upwards to ("..dump(p_top)..") on wall "..walldir)
+									minetest.log("verbose", "Grow: "..gplant.." upwards to ("..dump(p_top)..") on wall "..walldir)
 									minetest.env:add_node(p_top, { name = gplant, param2 = walldir })
 								end
 							else
-								dbg("Grow: "..gplant.." upwards to ("..dump(p_top)..")")
+								minetest.log("verbose", "Grow: "..gplant.." upwards to ("..dump(p_top)..")")
 								minetest.env:add_node(p_top, { name = gplant })
 							end
 						end
 
 					-- corner case for changing short junglegrass to dry shrub in desert
 					elseif n_bot.name == dry_early_node and gplant == "junglegrass:short" then
-						dbg("Die: "..gplant.." becomes default:dry_shrub at ("..dump(pos)..")")
+						minetest.log("verbose", "Die: "..gplant.." becomes default:dry_shrub at ("..dump(pos)..")")
 						minetest.env:add_node(pos, { name = "default:dry_shrub" })
 
 					elseif gresult == nil then
-						dbg("Die: "..gplant.." at ("..dump(pos)..")")
+						minetest.log("verbose", "Die: "..gplant.." at ("..dump(pos)..")")
 						minetest.env:remove_node(pos)
 
 					elseif gresult ~= nil then
-						dbg("Grow: "..gplant.." becomes "..gresult.." at ("..dump(pos)..")")
+						minetest.log("verbose", "Grow: "..gplant.." becomes "..gresult.." at ("..dump(pos)..")")
 						if facedir == nil then
 							minetest.env:add_node(pos, { name = gresult })
 						else
@@ -199,7 +251,7 @@ grow_plants = function(
 				local perlin2 = minetest.env:get_perlin(temperature_seeddiff, temperature_octaves, temperature_persistence, temperature_scale)
 				local noise1 = perlin1:get2d({x=p_top.x, y=p_top.z})
 				local noise2 = perlin2:get2d({x=p_top.x, y=p_top.z})
-				dbg("Call function: "..grow_function.."("..dump(pos)..","..noise1..","..noise2..")")
+				minetest.log("verbose", "Call function: "..grow_function.."("..dump(pos)..","..noise1..","..noise2..")")
 				assert(loadstring(grow_function.."("..dump(pos)..","..noise1..","..noise2..")"))()
 			end
 		end
@@ -209,7 +261,7 @@ end
 -- function to decide if a node has a wall that's in verticals_list{}
 -- returns wall direction of valid node, or nil if invalid.
 
-plant_valid_wall = function(wallpos)
+function plantslib:plant_valid_wall(wallpos)
 	local walldir = nil
 	local verts = dump(verticals_list)
 
@@ -230,7 +282,7 @@ end
 
 -- Function to search straight down from (pos) to find first node in match list.
 
-find_first_node = function(pos, height_limit, nodelist)
+function plantslib:find_first_node(pos, height_limit, nodelist)
 	for i = 1, height_limit do
 		n = minetest.env:get_node({x=pos.x, y=pos.y-i, z=pos.z})
 		if string.find(dump(nodelist),n.name) ~= nil then

poinsonivy/init.lua

@@ -4,7 +4,7 @@ local spawn_delay = 2000 -- 2000
 local spawn_chance = 100 -- 100
 local grow_delay = 1000 -- 1000
 local grow_chance = 10 -- 10
-local poisonivy_seed_diff = plantlife_seed_diff + 10
+local poisonivy_seed_diff = plantslib.plantlife_seed_diff + 10
 
 local verticals_list = {
 	"default:dirt",
@@ -63,9 +63,8 @@ minetest.register_node(':poisonivy:climbing', {
 	},
 })
 
-spawn_on_surfaces(spawn_delay, "poisonivy:seedling", 10 , spawn_chance/10, "default:dirt_with_grass", {"group:poisonivy","group:flower"}, poisonivy_seed_diff, 7)
+plantslib:spawn_on_surfaces(spawn_delay, "poisonivy:seedling", 10 , spawn_chance/10, "default:dirt_with_grass", {"group:poisonivy","group:flower"}, poisonivy_seed_diff, 7)
 
-grow_plants(spawn_delay, grow_chance,   "poisonivy:seedling", "poisonivy:sproutling", nil, {"default:dirt_with_grass"})
+plantslib:grow_plants(spawn_delay, grow_chance,   "poisonivy:seedling", "poisonivy:sproutling", nil, {"default:dirt_with_grass"})
-
+plantslib:grow_plants(spawn_delay, grow_chance*2, "poisonivy:climbing", nil,                    nil, nil                        ,nil,true,true,nil,{"default:dirt_with_grass"})
-grow_plants(spawn_delay, grow_chance*2, "poisonivy:climbing", nil,                    nil, nil                        ,nil,true,true,nil,{"default:dirt_with_grass"})