add timestamps to log output

since nothing much is normally found outside that range anyway

only enqueue blocks that are within that range, or within
the range specfied by all of the mods that make generate_plant() calls,
whichever covers more volume.

API.txt

@@ -112,9 +112,9 @@ biome = {
 	depth_max = num,	-- If the object spawns on top of a water source, the
 						-- water must be at most this deep.  Defaults to 1.
 	min_elevation = num, -- Surface must be at this altitude or higher to
-						-- spawn at all.  Defaults to -31000...
-	max_elevation = num, -- ...but must be no higher than this altitude.
-						-- Defaults to +31000.
+						 -- spawn at all.  Defaults to -16 meters.
+	max_elevation = num, -- Surface must be no higher than this altitude.
+						 -- Defaults to +48.
 	near_nodes = {table}, -- List of nodes that must be somewhere in the
 						-- vicinity in order for the plant to spawn. Can also
 						-- be a string with a single node name.  If not
@@ -270,8 +270,8 @@ biome = {
 	depth = num,		-- How deep/thick of a layer the spawned-on node must
 						-- be.  Typically used for water.
 	min_elevation = num, -- Minimum elevation in meters/nodes.  Defaults to
-						-- -31000 (unlimited).
-	max_elevation = num, -- Max elevation.  Defaults to +31000 (unlimited).
+						-- -16 meters.
+	max_elevation = num, -- Max elevation.  Defaults to +48m.
 	near_nodes = {table}, -- what nodes must be in the general vicinity of the
 						-- object being spawned.
 	near_nodes_size = num, -- how wide of a search area to look for the nodes
@@ -607,34 +607,7 @@ Although this project was intended to be used with minetest_game, it can be
 configured to work with something else instead.  All you need to do is provide
 the names of the nodes in your game you want biome_lib's internals to use.
 
-Put these settings in your game's minetest.conf (or your client's own config,
-if desired).  You'll need to set all of them.
+See settingtypes.txt for a list.  Any item listed there can be changed either
+by adding it to your minetest.conf, or by using the "all settings" menu in
+Minetest, whatever's appropriate for your particular setup.
 
-biome_lib_default_grow_through_nodes
-	Comma-separated list of things that a spawned node is allowed to grow
-	through.  Air is always added to whatever you specify.
-	Default:  air, default:snow
-
-biome_lib_default_water_nodes
-	Comma-separated list of nodes that should be treated as water for the sake
-	of looking for neighboring "wet" ground.
-	Default: default:water_source, default:water_flowing,
-		default:river_water_source, default:river_water_flowing
-
-biome_lib_default_wet_surfaces
-	Comma-separated list of nodes that should be considered "wet" if one of
-	the aforementioned water nodes is nearby.
-	Default: default:dirt, default:dirt_with_grass, default:sand
-
-biome_lib_default_grow_nodes
-	Comma-separated list of nodes that something must be sitting on to be
-	able to actively change from one thing to another (such as a sapling
-	growing into a tree), to be used for ALL growable nodes, if the calling
-	mod doesn't provide its own lists.
-	Default: "default:dirt_with_grass"
-
-biome_lib_default_ground_nodes
-	Comma-separated list of nodes to use as the "root" of something that can
-	gradually climb up a wall, to be used for ALL such nodes, if the calling
-	mod doesn't provide its own lists.
-	Default: "default:dirt_with_grass"

README.md

@@ -25,4 +25,6 @@ It is primarily intended for mapgen v6, but it should work fine when used with m
 * biome_lib:find_valid_wall()
 * biome_lib:is_node_loaded()
 
-For a complete description of these functions as well as several of the internal variables within the mod, [read the API.txt document](https://raw.githubusercontent.com/minetest-mods/biome_lib/master/API.txt) included in this package.
+For a complete description of these functions as well as several of the internal variables within the mod, see `API.txt`.
+
+**Configuration:** This mod has several variables you can set in your `minetest.conf` to change things a bit, from the default nodes it uses, to the debug log level and the block queue behavior.  For a list with complete descriptions, see `settingtypes.txt`.

init.lua

@@ -33,6 +33,10 @@ biome_lib.actionslist_no_aircheck = {}
 biome_lib.surfaceslist_aircheck = {}
 biome_lib.surfaceslist_no_aircheck = {}
 
+-- the mapgen rarely creates useful surfaces outside this range, but mods can
+-- still specify a wider range if needed.
+biome_lib.mapgen_elevation_limit = { ["min"] = -16, ["max"] = 48 } 
+
 biome_lib.modpath = minetest.get_modpath("biome_lib")
 
 local function tableize(s)
@@ -72,16 +76,25 @@ biome_lib.default_grow_nodes =   c5 and tableize(c5) or {"default:dirt_with_gras
 
 biome_lib.debug_log_level = tonumber(minetest.settings:get("biome_lib_debug_log_level")) or 0
 
-local rr = tonumber(minetest.settings:get("biome_lib_queue_run_ratio")) or -100
-biome_lib.queue_run_ratio = 100 - rr
+local rr = tonumber(minetest.settings:get("biome_lib_queue_ratio")) or -200
+biome_lib.queue_ratio = 100 - rr
 biome_lib.entries_per_step = math.max(-rr, 1)
 
--- timer runs in microseconds, but I want the user to supply a time in seconds
-biome_lib.block_timeout = (tonumber(minetest.settings:get("biome_lib_block_timeout")) or 300) * 1000000
+-- the timer that manages the block timeout is in microseconds, but the timer
+-- that manages the queue wakeup call has to be in seconds, and works best if
+-- it takes a fraction of the block timeout interval.
+
+local t = tonumber(minetest.settings:get("biome_lib_block_timeout")) or 300
+
+biome_lib.block_timeout = t * 1000000
+
+-- we don't want the wakeup function to trigger TOO often,
+-- in case the user's block timeout setting is really low
+biome_lib.block_queue_wakeup_time = math.min(t/2, math.max(20, t/10))
 
 local time_speed = tonumber(minetest.settings:get("time_speed"))
 
-biome_lib.plantlife_seed_diff = 329	-- needs to be global so other mods can see it
+biome_lib.plantlife_seed_diff = 329 -- needs to be global so other mods can see it
 
 local perlin_octaves = 3
 local perlin_persistence = 0.6
@@ -113,8 +126,8 @@ biome_lib.perlin_humidity = PerlinNoise(humidity_seeddiff, humidity_octaves, hum
 function biome_lib.dbg(msg, level)
 	local l = tonumber(level) or 0
 	if biome_lib.debug_log_level >= l then
-		print("[Biome Lib] "..msg)
-		minetest.log("verbose", "[Biome Lib] "..msg)
+		print(os.date("%F %H:%M:%S").." [Biome Lib]: "..msg)
+		minetest.log("verbose", "[Biome Lib]: "..msg)
 	end
 end
 
@@ -144,8 +157,8 @@ end
 
 function biome_lib:set_defaults(biome)
 	biome.seed_diff = biome.seed_diff or 0
-	biome.min_elevation = biome.min_elevation or -31000
-	biome.max_elevation = biome.max_elevation or 31000
+	biome.min_elevation = biome.min_elevation or biome_lib.mapgen_elevation_limit.min
+	biome.max_elevation = biome.max_elevation or biome_lib.mapgen_elevation_limit.max
 	biome.temp_min = biome.temp_min or 1
 	biome.temp_max = biome.temp_max or -1
 	biome.humidity_min = biome.humidity_min or 1
@@ -197,6 +210,9 @@ function biome_lib:register_generate_plant(biomedef, nodes_or_function_or_model)
 		biome_lib.dbg("Warning: Registered function call using deprecated string method: "..dump(nodes_or_function_or_model), 2)
 	end
 
+	biome_lib.mapgen_elevation_limit.min = math.min(biomedef.min_elevation or 0, biome_lib.mapgen_elevation_limit.min)
+	biome_lib.mapgen_elevation_limit.max = math.max(biomedef.max_elevation or 0, biome_lib.mapgen_elevation_limit.max)
+
 	if biomedef.check_air == false then 
 		biome_lib.dbg("Register no-air-check mapgen hook: "..dump(nodes_or_function_or_model), 3)
 		biome_lib.actionslist_no_aircheck[#biome_lib.actionslist_no_aircheck + 1] = { biomedef, nodes_or_function_or_model }
@@ -502,8 +518,13 @@ function biome_lib.generate_block(shutting_down)
 			biome_lib.pos_hash.surface_node_list = airflag
 				and minetest.find_nodes_in_area_under_air(minp, maxp, biome_lib.surfaceslist_aircheck)
 				or minetest.find_nodes_in_area(minp, maxp, biome_lib.surfaceslist_no_aircheck)
-			biome_lib.pos_hash.action_index = 1
-			if #biome_lib.pos_hash.surface_node_list > 0 then
+			if #biome_lib.pos_hash.surface_node_list == 0 then
+				biome_lib.dbg("Mapblock at "..minetest.pos_to_string(minp).." dequeued:  no detected surfaces.", 4)
+				table.remove(blocklog, 1)
+				biome_lib.pos_hash = nil
+				return
+			else
+				biome_lib.pos_hash.action_index = 1
 				biome_lib.dbg("Mapblock at "..minetest.pos_to_string(minp)..
 					" has "..#biome_lib.pos_hash.surface_node_list..
 					" surface nodes to work on (airflag="..dump(airflag)..")", 4)
@@ -550,32 +571,81 @@ end
 minetest.register_globalstep(function(dtime)
 	if not biome_lib.block_log[1] then return end -- the block log is empty
 
-	if math.random(100) > biome_lib.queue_run_ratio then return end
+	if math.random(100) > biome_lib.queue_ratio then return end
 	for s = 1, biome_lib.entries_per_step do
 		biome_lib.generate_block()
 	end
 end)
 
+-- Periodically wake-up the queue to give old blocks a chance to time-out
+-- if the player isn't currently exploring (i.e. they're just playing in one area)
+
+function biome_lib.wake_up_queue()
+	if #biome_lib.block_recheck_list > 1
+	  and #biome_lib.block_log == 0 then
+		biome_lib.block_log[#biome_lib.block_log + 1] =
+			table.copy(biome_lib.block_recheck_list[#biome_lib.block_recheck_list])
+		biome_lib.block_recheck_list[#biome_lib.block_recheck_list] = nil
+		biome_lib.run_block_recheck_list = true
+		biome_lib.dbg("Woke-up the map queue to give old blocks a chance to time-out.", 3)
+	end
+	minetest.after(biome_lib.block_queue_wakeup_time, biome_lib.wake_up_queue)
+end
+
+biome_lib.wake_up_queue()
+
 -- Play out the entire log all at once on shutdown
 -- to prevent unpopulated map areas
 
+local function format_time(t)
+	if t > 59999999 then
+		return os.date("!%M minutes and %S seconds", math.ceil(t/1000000))
+	else
+		return os.date("!%S seconds", math.ceil(t/1000000))
+	end
+end
+
+function biome_lib.check_remaining_time()
+	if minetest.get_us_time() > (biome_lib.shutdown_last_timestamp + 10000000) then -- report progress every 10s
+		biome_lib.shutdown_last_timestamp = minetest.get_us_time()
+
+		local entries_remaining = #biome_lib.block_log + #biome_lib.block_recheck_list
+
+		local total_purged = biome_lib.starting_count - entries_remaining
+		local elapsed_time = biome_lib.shutdown_last_timestamp - biome_lib.shutdown_start_time
+		biome_lib.dbg(string.format("%i entries, approximately %s remaining.",
+			entries_remaining, format_time(elapsed_time/total_purged * entries_remaining)))
+	end
+end
+
 minetest.register_on_shutdown(function()
-	if #biome_lib.block_log + #biome_lib.block_recheck_list == 0 then
+	biome_lib.shutdown_start_time = minetest.get_us_time()
+	biome_lib.shutdown_last_timestamp = minetest.get_us_time()+1
+
+	biome_lib.starting_count = #biome_lib.block_log + #biome_lib.block_recheck_list
+
+	if biome_lib.starting_count == 0 then
 		return
 	end
 
-	biome_lib.dbg("[biome_lib] Stand by, playing out the rest of the mapblock log", 0)
-	biome_lib.dbg("(there are "..(#biome_lib.block_log + #biome_lib.block_recheck_list).." entries)...", 0)
+	biome_lib.dbg("Stand by, purging the mapblock log "..
+		"(there are "..biome_lib.starting_count.." entries) ...", 0)
+
 	while #biome_lib.block_log > 0 do
 		biome_lib.generate_block(true)
+		biome_lib.check_remaining_time()
 	end
 
 	if #biome_lib.block_recheck_list > 0 then
 		biome_lib.block_log = table.copy(biome_lib.block_recheck_list)
+		biome_lib.block_recheck_list = {}
 		while #biome_lib.block_log > 0 do
 			biome_lib.generate_block(true)
+			biome_lib.check_remaining_time()
 		end
 	end
+	biome_lib.dbg("Log purge completed after "..
+		format_time(minetest.get_us_time() - biome_lib.shutdown_start_time)..".", 0)
 end)
 
 -- The spawning ABM
@@ -773,12 +843,18 @@ if biome_lib.debug_log_level >= 3 then
 
 	function biome_lib.show_pending_block_count()
 		if biome_lib.last_count ~= #biome_lib.block_log then
-			biome_lib.dbg("Pending block count: "..(#biome_lib.block_log + #biome_lib.block_recheck_list), 3)
+			biome_lib.dbg(string.format("Pending block counts - ready to process: %-8icurrently deferred: %i",
+				#biome_lib.block_log, #biome_lib.block_recheck_list), 3)
 			biome_lib.last_count = #biome_lib.block_log
 			biome_lib.queue_idle_flag = false
 		elseif not biome_lib.queue_idle_flag then
-			biome_lib.dbg("Mapblock queue only contains blocks that can't yet be processed.",  3)
-			biome_lib.dbg("Idling the queue until new mapblocks show up.",  3)
+			if #biome_lib.block_recheck_list > 0 then
+				biome_lib.dbg("Mapblock queue only contains blocks that can't yet be processed.",  3)
+				biome_lib.dbg("Idling the queue until new blocks arrive or the next wake-up call occurs.",  3)
+			else
+				biome_lib.dbg("Mapblock queue has run dry.",  3)
+				biome_lib.dbg("Idling the queue until new blocks arrive.",  3)
+			end
 			biome_lib.queue_idle_flag = true
 		end
 		minetest.after(1, biome_lib.show_pending_block_count)
@@ -790,6 +866,8 @@ end
 minetest.after(0, function()
 	biome_lib.dbg("Registered a total of "..(#biome_lib.surfaceslist_aircheck)+(#biome_lib.surfaceslist_no_aircheck).." surface types to be evaluated, spread", 0)
 	biome_lib.dbg("across "..#biome_lib.actionslist_aircheck.." actions with air-checking and "..#biome_lib.actionslist_no_aircheck.." actions without.", 0)
+	biome_lib.dbg("within an elevation range of "..biome_lib.mapgen_elevation_limit.min.." and "..biome_lib.mapgen_elevation_limit.max.." meters.", 0)
+
 end)
 
 biome_lib.dbg("[Biome Lib] Loaded", 0)

search_functions.lua

@@ -57,18 +57,26 @@ end
 
 minetest.register_on_generated(function(minp, maxp, blockseed)
 	local timestamp = minetest.get_us_time()
-	for x = 0, 4 do
-		local minx = minp.x + x*16
-		for y = 0, 4 do
-			local miny = minp.y + y*16
-			for z = 0, 4 do
-				local minz = minp.z + z*16
+	for y = 0, 4 do
+		local miny = minp.y + y*16
 
-				local bmin = {x=minx, y=miny, z=minz}
-				local bmax = {x=minx + 15, y=miny + 15, z=minz + 15}
-				biome_lib.block_log[#biome_lib.block_log + 1] = { bmin, bmax, true, timestamp }
-				biome_lib.block_log[#biome_lib.block_log + 1] = { bmin, bmax, false, timestamp }
+		if miny >= biome_lib.mapgen_elevation_limit.min
+		  and (miny + 15) <= biome_lib.mapgen_elevation_limit.max then
+
+			for x = 0, 4 do
+				local minx = minp.x + x*16
+
+				for z = 0, 4 do
+					local minz = minp.z + z*16
+
+					local bmin = {x=minx, y=miny, z=minz}
+					local bmax = {x=minx + 15, y=miny + 15, z=minz + 15}
+					biome_lib.block_log[#biome_lib.block_log + 1] = { bmin, bmax, true, timestamp }
+					biome_lib.block_log[#biome_lib.block_log + 1] = { bmin, bmax, false, timestamp }
+				end
 			end
+		else
+			biome_lib.dbg("Did not enqueue mapblocks at elevation "..miny.."m, they're out of range of any generate_plant() calls.", 4)
 		end
 	end
 	biome_lib.run_block_recheck_list = true

settingtypes.txt

@@ -0,0 +1,48 @@
+# Comma-separated list of things that a spawned node is allowed to grow
+# through.  Air is always added to whatever else you specify here.
+biome_lib_default_grow_through_nodes (List of things a plant can grow through) string default:snow
+
+# Comma-separated list of nodes that should be treated as water or water-like
+# for the sake of looking for neighboring wet ground.
+biome_lib_default_water_nodes (List of "water-like" sources) string default:water_source,default:water_flowing,default:river_water_source,default:river_water_flowing
+
+# Comma-separated list of nodes that should be considered "wet" if one of
+# the configured "water-like" sources is nearby.
+biome_lib_default_wet_surfaces (List of "wet" nodes) string default:dirt,default:dirt_with_grass,default:sand
+
+# Comma-separated list of nodes that something must be sitting on to be
+# able to actively change from one thing to another (such as a sapling
+# growing into a tree), to be used if the mod that added that growable
+# thing didn't provide its own list of suitable surfaces.
+biome_lib_default_grow_nodes (List of default surfaces a plant can thrive on) string default:dirt_with_grass
+
+# Comma-separated list of nodes to use as the "root" of something that can
+# gradually climb up a wall (such as ivy), to be used if the mod that added
+# the climing thing didn't provide its own list.
+biome_lib_default_ground_nodes (List of default root nodes) string default:dirt_with_grass
+
+# biome_lib divides its workload into "actions", as dictated by the sum
+# total of all mods that use it, and this sets how much of that work is done
+# per globalstep tick.  If positive, a single action is executed on that
+# percentage of ticks, on average. If negative, it becomes positive, and
+# that many actions are executed on every single tick, skipping none.
+# More negative means more throughput, at the expense of lag.  On fast PC's,
+# a setting of between -500 and -2000 might be good.
+biome_lib_queue_ratio (Queue run ratio) int -200
+
+# Minetest's map generator allows neighboring areas to overflow into one
+# another, to create smooth terrain, but it often hands the map blocks that
+# comprise those areas to Lua (and hence, to biome_lib) before that overflow
+# function happens, which causes the mapgen to overwrite whatever Lua does
+# to them.  This setting (in seconds) makes biome_lib wait before adding its
+# normal output to those map blocks, to give the engine plenty of time to
+# run that overflow feature first.
+biome_lib_block_timeout (Deferred block timeout) int 300
+
+# This does just what it sounds like - it shows all debug output that's sent
+# with a level equal to or greater than this value.  A setting of 0 shows only
+# the bare necessities, such as the startup and shutdown messages, 1 adds
+# internal non-fatal errors to what's shown, 2 adds warnings, 3 adds other
+# basic info, 4 adds all the verbose debugging spew. 3 is perhaps the most
+# useful setting.
+biome_lib_debug_log_level (Debug log level) int 0