hud.lua

if not minetest.settings:get_bool("settlements_show_in_hud", true) then
	return
end

-- internationalization boilerplate
local modpath = minetest.get_modpath(minetest.get_current_modname())
local S, NS = dofile(modpath.."/intllib.lua")

local requires_mappingkit = minetest.settings:get_bool("settlements_hud_requires_mapping_kit", true)
	and minetest.registered_items["map:mapping_kit"] -- rather than test for the map modpath, test whether the mapping_kit has been registered.

local discovery_range = tonumber(minetest.settings:get("settlements_discovery_range")) or 30
local visual_range = tonumber(minetest.settings:get("settlements_visibility_range")) or 600
local test_interval = 5 -- check every test_interval seconds

local player_huds = {}
-- Each player will have a table of [position_hash] = hud_id pairs in here

local add_hud_marker = function(player, player_name, pos, label)
	local waypoints = player_huds[player_name] or {}
	player_huds[player_name] = waypoints
	local pos_hash = minetest.hash_node_position(pos)
	if waypoints[pos_hash] then
		return
	end	
	local hud_id = player:hud_add({
		hud_elem_type = "waypoint",
		name = label,
		text = "m",
		number = 0xFFFFFF,
		world_pos = pos})
	waypoints[pos_hash] = hud_id
end

local remove_distant_hud_markers = function()
	local players_to_remove = {}
	for player_name, waypoints in pairs(player_huds) do
		local player = minetest.get_player_by_name(player_name)
		if player then
			local has_map = (not requires_mappingkit) or (player:get_inventory():contains_item("main", "map:mapping_kit"))
			local player_pos = player:get_pos()
			local waypoints_to_remove = {}
			for pos_hash, hud_id in pairs(waypoints) do
				local pos = minetest.get_position_from_hash(pos_hash)
				if (not has_map) or vector.distance(pos, player_pos) > visual_range then
					table.insert(waypoints_to_remove, pos_hash)
					player:hud_remove(hud_id)
				end
			end
			for _, pos_hash in ipairs(waypoints_to_remove) do
				waypoints[pos_hash] = nil
			end
			if not next(waypoints) then -- player's waypoint list is empty, remove it
				table.insert(players_to_remove, player_name)
			end
		else
			table.insert(players_to_remove, player_name)
		end
	end
	for _, player_name in ipairs(players_to_remove) do
		player_huds[player_name] = nil
	end
end

-- For flushing outdated HUD markers when certain admin commands are performed.
settlements.remove_all_hud_markers = function()
	for player_name, waypoints in pairs(player_huds) do
		local player = minetest.get_player_by_name(player_name)
		if player then
			for pos_hash, hud_id in pairs(waypoints) do
				player:hud_remove(hud_id)
			end
		end
	end
	player_huds = {}
end

local elapsed = 0
minetest.register_globalstep(function(dtime)
	elapsed = elapsed + dtime
	if elapsed < test_interval then
		return
	end
	elapsed = 0
	
	local connected_players = minetest.get_connected_players()
	local new_discovery = false
	for _, player in ipairs(connected_players) do
		local player_pos = player:get_pos()
		local player_name = player:get_player_name()
		
		local min_visual_edge = vector.subtract(player_pos, visual_range)
		local max_visual_edge = vector.add(player_pos, visual_range)
		local visual_settlements = settlements.settlements_in_world:get_areas_in_area(min_visual_edge, max_visual_edge, true, true, true)		
		for id, settlement in pairs(visual_settlements) do
		
			local data = minetest.deserialize(settlement.data)
			local distance = vector.distance(player_pos, settlement.min)
			local discovered_by = data.discovered_by
			local settlement_pos = vector.add(settlement.min, {x=0, y=2, z=0})
	
			if distance < discovery_range and not discovered_by[player_name] then
				-- Update areastore
				data.discovered_by[player_name] = true
				settlements.settlements_in_world:remove_area(id)
				settlements.settlements_in_world:insert_area(settlement.min, settlement.min, minetest.serialize(data), id)
				
				-- Mark that we'll need to save settlements
				new_discovery = true
				
				-- Notify player of their find
				local note_name = data.name or "a settlement"
				local discovery_note = S("You've discovered @1!", note_name)
				local formspec = "size[4,1]" ..
					"label[1.0,0.0;" .. minetest.formspec_escape(discovery_note) ..
					"]button_exit[0.5,0.75;3,0.5;btn_ok;".. S("OK") .."]"				
				minetest.show_formspec(player_name, "settlements:discovery_popup",
					formspec)
				minetest.chat_send_player(player_name, discovery_note)
				minetest.log("action", "[settlements] " .. player_name .. " discovered " .. note_name)
				minetest.sound_play({name = "settlements_chime01", gain = 0.25}, {to_player=player_name})
			end

			local has_map = (not requires_mappingkit) or (player:get_inventory():contains_item("main", "map:mapping_kit"))
			if has_map and distance < visual_range and discovered_by[player_name] then
				local settlement_name = data.name or "Town"
				add_hud_marker(player, player_name, settlement_pos, settlement_name)
			end
		end
	end
	remove_distant_hud_markers()

	if new_discovery then
		settlements.settlements_save()
	end
end)