Customizeable max breath and max hp for players

* it closes https://codeberg.org/minenux/minetest-engine-minetest/issues/33
* Statbars: Downscale bar to full 20 HP when exceeding this value
  Add default max HP for players and breath constants to builtin
  Document the constants
  Rename PLAYER_MAX_HP -> PLAYER_MAX_HP_DEFAULT
* implements PLAYER_MAX_BREATH_DEFAULT Customizeable max breath for players
  edbc533414
  so close https://github.com/minetest/minetest/issues/1972 that
  imports pr https://github.com/minetest/minetest/pull/6411
* implements PLAYER_MAX_HP_DEFAULT Respect object property hp_max field for players
  f7d50a8078
* so close https://github.com/minetest/minetest/issues/2246 that
  imports https://github.com/minetest/minetest/pull/6287

builtin/game/constants.lua

@@ -21,6 +21,10 @@ core.EMERGE_GENERATED   = 4
 -- constants.h
 -- Size of mapblocks in nodes
 core.MAP_BLOCKSIZE = 16
+-- Default maximal HP of a player
+core.PLAYER_MAX_HP_DEFAULT = 20
+-- Default maximal breath of a player
+core.PLAYER_MAX_BREATH_DEFAULT = 11
 
 -- light.h
 -- Maximum value for node 'light_source' parameter

builtin/game/statbars.lua

@@ -6,7 +6,7 @@ local health_bar_definition =
 	hud_elem_type = "statbar",
 	position = { x=0.5, y=1 },
 	text = "heart.png",
-	number = 20,
+	number = core.PLAYER_MAX_HP_DEFAULT,
 	direction = 0,
 	size = { x=24, y=24 },
 	offset = { x=(-10*24)-25, y=-(48+24+16)},
@@ -17,7 +17,7 @@ local breath_bar_definition =
 	hud_elem_type = "statbar",
 	position = { x=0.5, y=1 },
 	text = "bubble.png",
-	number = 20,
+	number = core.PLAYER_MAX_BREATH_DEFAULT,
 	direction = 0,
 	size = { x=24, y=24 },
 	offset = {x=25,y=-(48+24+16)},
@@ -25,6 +25,15 @@ local breath_bar_definition =
 
 local hud_ids = {}
 
+local function scaleToDefault(player, field)
+	-- Scale "hp" or "breath" to the default dimensions
+	local current = player["get_" .. field](player)
+	local nominal = core["PLAYER_MAX_".. field:upper() .. "_DEFAULT"]
+	local max_display = math.max(nominal,
+		math.max(player:get_properties()[field .. "_max"], current))
+	return current / max_display * nominal 
+end
+
 local function initialize_builtin_statbars(player)
 
 	if not player:is_player() then
@@ -37,39 +46,39 @@ local function initialize_builtin_statbars(player)
 		return
 	end
 
-	if (hud_ids[name] == nil) then
+	if not hud_ids[name] then
 		hud_ids[name] = {}
 		-- flags are not transmitted to client on connect, we need to make sure
 		-- our current flags are transmitted by sending them actively
 		player:hud_set_flags(player:hud_get_flags())
 	end
+	local hud = hud_ids[name]
 
 	if player:hud_get_flags().healthbar and enable_damage then
- 		if hud_ids[name].id_healthbar == nil then
-			health_bar_definition.number = player:get_hp()
-			hud_ids[name].id_healthbar  = player:hud_add(health_bar_definition)
-		end
-	else
-		if hud_ids[name].id_healthbar ~= nil then
-			player:hud_remove(hud_ids[name].id_healthbar)
-			hud_ids[name].id_healthbar = nil
+		if hud.id_healthbar == nil then
+ 			local hud_def = table.copy(health_bar_definition)
+			hud_def.number = scaleToDefault(player, "hp")
+			hud.id_healthbar = player:hud_add(hud_def)
 		end
+	elseif hud.id_healthbar ~= nil then
+		player:hud_remove(hud.id_healthbar)
+		hud.id_healthbar = nil
 	end
 
-	if (player:get_breath() < 11) then
-		if player:hud_get_flags().breathbar and enable_damage then
-			if hud_ids[name].id_breathbar == nil then
-				hud_ids[name].id_breathbar = player:hud_add(breath_bar_definition)
-			end
-		else
-			if hud_ids[name].id_breathbar ~= nil then
-				player:hud_remove(hud_ids[name].id_breathbar)
-				hud_ids[name].id_breathbar = nil
-			end
+	local breath_max = core.PLAYER_MAX_BREATH_DEFAULT
+
+	if player:get_properties().breath_max then breath_max = player:get_properties().breath_max end
+
+	if player:hud_get_flags().breathbar and enable_damage and
+			player:get_breath() < breath_max then
+		if hud.id_breathbar == nil then
+ 			local hud_def = table.copy(breath_bar_definition)
+ 			hud_def.number = 2 * scaleToDefault(player, "breath")
+			hud.id_breathbar = player:hud_add(hud_def)
 		end
-	elseif hud_ids[name].id_breathbar ~= nil then
-		player:hud_remove(hud_ids[name].id_breathbar)
-		hud_ids[name].id_breathbar = nil
+	elseif hud.id_breathbar ~= nil then
+		player:hud_remove(hud.id_breathbar)
+		hud.id_breathbar = nil
 	end
 end
 
@@ -101,7 +110,8 @@ local function player_event_handler(player,eventname)
 		initialize_builtin_statbars(player)
 
 		if hud_ids[name].id_healthbar ~= nil then
-			player:hud_change(hud_ids[name].id_healthbar,"number",player:get_hp())
+			player:hud_change(hud_ids[name].id_healthbar,
+				"number", scaleToDefault(player, "hp"))
 			return true
 		end
 	end
@@ -110,7 +120,8 @@ local function player_event_handler(player,eventname)
 		initialize_builtin_statbars(player)
 
 		if hud_ids[name].id_breathbar ~= nil then
-			player:hud_change(hud_ids[name].id_breathbar,"number",player:get_breath()*2)
+			player:hud_change(hud_ids[name].id_breathbar,
+				"number", 2 * scaleToDefault(player, "breath"))
 			return true
 		end
 	end

doc/lua_api.txt

@@ -3345,7 +3345,8 @@ This is basically a reference to a C++ `ServerActiveObject`
      * values:
         * `0`: player is drowning,
         * `1`-`10`: remaining number of bubbles
-        * `11`: bubbles bar is not shown
+        * max (or 11): bubbles bar is not shown
+        * See Object Properties for more information
 * `set_attribute(attribute, value)`:
     * Sets an extra attribute with value on player.
     * `value` must be a string, or a number which will be converted to a string.
@@ -4023,6 +4024,9 @@ Definition tables
 
     {
         hp_max = 1,
+    --  ^ For players: Defaults to `minetest.PLAYER_MAX_HP_DEFAULT`
+        breath_max = 0,
+    --  ^ For players only. Defaults to `minetest.PLAYER_MAX_BREATH_DEFAULT`
         physical = true,
         collide_with_objects = true, -- collide with other objects if physical = true
         weight = 5,

src/constants.h

@@ -88,10 +88,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define PLAYER_INVENTORY_SIZE (8 * 4)
 
 // Maximum hit points of a player
-#define PLAYER_MAX_HP 20
+#define PLAYER_MAX_HP_DEFAULT 20
 
 // Maximal breath of a player
-#define PLAYER_MAX_BREATH 11
+#define PLAYER_MAX_BREATH_DEFAULT 11
 
 // Number of different files to try to save a player to if the first fails
 // (because of a case-insensitive filesystem)

src/content_sao.cpp

@@ -779,7 +779,7 @@ PlayerSAO::PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, u16 peer_id
 	m_wield_index(0),
 	m_position_not_sent(false),
 	m_is_singleplayer(is_singleplayer),
-	m_breath(PLAYER_MAX_BREATH),
+	m_breath(PLAYER_MAX_BREATH_DEFAULT),
 	m_pitch(0),
 	m_fov(0),
 	m_wanted_range(0),
@@ -795,7 +795,8 @@ PlayerSAO::PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, u16 peer_id
 {
 	assert(m_peer_id != 0);	// pre-condition
 
-	m_prop.hp_max = PLAYER_MAX_HP;
+	m_prop.hp_max = PLAYER_MAX_HP_DEFAULT;
+	m_prop.breath_max = PLAYER_MAX_BREATH_DEFAULT;
 	m_prop.physical = false;
 	m_prop.weight = 75;
 	m_prop.collisionbox = aabb3f(-0.3f, -1.0f, -0.3f, 0.3f, 0.75f, 0.3f);
@@ -811,7 +812,8 @@ PlayerSAO::PlayerSAO(ServerEnvironment *env_, RemotePlayer *player_, u16 peer_id
 	// end of default appearance
 	m_prop.is_visible = true;
 	m_prop.makes_footstep_sound = true;
-	m_hp = PLAYER_MAX_HP;
+	m_hp = m_prop.hp_max;
+	m_breath = m_prop.breath_max;
 }
 
 PlayerSAO::~PlayerSAO()
@@ -1248,8 +1250,8 @@ void PlayerSAO::setHP(s16 hp)
 
 	if (hp < 0)
 		hp = 0;
-	else if (hp > PLAYER_MAX_HP)
-		hp = PLAYER_MAX_HP;
+	else if (hp > m_prop.hp_max)
+		hp = m_prop.hp_max;
 
 	if (hp < oldhp && !g_settings->getBool("enable_damage")) {
 		return;
@@ -1270,7 +1272,7 @@ void PlayerSAO::setBreath(const u16 breath, bool send)
 	if (m_player && breath != m_breath)
 		m_player->setDirty(true);
 
-	m_breath = MYMIN(breath, PLAYER_MAX_BREATH);
+	m_breath = MYMIN(breath, m_prop.breath_max);
 
 	if (send)
 		m_env->getGameDef()->SendPlayerBreath(this);

src/localplayer.cpp

@@ -35,7 +35,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 LocalPlayer::LocalPlayer(Client *client, const char *name):
 	Player(name, client->idef()),
 	parent(NULL),
-	hp(PLAYER_MAX_HP),
+	hp(PLAYER_MAX_HP_DEFAULT),
 	isAttached(false),
 	touching_ground(false),
 	in_liquid(false),
@@ -76,7 +76,7 @@ LocalPlayer::LocalPlayer(Client *client, const char *name):
 	m_old_node_below(32767,32767,32767),
 	m_old_node_below_type("air"),
 	m_can_jump(false),
-	m_breath(PLAYER_MAX_BREATH),
+	m_breath(PLAYER_MAX_BREATH_DEFAULT),
 	m_yaw(0),
 	m_pitch(0),
 	camera_barely_in_ceiling(false),

src/object_properties.cpp

@@ -54,6 +54,7 @@ std::string ObjectProperties::dump()
 {
 	std::ostringstream os(std::ios::binary);
 	os<<"hp_max="<<hp_max;
+	os<<", breath_max="<<breath_max;
 	os<<", physical="<<physical;
 	os<<", collideWithObjects="<<collideWithObjects;
 	os<<", weight="<<weight;
@@ -118,6 +119,7 @@ void ObjectProperties::serialize(std::ostream &os) const
 	writeF1000(os, automatic_face_movement_max_rotation_per_sec);
 	os << serializeString(infotext);
 	os << serializeString(wield_item);
+	writeU16(os, breath_max);
 
 	// Add stuff only at the bottom.
 	// Never remove anything, because we don't want new versions of this
@@ -161,6 +163,7 @@ void ObjectProperties::deSerialize(std::istream &is)
 			automatic_face_movement_max_rotation_per_sec = readF1000(is);
 			infotext = deSerializeString(is);
 			wield_item = deSerializeString(is);
+			breath_max = readU16(is);
 		}catch(SerializationError &e){}
 	}
 	else

src/object_properties.h

@@ -30,6 +30,7 @@ struct ObjectProperties
 {
 	// Values are BS=1
 	s16 hp_max;
+	u16 breath_max;
 	bool physical;
 	bool collideWithObjects;
 	float weight;

src/remoteplayer.cpp

@@ -109,7 +109,7 @@ void RemotePlayer::deSerialize(std::istream &is, const std::string &playername,
 		try {
 			sao->setHPRaw(args.getS32("hp"));
 		} catch(SettingNotFoundException &e) {
-			sao->setHPRaw(PLAYER_MAX_HP);
+			sao->setHPRaw(PLAYER_MAX_HP_DEFAULT);
 		}
 
 		try {

src/script/common/c_content.cpp

@@ -183,8 +183,11 @@ void read_object_properties(lua_State *L, int index,
 	if(!lua_istable(L, index))
 		return;
 
-	prop->hp_max = getintfield_default(L, -1, "hp_max", 10);
+	int hp_max = 0;
+	if (getintfield(L, -1, "hp_max", hp_max))
+		prop->hp_max = (s16)rangelim(hp_max, 0, S16_MAX);
 
+	getintfield(L, -1, "breath_max", prop->breath_max);
 	getboolfield(L, -1, "physical", prop->physical);
 	getboolfield(L, -1, "collide_with_objects", prop->collideWithObjects);
 
@@ -286,6 +289,8 @@ void push_object_properties(lua_State *L, ObjectProperties *prop)
 	lua_newtable(L);
 	lua_pushnumber(L, prop->hp_max);
 	lua_setfield(L, -2, "hp_max");
+	lua_pushnumber(L, prop->breath_max);
+	lua_setfield(L, -2, "breath_max");
 	lua_pushboolean(L, prop->physical);
 	lua_setfield(L, -2, "physical");
 	lua_pushboolean(L, prop->collideWithObjects);

src/script/lua_api/l_object.cpp

@@ -750,6 +750,11 @@ int ObjectRef::l_set_properties(lua_State *L)
 	if (!prop)
 		return 0;
 	read_object_properties(L, 2, prop, getServer(L)->idef());
+	if (prop->hp_max < co->getHP()) {
+		co->setHP(prop->hp_max);
+		if (co->getType() == ACTIVEOBJECT_TYPE_PLAYER)
+			getServer(L)->SendPlayerHPOrDie((PlayerSAO *)co);
+	}
 	co->notifyObjectPropertiesModified();
 	return 0;
 }

src/server.cpp

@@ -2687,8 +2687,8 @@ void Server::RespawnPlayer(u16 peer_id)
 			<< playersao->getPlayer()->getName()
 			<< " respawns" << std::endl;
 
-	playersao->setHP(PLAYER_MAX_HP);
-	playersao->setBreath(PLAYER_MAX_BREATH);
+	playersao->setHP(playersao->accessObjectProperties()->hp_max);
+	playersao->setBreath(playersao->accessObjectProperties()->breath_max);
 
 	bool repositioned = m_script->on_respawnplayer(playersao);
 	if (!repositioned) {