Merge branch 'github'

If a player teleports far away, their hp_bar can become deactivated and disappear. The mod installs the gauge only when a player joins, so it will be forever missing. `static_save = false` prevents the item from deactivating https://github.com/minetest/minetest/blob/master/src/serverenvironment.cpp#L2028 .
Also, it doesn't make sense to save `gauges:hp_bar` to map meta since it's not a standalone item.

.luacheckrc

@@ -21,6 +21,11 @@ stds.minetest = {
 				"copy",
 			},
 		},
+		math = {
+			fields = {
+				"round",
+			},
+		}
 	}
 }
 

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.1.0
+    rev: v2.3.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace

.travis.yml

@@ -1,16 +1,16 @@
-language: generic
+dist: bionic
+language: python
 
-addons:
-  apt:
-    packages:
-    - luarocks
+python:
+  - 3.7.1
 
 install:
-  - pyenv global 3.6.3
-  - pip3 install --user pre-commit
+  - sudo apt-get update -qq
+  - sudo apt-get install -qqq luarocks
+  - pip3 install pre-commit
   - luarocks install --local luacheck
 
 script:
   # All linters are run with pre-commit hooks
   - export PATH="$HOME/.luarocks/bin:$PATH"
-  - $HOME/.local/bin/pre-commit run --all-files
+  - pre-commit run --all-files

CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- [Health and breath bars now adapt to custom maximum values instead of being hardcoded to 20 and 11 respectively.](https://github.com/minetest-mods/gauges/pull/9)
+
+### Fixed
+
+- [The health bar entity is no longer lost when a player teleports.](https://github.com/minetest-mods/gauges/pull/10)
+  - A side effect is that health bar entities are no longer saved in map metadata.
+
+## [1.0.4] - 2020-09-27
+
+### Added
+
+- Support for Minetest 5.3 and improved Minetest version definitions.
+
+### Changed
+
+- Gauge entities are now removed when the mod is disabled or when the server switches to creative mode.
+
+## [1.0.3] - 2020-02-15
+
+### Fixed
+
+- Fix an issue with gauges occasionally no longer appearing above a player.
+
+### Changed
+
+- Improved the reliability of the Minetest version check (for compatibility with 0.4.17).
+
+## [1.0.2] - 2020-01-16
+
+### Fixed
+
+- Fix crash when creating an entity if a player leaves the server quickly.
+
+### Changed
+
+- Restore Minetest 0.4.17 support. The version check works only with `minetest_game` with the `player_api` mod added in Minetest 5.0.
+
+## [1.0.1] - 2020-01-01
+
+### Changed
+
+- Improve performance by localizing the `vector.distance()` function.
+
+## 1.0.0 - 2020-01-01
+
+- Initial versioned release.
+
+[Unreleased]: https://github.com/minetest-mods/gauges/compare/v1.0.4...HEAD
+[1.0.4]: https://github.com/minetest-mods/gauges/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/minetest-mods/gauges/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/minetest-mods/gauges/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/minetest-mods/gauges/compare/v1.0.0...v1.0.1

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2014-2019 4aiman, Hugo Locurcio and contributors
+Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,5 +1,7 @@
 # Gauges
 
+![Preview](https://content.minetest.net/uploads/GBoKauWSou.png)
+
 Gauges for [Minetest](https://www.minetest.net/), a free and open source infinite
 world block sandbox game.
 
@@ -13,14 +15,12 @@ To install Gauges, clone this Git repository into your Minetest's `mods/`
 directory:
 
 ```bash
-git clone https://github.com/Calinou/gauges.git
+git clone https://github.com/minetest-mods/gauges.git
 ```
 
 You can also
-[download a ZIP archive](https://github.com/Calinou/gauges/archive/master.zip)
-of Gauges. If you do so, you will need to extract the archive then rename
-the resulting folder from `gauges-master` to `gauges` – this is
-**absolutely** required, as the mod won't work otherwise.
+[download a ZIP archive](https://github.com/minetest-mods/gauges/archive/master.zip)
+of Gauges.
 
 ### Enable the mod
 
@@ -60,13 +60,12 @@ on that line.
 
 ## Version compatibility
 
-Gauges is currently primarily tested with Minetest 0.4.17.
-It may or may not work with newer or older versions. Issues arising in older
-versions than 0.4.17 will generally not be fixed.
+Gauges currently supports Minetest 5.0 and later, as well as 0.4.17.
+Issues arising in versions older than 5.0 will generally not be fixed.
 
 ## License
 
-Copyright © 2014-2019 4aiman, Hugo Locurcio and contributors
+Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors
 
 - Code is licensed under the MIT license, see
   [`LICENSE.md`](LICENSE.md) for details.

init.lua

@@ -1,65 +1,97 @@
 -- gauges: Adds health/breath bars above players
 --
--- Copyright © 2014-2019 4aiman, Hugo Locurcio and contributors - MIT License
+-- Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors - MIT License
 -- See `LICENSE.md` included in the source distribution for details.
 
-local hp_bar = {
-	physical = false,
-	collisionbox = {x = 0, y = 0, z = 0},
-	visual = "sprite",
-	textures = {"20.png"}, -- The texture is changed later in the code
-	visual_size = {x = 1.5, y = 0.09375, z = 1.5}, -- Y value is (1 / 16) * 1.5
-	wielder = nil,
+local function round(v)
+	return math.floor(v + 0.5)
+end
+
+local enabled = minetest.settings:get_bool("health_bars") ~= false
+if enabled then
+	enabled = minetest.settings:get_bool("enable_damage")
+end
+
+-- Localize this functions for better performance,
+-- as it's called on every step
+local vector_distance = vector.distance
+local max = {
+	breath = 11,
+	hp = 20,
 }
 
-function vector.sqdist(a, b)
-	local dx = a.x - b.x
-	local dy = a.y - b.y
-	local dz = a.z - b.z
-	return dx * dx + dy * dy + dz * dz
-end
+local mt_5 = minetest.features.object_independent_selectionbox
 
-function hp_bar:on_step(dtime)
-	local wielder = self.wielder and minetest.get_player_by_name(self.wielder)
+local function add_gauge(player)
+	if player and player:is_player() then
+		local entity = minetest.add_entity(player:get_pos(), "gauges:hp_bar")
 
-	if
-		wielder == nil or
-		vector.sqdist(wielder:get_pos(), self.object:get_pos()) > 3
-	then
-		self.object:remove()
-		return
-	end
+		-- Check Minetest version and set required entity heigh
+		-- (The entity height offset was changed in Minetest 5.0.0)
+		local height = mt_5 and 19 or 9
 
-	local hp = wielder:get_hp()
-	local breath = wielder:get_breath()
-
-	self.object:set_properties({
-		textures = {
-			"health_" .. tostring(hp) .. ".png^breath_" .. tostring(breath) .. ".png",
-		},
-	})
-end
-
-minetest.register_entity("gauges:hp_bar", hp_bar)
-
-local function add_HP_gauge(name)
-	local player = minetest.get_player_by_name(name)
-	local pos = player:get_pos()
-	local ent = minetest.add_entity(pos, "gauges:hp_bar")
-
-	if ent ~= nil then
-		ent:set_attach(player, "", {x = 0, y = 10, z = 0}, {x = 0, y = 0, z = 0})
-		ent = ent:get_luaentity()
-		ent.wielder = player:get_player_name()
+		entity:set_attach(player, "", {x=0, y=height, z=0}, {x=0, y=0, z=0})
+		entity:get_luaentity().wielder = player
 	end
 end
 
-if
-	minetest.settings:get_bool("enable_damage") and
-	minetest.settings:get_bool("health_bars") ~= false
-then
+-- credit: https://github.com/minetest/minetest/blob/6de8d77e17017cd5cc7b065d42566b6b1cd076cc/builtin/game/statbars.lua#L30-L37
+local function scaleToDefault(player, field)
+	-- Scale "hp" or "breath" to supported amount
+	local current = player["get_" .. field](player)
+	local max_display = math.max(player:get_properties()[field .. "_max"], current)
+	return round(current / max_display * max[field])
+end
+
+minetest.register_entity("gauges:hp_bar", {
+	visual = "sprite",
+	visual_size = {x=1, y=1/16, z=1},
+	textures = {"blank.png"},
+	collisionbox = {0},
+	physical = false,
+	static_save = false,
+
+	on_step = function(self)
+		local player = self.wielder
+		local gauge = self.object
+
+		if not enabled or
+				not player or not player:is_player() then
+			gauge:remove()
+			return
+		elseif vector_distance(player:get_pos(), gauge:get_pos()) > 3 then
+			gauge:remove()
+			add_gauge(player)
+			return
+		end
+
+		local hp = scaleToDefault(player, "hp")
+		local breath = scaleToDefault(player, "breath")
+
+		if self.hp ~= hp or self.breath ~= breath then
+			local health_t = "health_"..hp..".png"
+			local breath_t = "breath_"..breath..".png"
+
+			if hp == 0 then
+				health_t = "blank.png"
+			end
+
+			if breath == max.breath then
+				breath_t = "blank.png"
+			end
+
+			gauge:set_properties({
+				textures = {health_t.."^"..breath_t}
+			})
+			self.hp = hp
+			self.breath = breath
+		end
+	end
+})
+
+if enabled then
 	minetest.register_on_joinplayer(function(player)
-		minetest.after(1, add_HP_gauge, player:get_player_name())
+		minetest.after(1, add_gauge, player)
 	end)
 end
 

mod.conf

@@ -0,0 +1,3 @@
+name = gauges
+description = Adds health and breath gauges above players.
+min_minetest_version = 0.4.17