From 720f6003ba4e23981044fa986d6e8ec73e0686b0 Mon Sep 17 00:00:00 2001
From: OgelGames <olliverdc28@gmail.com>
Date: Fri, 5 Jul 2024 11:17:19 +1000
Subject: [PATCH] Add vacuum tube visualizations using `vizlib` (#128)

---
 .luacheckrc      |  2 +-
 mod.conf         |  2 +-
 tubes/vacuum.lua | 13 +++++++++++++
 3 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/.luacheckrc b/.luacheckrc
index 6d2f92f..ef7e76b 100644
--- a/.luacheckrc
+++ b/.luacheckrc
@@ -21,6 +21,6 @@ read_globals = {
 	"default", "mesecon", "digiline",
 	"screwdriver", "unified_inventory",
 	"i3", "mcl_experience", "awards",
-	"xcompat", "fakelib",
+	"xcompat", "fakelib", "vizlib",
 
 }
diff --git a/mod.conf b/mod.conf
index ea1a06d..3f8158a 100644
--- a/mod.conf
+++ b/mod.conf
@@ -1,5 +1,5 @@
 name = pipeworks
 description = This mod uses mesh nodes and nodeboxes to supply a complete set of 3D pipes and tubes, along with devices that work with them.
 depends = basic_materials, xcompat, fakelib
-optional_depends = mesecons, mesecons_mvps, digilines, signs_lib, unified_inventory, default, screwdriver, fl_mapgen, sound_api, i3, hades_core, hades_furnaces, hades_chests, mcl_mapgen_core, mcl_barrels, mcl_furnaces, mcl_experience
+optional_depends = mesecons, mesecons_mvps, digilines, signs_lib, unified_inventory, default, screwdriver, fl_mapgen, sound_api, i3, hades_core, hades_furnaces, hades_chests, mcl_mapgen_core, mcl_barrels, mcl_furnaces, mcl_experience, vizlib
 min_minetest_version = 5.5.0
diff --git a/tubes/vacuum.lua b/tubes/vacuum.lua
index 8298cc5..d78d837 100644
--- a/tubes/vacuum.lua
+++ b/tubes/vacuum.lua
@@ -1,6 +1,8 @@
 
 local S = minetest.get_translator("pipeworks")
 
+local has_vislib = minetest.get_modpath("vizlib")
+
 local enable_max = minetest.settings:get_bool("pipeworks_enable_items_per_tube_limit", true)
 local max_items = tonumber(minetest.settings:get("pipeworks_max_items_per_tube")) or 30
 max_items = math.ceil(max_items / 2)  -- Limit vacuuming to half the max limit
@@ -38,6 +40,15 @@ local function repair_tube(pos, was_node)
 	set_timer(pos)
 end
 
+local function show_area(pos, node, player)
+	if not player or player:get_wielded_item():get_name() ~= "" then
+		-- Only show area when using an empty hand
+		return
+	end
+	local radius = tonumber(minetest.get_meta(pos):get("dist")) or 2
+	vizlib.draw_cube(pos, radius + 0.5, {player = player})
+end
+
 if pipeworks.enable_sand_tube then
 	pipeworks.register_tube("pipeworks:sand_tube", {
 		description = S("Vacuuming Pneumatic Tube Segment"),
@@ -56,6 +67,7 @@ if pipeworks.enable_sand_tube then
 				vacuum(pos, 2)
 				set_timer(pos)
 			end,
+			on_punch = has_vislib and show_area or nil,
 		},
 	})
 end
@@ -101,6 +113,7 @@ if pipeworks.enable_mese_sand_tube then
 				meta:set_int("dist", dist)
 				meta:set_string("infotext", S("Adjustable Vacuuming Tube (@1m)", dist))
 			end,
+			on_punch = has_vislib and show_area or nil,
 		},
 	})
 end