River water renewability: Add comments to nodes.lua and bucket mod

paramat · paramat · commit 3ae382c91302 · 2017-11-11T21:37:27.000Z
diff --git a/mods/bucket/init.lua b/mods/bucket/init.lua
@@ -188,6 +188,12 @@ bucket.register_liquid(
 	{water_bucket = 1}
 )
 
+-- River water source is 'liquid_renewable = false' to avoid horizontal spread
+-- of water sources in sloping rivers that can cause water to overflow
+-- riverbanks and cause floods.
+-- River water source is instead made renewable by the 'force renew' option
+-- used here.
+
 bucket.register_liquid(
 	"default:river_water_source",
 	"default:river_water_flowing",
diff --git a/mods/default/nodes.lua b/mods/default/nodes.lua
@@ -1656,6 +1656,10 @@ minetest.register_node("default:river_water_source", {
 	liquid_alternative_flowing = "default:river_water_flowing",
 	liquid_alternative_source = "default:river_water_source",
 	liquid_viscosity = 1,
+	-- Not renewable to avoid horizontal spread of water sources in sloping
+	-- rivers that can cause water to overflow riverbanks and cause floods.
+	-- River water source is instead made renewable by the 'force renew'
+	-- option used in the 'bucket' mod by the river water bucket.
 	liquid_renewable = false,
 	liquid_range = 2,
 	post_effect_color = {a = 103, r = 30, g = 76, b = 90},
