Refactor `mcl_init`

- use new vectors
- make code less confuse
- type annotations

mods/CORE/mcl_init/init.lua

@@ -3,26 +3,26 @@ mcl_vars = {}
 
 mcl_vars.redstone_tick = 0.1
 
---- GUI / inventory menu settings
+-- GUI / inventory menu settings
 mcl_vars.gui_slots = "listcolors[#9990;#FFF7;#FFF0;#000;#FFF]"
+
 -- nonbg is added as formspec prepend in mcl_formspec_prepend
-mcl_vars.gui_nonbg = mcl_vars.gui_slots ..
-	"style_type[image_button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]"..
-	"style_type[button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]"..
-	"style_type[field;textcolor=#323232]"..
-	"style_type[label;textcolor=#323232]"..
-	"style_type[textarea;textcolor=#323232]"..
-	"style_type[checkbox;textcolor=#323232]"
+mcl_vars.gui_nonbg = table.concat({
+	mcl_vars.gui_slots,
+	"style_type[image_button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]",
+	"style_type[button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]",
+	"style_type[field;textcolor=#323232]",
+	"style_type[label;textcolor=#323232]",
+	"style_type[textarea;textcolor=#323232]",
+	"style_type[checkbox;textcolor=#323232]",
+})
 
 -- Background stuff must be manually added by mods (no formspec prepend)
 mcl_vars.gui_bg_color = "bgcolor[#00000000]"
 mcl_vars.gui_bg_img = "background9[1,1;1,1;mcl_base_textures_background9.png;true;7]"
 
--- Legacy
-mcl_vars.inventory_header = ""
-
 -- Tool wield size
-mcl_vars.tool_wield_scale = { x = 1.8, y = 1.8, z = 1 }
+mcl_vars.tool_wield_scale = vector.new(1.8, 1.8, 1)
 
 -- Mapgen variables
 local mg_name = minetest.get_mapgen_setting("mg_name")
@@ -35,55 +35,69 @@ mcl_vars.chunksize = math.max(1, tonumber(minetest.get_mapgen_setting("chunksize
 mcl_vars.MAP_BLOCKSIZE = math.max(1, minetest.MAP_BLOCKSIZE or 16)
 mcl_vars.mapgen_limit = math.max(1, tonumber(minetest.get_mapgen_setting("mapgen_limit")) or 31000)
 mcl_vars.MAX_MAP_GENERATION_LIMIT = math.max(1, minetest.MAX_MAP_GENERATION_LIMIT or 31000)
+
 local central_chunk_offset = -math.floor(mcl_vars.chunksize / 2)
+
 mcl_vars.central_chunk_offset_in_nodes = central_chunk_offset * mcl_vars.MAP_BLOCKSIZE
 mcl_vars.chunk_size_in_nodes = mcl_vars.chunksize * mcl_vars.MAP_BLOCKSIZE
+
 local central_chunk_min_pos = central_chunk_offset * mcl_vars.MAP_BLOCKSIZE
 local central_chunk_max_pos = central_chunk_min_pos + mcl_vars.chunk_size_in_nodes - 1
 local ccfmin = central_chunk_min_pos - mcl_vars.MAP_BLOCKSIZE -- Fullminp/fullmaxp of central chunk, in nodes
 local ccfmax = central_chunk_max_pos + mcl_vars.MAP_BLOCKSIZE
-local mapgen_limit_b = math.floor(math.min(mcl_vars.mapgen_limit, mcl_vars.MAX_MAP_GENERATION_LIMIT) / mcl_vars.MAP_BLOCKSIZE)
+local mapgen_limit_b = math.floor(math.min(mcl_vars.mapgen_limit, mcl_vars.MAX_MAP_GENERATION_LIMIT) /
+	mcl_vars.MAP_BLOCKSIZE)
 local mapgen_limit_min = -mapgen_limit_b * mcl_vars.MAP_BLOCKSIZE
 local mapgen_limit_max = (mapgen_limit_b + 1) * mcl_vars.MAP_BLOCKSIZE - 1
 local numcmin = math.max(math.floor((ccfmin - mapgen_limit_min) / mcl_vars.chunk_size_in_nodes), 0) -- Number of complete chunks from central chunk
 local numcmax = math.max(math.floor((mapgen_limit_max - ccfmax) / mcl_vars.chunk_size_in_nodes), 0) -- fullminp/fullmaxp to effective mapgen limits.
+
 mcl_vars.mapgen_edge_min = central_chunk_min_pos - numcmin * mcl_vars.chunk_size_in_nodes
 mcl_vars.mapgen_edge_max = central_chunk_max_pos + numcmax * mcl_vars.chunk_size_in_nodes
 
+---@param x integer
+---@return integer
 local function coordinate_to_block(x)
 	return math.floor(x / mcl_vars.MAP_BLOCKSIZE)
 end
 
+---@param x integer
+---@return integer
 local function coordinate_to_chunk(x)
 	return math.floor((coordinate_to_block(x) - central_chunk_offset) / mcl_vars.chunksize)
 end
 
+---@param pos Vector
+---@return Vector
 function mcl_vars.pos_to_block(pos)
-	return {
-		x = coordinate_to_block(pos.x),
-		y = coordinate_to_block(pos.y),
-		z = coordinate_to_block(pos.z)
-	}
+	return vector.new(
+		coordinate_to_block(pos.x),
+		coordinate_to_block(pos.y),
+		coordinate_to_block(pos.z)
+	)
 end
 
+---@param pos Vector
+---@return Vector
 function mcl_vars.pos_to_chunk(pos)
-	return {
-		x = coordinate_to_chunk(pos.x),
-		y = coordinate_to_chunk(pos.y),
-		z = coordinate_to_chunk(pos.z)
-	}
+	return vector.new(
+		coordinate_to_chunk(pos.x),
+		coordinate_to_chunk(pos.y),
+		coordinate_to_chunk(pos.z)
+	)
 end
 
 local k_positive = math.ceil(mcl_vars.MAX_MAP_GENERATION_LIMIT / mcl_vars.chunk_size_in_nodes)
 local k_positive_z = k_positive * 2
 local k_positive_y = k_positive_z * k_positive_z
 
+---@param pos Vector
+---@return integer
 function mcl_vars.get_chunk_number(pos) -- unsigned int
 	local c = mcl_vars.pos_to_chunk(pos)
-	return
-		(c.y + k_positive) * k_positive_y +
+	return (c.y + k_positive) * k_positive_y +
 		(c.z + k_positive) * k_positive_z +
-		 c.x + k_positive
+		c.x + k_positive
 end
 
 if not superflat and not singlenode then
@@ -117,11 +131,8 @@ elseif singlenode then
 	mcl_vars.mg_bedrock_is_rough = false
 else
 	-- Classic superflat
-	local ground = minetest.get_mapgen_setting("mgflat_ground_level")
-	ground = tonumber(ground)
-	if not ground then
-		ground = 8
-	end
+	local ground = tonumber(minetest.get_mapgen_setting("mgflat_ground_level")) or 8
+
 	mcl_vars.mg_overworld_min = ground - 3
 	mcl_vars.mg_overworld_max_official = mcl_vars.mg_overworld_min + minecraft_height_limit
 	mcl_vars.mg_bedrock_overworld_min = mcl_vars.mg_overworld_min
@@ -180,14 +191,16 @@ minetest.craftitemdef_default.stack_max = 64
 math.randomseed(os.time())
 
 local chunks = {} -- intervals of chunks generated
+
+---@param pos Vector
 function mcl_vars.add_chunk(pos)
 	local n = mcl_vars.get_chunk_number(pos) -- unsigned int
 	local prev
 	for i, d in pairs(chunks) do
 		if n <= d[2] then -- we've found it
 			if (n == d[2]) or (n >= d[1]) then return end -- already here
-			if n == d[1]-1 then -- right before:
-				if prev and (prev[2] == n-1) then
+			if n == d[1] - 1 then -- right before:
+				if prev and (prev[2] == n - 1) then
 					prev[2] = d[2]
 					table.remove(chunks, i)
 					return
@@ -195,17 +208,20 @@ function mcl_vars.add_chunk(pos)
 				d[1] = n
 				return
 			end
-			if prev and (prev[2] == n-1) then --join to previous
+			if prev and (prev[2] == n - 1) then --join to previous
 				prev[2] = n
 				return
 			end
-			table.insert(chunks, i, {n, n}) -- insert new interval before i
+			table.insert(chunks, i, { n, n }) -- insert new interval before i
 			return
 		end
 		prev = d
 	end
-	chunks[#chunks+1] = {n, n}
+	chunks[#chunks + 1] = { n, n }
 end
+
+---@param pos Vector
+---@return boolean
 function mcl_vars.is_generated(pos)
 	local n = mcl_vars.get_chunk_number(pos) -- unsigned int
 	for i, d in pairs(chunks) do
@@ -216,47 +232,45 @@ function mcl_vars.is_generated(pos)
 	return false
 end
 
--- "Trivial" (actually NOT) function to just read the node and some stuff to not just return "ignore", like mt 5.4 does.
--- p: Position, if it's wrong, {name="error"} node will return.
--- force: optional (default: false) - Do the maximum to still read the node within us_timeout.
--- us_timeout: optional (default: 244 = 0.000244 s = 1/80/80/80), set it at least to 3000000 to let mapgen to finish its job.
---
--- returns node definition, eg. {name="air"}. Unfortunately still can return {name="ignore"}.
-function mcl_vars.get_node(p, force, us_timeout)
+---"Trivial" (actually NOT) function to just read the node and some stuff to not just return "ignore", like mt 5.4 does.
+---@param pos Vector Position, if it's wrong, `{name="error"}` node will return.
+---@param force boolean Optional (default: `false`), Do the maximum to still read the node within us_timeout.
+---@param us_timeout number Optional (default: `244 = 0.000244 s = 1/80/80/80`), set it at least to `3000000` to let mapgen to finish its job
+---@return node # Node definition, eg. `{name="air"}`. Unfortunately still can return `{name="ignore"}`.
+function mcl_vars.get_node(pos, force, us_timeout)
 	-- check initial circumstances
-	if not p or not p.x or not p.y or not p.z then return {name="error"} end
+	if not pos or not pos.x or not pos.y or not pos.z then return { name = "error" } end
 
 	-- try common way
-	local node = minetest.get_node(p)
+	local node = minetest.get_node(pos)
 	if node.name ~= "ignore" then
 		return node
 	end
 
-	-- copy table to get sure it won't changed by other threads
-	local pos = {x=p.x,y=p.y,z=p.z}
+	-- copy vector to get sure it won't changed by other threads
+	local pos_copy = vector.copy(pos)
 
 	-- try LVM
-	minetest.get_voxel_manip():read_from_map(pos, pos)
-	node = minetest.get_node(pos)
+	minetest.get_voxel_manip():read_from_map(pos_copy, pos_copy)
+	node = minetest.get_node(pos_copy)
 	if node.name ~= "ignore" or not force then
 		return node
 	end
 
 	-- all ways failed - need to emerge (or forceload if generated)
-	local us_timeout = us_timeout or 244
-	if mcl_vars.is_generated(pos) then
+	if mcl_vars.is_generated(pos_copy) then
 		minetest.chat_send_all("IMPOSSIBLE! Please report this to MCL2 issue tracker!")
-		minetest.forceload_block(pos)
+		minetest.forceload_block(pos_copy)
 	else
-		minetest.emerge_area(pos, pos)
+		minetest.emerge_area(pos_copy, pos_copy)
 	end
 
 	local t = minetest.get_us_time()
 
-	node = minetest.get_node(pos)
+	node = minetest.get_node(pos_copy)
 
-	while (not node or node.name == "ignore") and (minetest.get_us_time() - t < us_timeout) do
-		node = minetest.get_node(pos)
+	while (not node or node.name == "ignore") and (minetest.get_us_time() - t < (us_timeout or 244)) do
+		node = minetest.get_node(pos_copy)
 	end
 
 	return node