Replace the actual builtin statbars (buggy!)

API.md

@@ -1,5 +1,5 @@
-API documentation for the HUD bars mod
-======================================
+API documentation for the HUD bars mod 1.6.1
+============================================
 
 ## Introduction
 This API allows you to add, change, hide and unhide custom HUD bars for this mod.
@@ -170,7 +170,7 @@ Makes a previously hidden HUD bar visible again to a player.
 
 
 ## Reading HUD bar information
-It is also possible to read information about existing HUD bars.
+It is also possible to read information about an active HUD bar.
 
 ### `hb.get_hudbar_state(player, identifier)`
 Returns the current state of the active player's HUD bar.
@@ -191,6 +191,3 @@ hold by the table is only true for the moment you called this function. The fiel
 * `text`: The text shown on the HUD bar. This fiels is meaningless if the HUD bar is currently hidden.
 
 If the player does not exist, returns `nil` instead.
-
-### `hb.get_hudbar_identifiers()`
-Returns a table of all currently registered HUD bar identifiers.

README.md

@@ -11,7 +11,7 @@ this mod will place them accordingly.
 position should be displayed correctly on every screen size.
 
 ## Current version
-The current version is 1.11.0.
+The current version is 1.6.1.
 
 This software uses [semantic versioning](http://semver.org), as defined by version 2.0.0 of the SemVer
 standard.
@@ -31,29 +31,25 @@ Author: Wuzzy (2015)
 Also: This mod was forked from the “Better HUD” [hud] mod by BlockMen.
 
 Translations:
-
 * German: Wuzzy
 * Portuguese: BrunoMine
-* Turkish: admicos
-* Dutch: kingoscargames
-* Italian: Hamlet
-* Malay: muhdnurhidayat
 
 This program is free software. It comes without any warranty, to
 the extent permitted by applicable law. You can redistribute it
-and/or modify it under the terms of the MIT License.
+and/or modify it under the terms of the Do What The Fuck You Want
+To Public License (WTFPL), version 2, as published by Sam Hocevar.
 
 ### Licenses of textures
 
 * `hudbars_icon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
 * `hudbars_bgicon_health.png`—celeron55 (CC BY-SA 3.0), modified by BlockMen
-* `hudbars_icon_breath.png`—kaeza (MIT License), modified by BlockMen, modified again by Wuzzy
-* `hudbars_bgicon_breath.png`—based on previous image, edited by Wuzzy (MIT License)
-* `hudbars_bar_health.png`—Wuzzy (MIT License)
-* `hudbars_bar_breath.png`—Wuzzy (MIT License)
-* `hudbars_bar_background.png`—Wuzzy (MIT License)
+* `hudbars_icon_breath.png`—kaeza (WTFPL), modified by BlockMen, modified again by Wuzzy
+* `hudbars_bgicon_breath.png`—based on previous image, edited by Wuzzy (WTFPL)
+* `hudbars_bar_health.png`—Wuzzy (WTFPL)
+* `hudbars_bar_breath.png`—Wuzzy (WTFPL)
+* `hudbars_bar_background.png`—Wuzzy (WTFPL)
 
 ### License references
 
 * [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)
-* [MIT License](https://opensource.org/licenses/MIT)
+* [WTFPL](http://sam.zoy.org/wtfpl/COPYING)

default_settings.lua

@@ -1,48 +0,0 @@
--- (Hardcoded) default settings
-
-hb.settings.max_bar_length = 160
-hb.settings.statbar_length = 20
-
--- Statbar positions
-hb.settings.pos_left = {}
-hb.settings.pos_right = {}
-hb.settings.start_offset_left = {}
-hb.settings.start_offset_right= {}
-hb.settings.pos_left.x = hb.load_setting("hudbars_pos_left_x", "number", 0.5)
-hb.settings.pos_left.y = hb.load_setting("hudbars_pos_left_y", "number", 1)
-hb.settings.pos_right.x = hb.load_setting("hudbars_pos_right_x", "number", 0.5)
-hb.settings.pos_right.y = hb.load_setting("hudbars_pos_right_y", "number", 1)
-hb.settings.bar_type = hb.load_setting("hudbars_bar_type", "string", "progress_bar", {"progress_bar", "statbar_classic", "statbar_modern"})
-if hb.settings.bar_type == "progress_bar" then
-	hb.settings.start_offset_left.x = hb.load_setting("hudbars_start_offset_left_x", "number", -175)
-	hb.settings.start_offset_left.y = hb.load_setting("hudbars_start_offset_left_y", "number", -86)
-	hb.settings.start_offset_right.x = hb.load_setting("hudbars_start_offset_right_x", "number", 15)
-	hb.settings.start_offset_right.y = hb.load_setting("hudbars_start_offset_right_y", "number", -86)
-else
-	hb.settings.start_offset_left.x = hb.load_setting("hudbars_start_statbar_offset_left_x", "number", -265)
-	hb.settings.start_offset_left.y = hb.load_setting("hudbars_start_statbar_offset_left_y", "number", -90)
-	hb.settings.start_offset_right.x = hb.load_setting("hudbars_start_statbar_offset_right_x", "number", 25)
-	hb.settings.start_offset_right.y = hb.load_setting("hudbars_start_statbar_offset_right_y", "number", -90)
-end
-hb.settings.vmargin  = hb.load_setting("hudbars_vmargin", "number", 24)
-hb.settings.tick = hb.load_setting("hudbars_tick", "number", 0.1)
-
--- Experimental setting: Changing this setting is not officially supported, do NOT rely on it!
-hb.settings.forceload_default_hudbars = hb.load_setting("hudbars_forceload_default_hudbars", "bool", true)
-
--- Misc. settings
-hb.settings.alignment_pattern = hb.load_setting("hudbars_alignment_pattern", "string", "zigzag", {"zigzag", "stack_up", "stack_down"})
-hb.settings.autohide_breath = hb.load_setting("hudbars_autohide_breath", "bool", true)
-
-local sorting = minetest.settings:get("hudbars_sorting")
-if sorting ~= nil then
-	hb.settings.sorting = {}
-	hb.settings.sorting_reverse = {}
-	for k,v in string.gmatch(sorting, "(%w+)=(%w+)") do
-		hb.settings.sorting[k] = tonumber(v)
-		hb.settings.sorting_reverse[tonumber(v)] = k
-	end
-else
-	hb.settings.sorting = { ["health"] = 0, ["breath"] = 1 }
-	hb.settings.sorting_reverse = { [0] = "health", [1] = "breath" }
-end

init.lua

@@ -1,10 +1,6 @@
 local S
-if minetest.global_exists("intllib") then
-	if intllib.make_gettext_pair then
-		S = intllib.make_gettext_pair()
-	else
-		S = intllib.Getter()
-	end
+if (minetest.get_modpath("intllib")) then
+	S = intllib.Getter()
 else
 	S = function ( s ) return s end
 end
@@ -24,11 +20,11 @@ hb.settings = {}
 function hb.load_setting(sname, stype, defaultval, valid_values)
 	local sval
 	if stype == "string" then
-		sval = minetest.settings:get(sname)
+		sval = minetest.setting_get(sname)
 	elseif stype == "bool" then
-		sval = minetest.settings:get_bool(sname)
+		sval = minetest.setting_getbool(sname)
 	elseif stype == "number" then
-		sval = tonumber(minetest.settings:get(sname))
+		sval = tonumber(minetest.setting_get(sname))
 	end
 	if sval ~= nil then
 		if valid_values ~= nil then
@@ -52,13 +48,90 @@ function hb.load_setting(sname, stype, defaultval, valid_values)
 	end
 end
 
--- Load default settings
-dofile(minetest.get_modpath("hudbars").."/default_settings.lua")
+-- (hardcoded) default settings
+hb.settings.max_bar_length = 160
+hb.settings.statbar_length = 20
+
+-- statbar positions
+hb.settings.pos_left = {}
+hb.settings.pos_right = {}
+hb.settings.start_offset_left = {}
+hb.settings.start_offset_right= {}
+hb.settings.pos_left.x = hb.load_setting("hudbars_pos_left_x", "number", 0.5)
+hb.settings.pos_left.y = hb.load_setting("hudbars_pos_left_y", "number", 1)
+hb.settings.pos_right.x = hb.load_setting("hudbars_pos_right_x", "number", 0.5)
+hb.settings.pos_right.y = hb.load_setting("hudbars_pos_right_y", "number", 1)
+hb.settings.bar_type = hb.load_setting("hudbars_bar_type", "string", "progress_bar", {"progress_bar", "statbar_classic", "statbar_modern"})
+if hb.settings.bar_type == "progress_bar" then
+	hb.settings.start_offset_left.x = hb.load_setting("hudbars_start_offset_left_x", "number", -175)
+	hb.settings.start_offset_left.y = hb.load_setting("hudbars_start_offset_left_y", "number", -86)
+	hb.settings.start_offset_right.x = hb.load_setting("hudbars_start_offset_right_x", "number", 15)
+	hb.settings.start_offset_right.y = hb.load_setting("hudbars_start_offset_right_y", "number", -86)
+else
+	hb.settings.start_offset_left.x = hb.load_setting("hudbars_start_statbar_offset_left_x", "number", -265)
+	hb.settings.start_offset_left.y = hb.load_setting("hudbars_start_statbar_offset_left_y", "number", -88)
+	hb.settings.start_offset_right.x = hb.load_setting("hudbars_start_statbar_offset_right_x", "number", 25)
+	hb.settings.start_offset_right.y = hb.load_setting("hudbars_start_statbar_offset_right_y", "number", -88)
+end
+hb.settings.vmargin  = hb.load_setting("hudbars_vmargin", "number", 24)
+hb.settings.tick = hb.load_setting("hudbars_tick", "number", 0.1)
+
+-- experimental setting: Changing this setting is not officially supported, do NOT rely on it!
+hb.settings.forceload_default_hudbars = hb.load_setting("hudbars_forceload_default_hudbars", "bool", true)
+
+-- Misc. settings
+hb.settings.alignment_pattern = hb.load_setting("hudbars_alignment_pattern", "string", "zigzag", {"zigzag", "stack_up", "stack_down"})
+hb.settings.autohide_breath = hb.load_setting("hudbars_autohide_breath", "bool", true)
+
+local sorting = minetest.setting_get("hudbars_sorting")
+if sorting ~= nil then
+	hb.settings.sorting = {}
+	hb.settings.sorting_reverse = {}
+	for k,v in string.gmatch(sorting, "(%w+)=(%w+)") do
+		hb.settings.sorting[k] = tonumber(v)
+		hb.settings.sorting_reverse[tonumber(v)] = k
+	end
+else
+	hb.settings.sorting = { ["health"] = 0, ["breath"] = 1 }
+	hb.settings.sorting_reverse = { [0] = "health", [1] = "breath" }
+end
 
 local function player_exists(player)
 	return player ~= nil and player:is_player()
 end
 
+local function barindex_to_pos_and_offset(index)
+	local pos, offset
+	if hb.settings.alignment_pattern == "stack_up" then
+		pos = hb.settings.pos_left
+		offset = {
+			x = hb.settings.start_offset_left.x,
+			y = hb.settings.start_offset_left.y - hb.settings.vmargin * index
+		}
+	elseif hb.settings.alignment_pattern == "stack_down" then
+		pos = hb.settings.pos_left
+		offset = {
+			x = hb.settings.start_offset_left.x,
+			y = hb.settings.start_offset_left.y + hb.settings.vmargin * index
+		}
+	else
+		if index % 2 == 0 then
+			pos = hb.settings.pos_left
+			offset = {
+				x = hb.settings.start_offset_left.x,
+				y = hb.settings.start_offset_left.y - hb.settings.vmargin * (index/2)
+			}
+		else
+			pos = hb.settings.pos_right
+			offset = {
+				x = hb.settings.start_offset_right.x,
+				y = hb.settings.start_offset_right.y - hb.settings.vmargin * ((index-1)/2)
+			}
+		end
+	end
+	return pos, offset
+end
+
 -- Table which contains all players with active default HUD bars (only for internal use)
 hb.players = {}
 
@@ -104,33 +177,9 @@ function hb.register_hudbar(identifier, text_color, label, textures, default_sta
 	local pos, offset
 	local index = math.floor(hb.get_hudbar_position_index(identifier))
 	hb.registered_slots[index] = true
-	if hb.settings.alignment_pattern == "stack_up" then
-		pos = hb.settings.pos_left
-		offset = {
-			x = hb.settings.start_offset_left.x,
-			y = hb.settings.start_offset_left.y - hb.settings.vmargin * index
-		}
-	elseif hb.settings.alignment_pattern == "stack_down" then
-		pos = hb.settings.pos_left
-		offset = {
-			x = hb.settings.start_offset_left.x,
-			y = hb.settings.start_offset_left.y + hb.settings.vmargin * index
-		}
-	else
-		if index % 2 == 0 then
-			pos = hb.settings.pos_left
-			offset = {
-				x = hb.settings.start_offset_left.x,
-				y = hb.settings.start_offset_left.y - hb.settings.vmargin * (index/2)
-			}
-		else
-			pos = hb.settings.pos_right
-			offset = {
-				x = hb.settings.start_offset_right.x,
-				y = hb.settings.start_offset_right.y - hb.settings.vmargin * ((index-1)/2)
-			}
-		end
-	end
+
+	pos, offset = barindex_to_pos_and_offset(index)
+
 	if format_string == nil then
 		format_string = S("%s: %d/%d")
 	end
@@ -200,7 +249,7 @@ function hb.register_hudbar(identifier, text_color, label, textures, default_sta
 			bar_image = textures.icon
 			bar_size = {x=24, y=24}
 		end
-		ids.bar = player:hud_add({
+		local bardef = {
 			hud_elem_type = "statbar",
 			position = pos,
 			text = bar_image,
@@ -209,7 +258,10 @@ function hb.register_hudbar(identifier, text_color, label, textures, default_sta
 			offset = offset,
 			direction = 0,
 			size = bar_size,
-		})
+		}
+		if hudtable.identifier ~= "health" and hudtable.identifier ~= "breath" then
+			ids.bar = player:hud_add(bardef)
+		end
 		if hb.settings.bar_type == "progress_bar" then
 			ids.text = player:hud_add({
 				hud_elem_type = "text",
@@ -255,7 +307,7 @@ function hb.register_hudbar(identifier, text_color, label, textures, default_sta
 	hudtable.default_start_max = default_start_max
 
 	hb.hudbars_count= hb.hudbars_count + 1
-	
+
 	hb.hudtables[identifier] = hudtable
 end
 
@@ -302,7 +354,7 @@ function hb.change_hudbar(player, identifier, new_value, new_max_value, new_icon
 		if new_bgicon ~= nil and hudtable.hudids[name].bgicon ~= nil then
 			player:hud_change(hudtable.hudids[name].bgicon, "text", new_bgicon)
 		end
-		if new_bar ~= nil then
+		if new_bar ~= nil and hudtable.hudids[name].bar ~= nil then
 			player:hud_change(hudtable.hudids[name].bar , "text", new_bar)
 		end
 		if new_label ~= nil then
@@ -345,7 +397,7 @@ function hb.change_hudbar(player, identifier, new_value, new_max_value, new_icon
 
 		if value_changed or max_changed then
 			local new_barlength = hb.value_to_barlength(new_value, new_max_value)
-			if new_barlength ~= hudtable.hudstate[name].barlength then
+			if new_barlength ~= hudtable.hudstate[name].barlength and hudtable.hudids[name].bar ~= nil then
 				player:hud_change(hudtable.hudids[name].bar, "number", hb.value_to_barlength(new_value, new_max_value))
 				hudtable.hudstate[name].barlength = new_barlength
 			end
@@ -377,7 +429,9 @@ function hb.hide_hudbar(player, identifier)
 		elseif hb.settings.bar_type == "statbar_modern" then
 			player:hud_change(hudtable.hudids[name].bg, "number", 0)
 		end
-		player:hud_change(hudtable.hudids[name].bar, "number", 0)
+		if hudtable.hudids[name].bar ~= nil then
+			player:hud_change(hudtable.hudids[name].bar, "number", 0)
+		end
 		hudtable.hudstate[name].hidden = true
 	end
 	return true
@@ -402,7 +456,9 @@ function hb.unhide_hudbar(player, identifier)
 		elseif hb.settings.bar_type == "statbar_modern" then
 			player:hud_change(hudtable.hudids[name].bg, "number", hb.settings.statbar_length)
 		end
-		player:hud_change(hudtable.hudids[name].bar, "number", hb.value_to_barlength(value, max))
+		if hudtable.hudids[name].bar ~= nil then
+			player:hud_change(hudtable.hudids[name].bar, "number", hb.value_to_barlength(value, max))
+		end
 		hudtable.hudstate[name].hidden = false
 	end
 	return true
@@ -422,32 +478,66 @@ function hb.get_hudbar_state(player, identifier)
 	return copy
 end
 
-function hb.get_hudbar_identifiers()
-	local ids = {}
-	for id, _ in pairs(hb.hudtables) do
-		table.insert(ids, id)
-	end
-	return ids
-end
-
 --register built-in HUD bars
-if minetest.settings:get_bool("enable_damage") or hb.settings.forceload_default_hudbars then
-	hb.register_hudbar("health", 0xFFFFFF, S("Health"), { bar = "hudbars_bar_health.png", icon = "hudbars_icon_health.png", bgicon = "hudbars_bgicon_health.png" }, 20, 20, false)
-	hb.register_hudbar("breath", 0xFFFFFF, S("Breath"), { bar = "hudbars_bar_breath.png", icon = "hudbars_icon_breath.png", bgicon = "hudbars_bgicon_breath.png" }, 10, 10, true)
-end
+if minetest.setting_getbool("enable_damage") or hb.settings.forceload_default_hudbars then
+	local healthtextures = { bar = "hudbars_bar_health.png", icon = "hudbars_icon_health.png", bgicon = "hudbars_bgicon_health.png" }
+	local breathtextures = { bar = "hudbars_bar_breath.png", icon = "hudbars_icon_breath.png", bgicon = "hudbars_bgicon_breath.png" }
 
-local function hide_builtin(player)
-	local flags = player:hud_get_flags()
-	flags.healthbar = false
-	flags.breathbar = false
-	player:hud_set_flags(flags)
-end
+	hb.register_hudbar("health", 0xFFFFFF, S("Health"), healthtextures, 20, 20, false)
+	hb.register_hudbar("breath", 0xFFFFFF, S("Breath"), breathtextures, 10, 10, true)
 
+	-- Overwrite the builtin statbars for the best client prediction
+
+	-- FIXME: Health icons are drawn behind the modern statbar background
+	-- FIXME: Breath bar is drawn above text
+
+	local bar_health, bar_breath, size_health, size_breath
+	if hb.settings.bar_type == "progress_bar" then
+		bar_health = healthtextures.bar
+		bar_breath = breathtextures.bar
+		size_health  = {x=hb.value_to_barlength(1,20)*2, y=16}
+		size_breath = {x=hb.value_to_barlength(1,20)*2, y=16}
+	elseif hb.settings.bar_type == "statbar_classic" or hb.settings.bar_type == "statbar_modern" then
+		bar_health = healthtextures.icon
+		bar_breath = breathtextures.icon
+		size_health = {x=24, y=24}
+		size_breath = {x=24, y=24}
+	end
+
+	local hudtable = hb.get_hudtable("health")
+	local pos, offset = barindex_to_pos_and_offset(hb.get_hudbar_position_index("health"))
+	local bardef = {
+		hud_elem_type = "statbar",
+		position = pos,
+		text = bar_health,
+		number = 20,
+		alignment = {x=-1,y=-1},
+		offset = offset,
+		direction = 0,
+		size = size_health,
+	}
+	minetest.hud_replace_builtin("health", bardef)
+
+	pos, offset = barindex_to_pos_and_offset(hb.get_hudbar_position_index("breath"))
+	hudtable = hb.get_hudtable("breath")
+	bardef = {
+		hud_elem_type = "statbar",
+		position = pos,
+		text = bar_breath,
+		number = 20,
+		alignment = {x=-1,y=-1},
+		offset = offset,
+		direction = 0,
+		size = size_breath,
+	}
+	minetest.hud_replace_builtin("breath", bardef)
+
+end
 
 local function custom_hud(player)
-	if minetest.settings:get_bool("enable_damage") or hb.settings.forceload_default_hudbars then
+	if minetest.setting_getbool("enable_damage") or hb.settings.forceload_default_hudbars then
 		local hide
-		if minetest.settings:get_bool("enable_damage") then
+		if minetest.setting_getbool("enable_damage") then
 			hide = false
 		else
 			hide = true
@@ -467,13 +557,13 @@ end
 -- update built-in HUD bars
 local function update_hud(player)
 	if not player_exists(player) then return end
-	if minetest.settings:get_bool("enable_damage") then
+	if minetest.setting_getbool("enable_damage") then
 		if hb.settings.forceload_default_hudbars then
 			hb.unhide_hudbar(player, "health")
 		end
 		--air
 		local breath = player:get_breath()
-		
+
 		if breath == 11 and hb.settings.autohide_breath == true then
 			hb.hide_hudbar(player, "breath")
 		else
@@ -488,11 +578,7 @@ local function update_hud(player)
 	end
 end
 
-minetest.register_on_player_hpchange(function(player)
-	if hb.players[player:get_player_name()] ~= nil then
-		update_health(player)
-	end
-end)
+minetest.register_on_player_hpchange(update_health)
 
 minetest.register_on_respawnplayer(function(player)
 	update_health(player)
@@ -500,7 +586,6 @@ minetest.register_on_respawnplayer(function(player)
 end)
 
 minetest.register_on_joinplayer(function(player)
-	hide_builtin(player)
 	custom_hud(player)
 	hb.players[player:get_player_name()] = player
 end)
@@ -517,7 +602,7 @@ minetest.register_globalstep(function(dtime)
 	if main_timer > hb.settings.tick or timer > 4 then
 		if main_timer > hb.settings.tick then main_timer = 0 end
 		-- only proceed if damage is enabled
-		if minetest.settings:get_bool("enable_damage") or hb.settings.forceload_default_hudbars then
+		if minetest.setting_getbool("enable_damage") or hb.settings.forceload_default_hudbars then
 			for _, player in pairs(hb.players) do
 				-- update all hud elements
 				update_hud(player)

locale/it.txt

@@ -1,5 +0,0 @@
-Health = Salute
-Breath = Ossigeno
-
-# Default format string for progress bar-style HUD bars, e.g. “Health 5/20”
-%s: %d/%d

locale/ms.txt

@@ -1,3 +0,0 @@
-Health = Kesihatan
-Breath = Nafas
-%s: %d/%d = %s: %d/%d

locale/nl.txt

@@ -1,5 +0,0 @@
-Health = Gezondheid
-Breath = Adem
-
-# Default format string for progress bar-style HUD bars, e.g. “Health 5/20”
-%s: %d/%d

locale/tr.txt

@@ -1,3 +0,0 @@
-Health = Can
-Breath = Nefes
-%s: %d/%d = %s: %d/%d

settingtypes.txt

@@ -99,7 +99,7 @@ hudbars_start_statbar_offset_left_x (Left HUD statbar x offset) int -265
 # Precise y offset in pixels from the basic screen y position of the HUD statbars.
 # For the zig-zag alignment pattern, this is for the left HUD statbars.
 # This setting is used for the classic and modern statbar styles.
-hudbars_start_statbar_offset_left_y (Left HUD statbar y offset) int -90
+hudbars_start_statbar_offset_left_y (Left HUD statbar y offset) int -88
 # Precise x offset in pixels from the basic screen x position of the right HUD statbars.
 # Only used for the zig-zag alignment pattern.
 # This setting is used for the classic and modern statbar styles.
@@ -107,7 +107,7 @@ hudbars_start_statbar_offset_right_x (Right HUD statbar x offset) int 25
 # Precise y offset in pixels from the basic screen y position of the right HUD statbars.
 # Only used for the zig-zag alignment pattern.
 # This setting is used for the classic and modern statbar styles.
-hudbars_start_statbar_offset_right_y (Right HUD statbar y offset) int -90
+hudbars_start_statbar_offset_right_y (Right HUD statbar y offset) int -88
 
 # The vertical distance between two HUD bars, in pixels.
 hudbars_vmargin (Vertical distance between HUD bars) int 24 0