Merge pull request 'Title HUD API' (#1778) from title-API into master

Reviewed-on: MineClone2/MineClone2#1778

mods/ENTITIES/mcl_boats/init.lua

@@ -84,7 +84,7 @@ local function attach_object(self, obj)
 			end
 		end, name)
 		obj:set_look_horizontal(yaw)
-		mcl_tmp_message.message(obj, S("Sneak to dismount"))
+		mcl_title.set(obj, "actionbar", {text=S("Sneak to dismount"), color="white", stay=60})
 	else
 		obj:get_luaentity()._old_visual_size = visual_size
 	end

mods/ENTITIES/mcl_boats/mod.conf

@@ -1,7 +1,7 @@
 name = mcl_boats
 author = PilzAdam
 description = Adds drivable boats.
-depends = mcl_player, flowlib
+depends = mcl_player, flowlib, mcl_title
 optional_depends = mcl_core, doc_identifier
 
 

mods/ENTITIES/mcl_minecarts/init.lua

@@ -646,7 +646,7 @@ register_minecart(
 				if player then
 					mcl_player.player_set_animation(player, "sit" , 30)
 					player:set_eye_offset({x=0, y=-5.5, z=0},{x=0, y=-4, z=0})
-					mcl_tmp_message.message(clicker, S("Sneak to dismount"))
+					mcl_title.set(clicker, "actionbar", {text=S("Sneak to dismount"), color="white", stay=60})
 				end
 			end, name)
 		end

mods/ENTITIES/mcl_minecarts/mod.conf

@@ -1,6 +1,6 @@
 name = mcl_minecarts
 author = Krock
 description = Minecarts are vehicles to move players quickly on rails.
-depends = mcl_explosions, mcl_core, mcl_sounds, mcl_player, mcl_achievements, mcl_chests, mcl_furnaces, mesecons_commandblock, mcl_hoppers, mcl_tnt, mesecons
+depends = mcl_title, mcl_explosions, mcl_core, mcl_sounds, mcl_player, mcl_achievements, mcl_chests, mcl_furnaces, mesecons_commandblock, mcl_hoppers, mcl_tnt, mesecons
 optional_depends = doc_identifier, mcl_wip
 

mods/HUD/mcl_title/API.md

@@ -0,0 +1,50 @@
+# mcl_title
+
+Allow mods to show messages in the hud of players.
+
+## mcl_title.set(player, type, data)
+
+Show a hud message of `type` to player `player` with `data` as params.
+
+The element will stay for the per-player param `stay` or `data.stay` (in gametick which is 1/20 second).
+
+Here is a usage exemple:
+
+```lua
+--show a title in the HUD with minecraft color "gold" 
+mcl_title.set(player, "title", {text="dummy text", color="gold"})
+
+--show a subtitle in the HUD with hex color "#612D2D" 
+mcl_title.set(player, "subtitle", {text="dummy subtitle", color="#612D2D"})
+
+--show an actionbar in the HUD (above the hotbar) with minecraft color "red"
+mcl_title.set(player, "subtitle", {text="dummy actionbar", color="red"})
+
+--show a title in the HUD with minecraft color "gold" staying for 3 seconds (override stay setting)
+mcl_title.set(player, "title", {text="dummy text", color="gold", stay=3})
+```
+
+## mcl_title.remove(player, type)
+
+Hide HUD element of type `type` for player `player`.
+
+## mcl_title.clear(player)
+
+Remove every title/subtitle/actionbar from a player.
+Basicaly run `mcl_title.remove(player, type)` for every type.
+
+## mcl_title.params_set(player, params)
+
+Allow mods to set `stay` and upcomming `fadeIn`/`fadeOut` params.
+
+```lua
+mcl_title.params_set(player, {stay = 600}) --elements with no 'data.stay' field will stay during 30s (600/20)
+```
+
+## mcl_title.params_get(player)
+
+Get `stay` and upcomming `fadeIn` and `fadeOut` params of a player as a table.
+
+```lua
+mcl_title.params_get(player)
+```

mods/HUD/mcl_title/init.lua

@@ -0,0 +1,236 @@
+--Based on:
+--https://www.digminecraft.com/game_commands/title_command.php
+--https://youtu.be/oVrtQRO2hpY
+
+--TODO: use SSCSM to reduce lag and network trafic (just send modchannel messages)
+--TODO: fadeIn and fadeOut animation (needs engine change: SSCSM or native support)
+--TODO: allow obfuscating text (needs engine change: SSCSM or native support)
+--TODO: allow colorizing and styling of part of the text (NEEDS ENGINE CHANGE!!!)
+--TODO: exactly mc like layout
+
+--Note that the table storing timeouts use playername as index insteed of player objects (faster)
+--This is intended in order to speedup the process of removing HUD elements the the timeout is up
+
+local huds_idx = {}
+
+local hud_hide_timeouts = {}
+
+hud_hide_timeouts.title = {}
+hud_hide_timeouts.subtitle = {}
+hud_hide_timeouts.actionbar = {}
+
+huds_idx.title = {}
+huds_idx.subtitle = {}
+huds_idx.actionbar = {}
+
+mcl_title = {}
+mcl_title.defaults = {fadein = 10, stay = 70, fadeout = 20}
+mcl_title.layout = {}
+mcl_title.layout.title = {position = {x = 0.5, y = 0.5}, alignment = {x = 0, y = -1.3}, size = 7}
+mcl_title.layout.subtitle = {position = {x = 0.5, y = 0.5}, alignment = {x = 0, y = 1.7}, size = 4}
+mcl_title.layout.actionbar = {position = {x = 0.5, y = 1}, alignment = {x = 0, y = 0}, size = 1}
+
+local get_color = mcl_util.get_color
+
+--local string = string
+local pairs = pairs
+
+local function gametick_to_secondes(gametick)
+	if gametick then
+		return gametick / 20
+	else
+		return nil
+	end
+end
+
+--https://github.com/minetest/minetest/blob/b3b075ea02034306256b486dd45410aa765f035a/doc/lua_api.txt#L8477
+--[[
+local function style_to_bits(bold, italic)
+	if bold then
+		if italic then
+			return 3
+		else
+			return 1
+		end
+	else
+		if italic then
+			return 2
+		else
+			return 0
+		end
+	end
+end
+]]
+
+--PARAMS SYSTEM
+local player_params = {}
+
+minetest.register_on_joinplayer(function(player)
+	--local playername = player:get_player_name()
+	player_params[player] = {
+		stay = mcl_title.defaults.stay,
+		--fadeIn = mcl_title.defaults.fadein,
+		--fadeOut = mcl_title.defaults.fadeout,
+	}
+	local _, hex_color = get_color("white")
+	huds_idx.title[player] = player:hud_add({
+		hud_elem_type = "text",
+		position  = mcl_title.layout.title.position,
+		alignment = mcl_title.layout.title.alignment,
+		text      = "",
+		--style = 0,
+		size      = {x = mcl_title.layout.title.size},
+		number    = hex_color,
+		z_index   = 100,
+	})
+	huds_idx.subtitle[player] = player:hud_add({
+		hud_elem_type = "text",
+		position  = mcl_title.layout.subtitle.position,
+		alignment = mcl_title.layout.subtitle.alignment,
+		text      = "",
+		--style = 0,
+		size      = {x = mcl_title.layout.subtitle.size},
+		number    = hex_color,
+		z_index   = 100,
+	})
+	huds_idx.actionbar[player] = player:hud_add({
+		hud_elem_type = "text",
+		position  = mcl_title.layout.actionbar.position,
+		offset    = {x = 0, y = -210},
+		alignment = mcl_title.layout.actionbar.alignment,
+		--style = 0,
+		text      = "",
+		size      = {x = mcl_title.layout.actionbar.size},
+		number    = hex_color,
+		z_index   = 100,
+	})
+end)
+
+minetest.register_on_leaveplayer(function(player)
+	local playername = player:get_player_name()
+
+	--remove player params from the list
+	player_params[player] = nil
+
+	--remove HUD idx from the list (HUD elements are removed by the engine)
+	huds_idx.title[player] = nil
+	huds_idx.subtitle[player] = nil
+	huds_idx.actionbar[player] = nil
+
+	--remove timers from list
+	hud_hide_timeouts.title[playername] = nil
+	hud_hide_timeouts.subtitle[playername] = nil
+	hud_hide_timeouts.actionbar[playername] = nil
+end)
+
+function mcl_title.params_set(player, data)
+	player_params[player] = {
+		stay = data.stay or mcl_title.defaults.stay,
+		--fadeIn = data.fadeIn or mcl_title.defaults.fadein,
+		--fadeOut = data.fadeOut or mcl_title.defaults.fadeout,
+	}
+end
+
+function mcl_title.params_get(player)
+	return player_params[player]
+end
+
+--API FUNCTIONS
+
+function mcl_title.set(player, type, data)
+	if not data.color then
+		data.color = "white"
+	end
+	local _, hex_color = get_color(data.color)
+	if not hex_color then
+		return false
+	end
+
+	player:hud_change(huds_idx[type][player], "text", data.text)
+	player:hud_change(huds_idx[type][player], "number", hex_color)
+
+	--apply bold and italic
+	--player:hud_change(huds_idx[type][player], "style", style_to_bits(data.bold, data.italic))
+
+	hud_hide_timeouts[type][player:get_player_name()] = gametick_to_secondes(data.stay) or gametick_to_secondes(mcl_title.params_get(player).stay)
+	return true
+end
+
+function mcl_title.remove(player, type)
+	if player then
+		player:hud_change(huds_idx[type][player], "text", "")
+		--player:hud_change(huds_idx[type][player], "style", 0) --no styling
+	end
+end
+
+function mcl_title.clear(player)
+	mcl_title.remove(player, "title")
+	mcl_title.remove(player, "subtitle")
+	mcl_title.remove(player, "actionbar")
+end
+
+minetest.register_on_dieplayer(function(player)
+	mcl_title.clear(player)
+end)
+
+minetest.register_globalstep(function(dtime)
+	local new_timeouts = {
+		title = {},
+		subtitle = {},
+		actionbar = {},
+	}
+	for element, content in pairs(hud_hide_timeouts) do
+		for name, timeout in pairs(content) do
+			timeout = timeout - dtime
+			if timeout <= 0 then
+				local player = minetest.get_player_by_name(name)
+				mcl_title.remove(player, element)
+			else
+				new_timeouts[element][name] = timeout
+			end
+		end
+	end
+	hud_hide_timeouts = new_timeouts
+end)
+
+
+--DEBUG STUFF!!
+--[[
+minetest.register_chatcommand("title", {
+	func = function(name, param)
+		local player = minetest.get_player_by_name(name)
+		mcl_title.set(player, "title", {text=param, color="gold", bold=true, italic=true})
+	end,
+})
+
+minetest.register_chatcommand("subtitle", {
+	func = function(name, param)
+		local player = minetest.get_player_by_name(name)
+		mcl_title.set(player, "subtitle", {text=param, color="gold"})
+	end,
+})
+
+minetest.register_chatcommand("actionbar", {
+	func = function(name, param)
+		local player = minetest.get_player_by_name(name)
+		mcl_title.set(player, "actionbar", {text=param, color="gold"})
+	end,
+})
+
+minetest.register_chatcommand("timeout", {
+	func = function(name, param)
+		local player = minetest.get_player_by_name(name)
+		mcl_title.params_set(player, {stay = 600})
+	end,
+})
+
+minetest.register_chatcommand("all", {
+	func = function(name, param)
+		local player = minetest.get_player_by_name(name)
+		mcl_title.params_set(player, {stay = 600})
+		mcl_title.set(player, "title", {text=param, color="gold"})
+		mcl_title.set(player, "subtitle", {text=param, color="gold"})
+		mcl_title.set(player, "actionbar", {text=param, color="gold"})
+	end,
+})
+]]

mods/HUD/mcl_title/mod.conf

@@ -0,0 +1,4 @@
+name = mcl_title
+description = Add an API to add in HUD title 
+depends = mcl_colors
+author = AFCMS

mods/HUD/mcl_tmp_message/API.md

@@ -1,7 +0,0 @@
-# mcl_temp_message
-
-Allow mods to show short messages in the hud of players.
-
-## mcl_tmp_message.message(player, message)
-
-Show above the hotbar a hud message <message> to player <player>.

mods/HUD/mcl_tmp_message/init.lua

@@ -1,44 +0,0 @@
-mcl_tmp_message = {}
-
-local huds = {}
-local hud_hide_timeouts = {}
-
-function mcl_tmp_message.message(player, message)
-	local name = player:get_player_name()
-	player:hud_change(huds[name], "text", message)
-	hud_hide_timeouts[name] = 3
-end
-
-minetest.register_on_joinplayer(function(player)
-	huds[player:get_player_name()] = player:hud_add({
-		hud_elem_type = "text",
-		position = {x=0.5, y=1},
-		offset = {x = 0, y = -210},
-		alignment = {x=0, y=0},
-		number = 0xFFFFFF ,
-		text = "",
-		z_index = 100,
-	})
-end)
-
-minetest.register_on_leaveplayer(function(player)
-	local name = player:get_player_name()
-	huds[name] = nil
-	hud_hide_timeouts[name] = nil
-end)
-
-minetest.register_globalstep(function(dtime)
-	local new_timeouts = {}
-	for name, timeout in pairs(hud_hide_timeouts) do
-		timeout = timeout - dtime
-		if timeout <= 0 then
-			local player = minetest.get_player_by_name(name)
-			if player then
-				player:hud_change(huds[name], "text", "")
-			end
-		else
-			new_timeouts[name] = timeout
-		end
-	end
-	hud_hide_timeouts = new_timeouts
-end)

mods/HUD/mcl_tmp_message/mod.conf

@@ -1,3 +0,0 @@
-name = mcl_tmp_message
-author = Fleckenstein
-description = A simple API to show a temporary message to a player 

mods/ITEMS/mcl_beds/functions.lua

@@ -330,7 +330,7 @@ function mcl_beds.on_rightclick(pos, player, is_top)
 			message = select(2, lay_down(player, ppos, other))
 		end
 		if message then
-			mcl_tmp_message.message(player, message)
+			mcl_title.set(player, "actionbar", {text=message, color="white", stay=60})
 		end
 	else
 		lay_down(player, nil, nil, false)