finish `mcl_title` API + doc

This commit is contained in:
AFCMS 2021-08-19 19:21:33 +02:00
parent 40898d3e9d
commit df4b8e64cc
5 changed files with 23 additions and 67 deletions

View File

@ -40,3 +40,11 @@ Allow mods to set `stay` and upcomming `fadeIn`/`fadeOut` params.
```lua ```lua
mcl_title.params_set(player, {stay = 600}) --elements with no 'data.stay' field will stay during 30s (600/20) 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)
```

View File

@ -32,7 +32,7 @@ mcl_title.layout.actionbar = {position = {x = 0.5, y = 1}, alignment = {x = 0, y
local get_color = mcl_util.get_color local get_color = mcl_util.get_color
local string = string --local string = string
local pairs = pairs local pairs = pairs
local function gametick_to_secondes(gametick) local function gametick_to_secondes(gametick)
@ -44,7 +44,7 @@ local function gametick_to_secondes(gametick)
end end
--https://github.com/minetest/minetest/blob/b3b075ea02034306256b486dd45410aa765f035a/doc/lua_api.txt#L8477 --https://github.com/minetest/minetest/blob/b3b075ea02034306256b486dd45410aa765f035a/doc/lua_api.txt#L8477
--[[
local function style_to_bits(bold, italic) local function style_to_bits(bold, italic)
if bold then if bold then
if italic then if italic then
@ -60,12 +60,13 @@ local function style_to_bits(bold, italic)
end end
end end
end end
]]
--PARAMS SYSTEM --PARAMS SYSTEM
local player_params = {} local player_params = {}
minetest.register_on_joinplayer(function(player) minetest.register_on_joinplayer(function(player)
local playername = player:get_player_name() --local playername = player:get_player_name()
player_params[player] = { player_params[player] = {
stay = mcl_title.defaults.stay, stay = mcl_title.defaults.stay,
--fadeIn = mcl_title.defaults.fadein, --fadeIn = mcl_title.defaults.fadein,
@ -77,7 +78,7 @@ minetest.register_on_joinplayer(function(player)
position = mcl_title.layout.title.position, position = mcl_title.layout.title.position,
alignment = mcl_title.layout.title.alignment, alignment = mcl_title.layout.title.alignment,
text = "", text = "",
style = 0, --style = 0,
size = {x = mcl_title.layout.title.size}, size = {x = mcl_title.layout.title.size},
number = hex_color, number = hex_color,
z_index = 100, z_index = 100,
@ -87,7 +88,7 @@ minetest.register_on_joinplayer(function(player)
position = mcl_title.layout.subtitle.position, position = mcl_title.layout.subtitle.position,
alignment = mcl_title.layout.subtitle.alignment, alignment = mcl_title.layout.subtitle.alignment,
text = "", text = "",
style = 0, --style = 0,
size = {x = mcl_title.layout.subtitle.size}, size = {x = mcl_title.layout.subtitle.size},
number = hex_color, number = hex_color,
z_index = 100, z_index = 100,
@ -97,7 +98,7 @@ minetest.register_on_joinplayer(function(player)
position = mcl_title.layout.actionbar.position, position = mcl_title.layout.actionbar.position,
offset = {x = 0, y = -210}, offset = {x = 0, y = -210},
alignment = mcl_title.layout.actionbar.alignment, alignment = mcl_title.layout.actionbar.alignment,
style = 0, --style = 0,
text = "", text = "",
size = {x = mcl_title.layout.actionbar.size}, size = {x = mcl_title.layout.actionbar.size},
number = hex_color, number = hex_color,
@ -116,7 +117,7 @@ minetest.register_on_leaveplayer(function(player)
huds_idx.subtitle[player] = nil huds_idx.subtitle[player] = nil
huds_idx.actionbar[player] = nil huds_idx.actionbar[player] = nil
--remove timers form list --remove timers from list
hud_hide_timeouts.title[playername] = nil hud_hide_timeouts.title[playername] = nil
hud_hide_timeouts.subtitle[playername] = nil hud_hide_timeouts.subtitle[playername] = nil
hud_hide_timeouts.actionbar[playername] = nil hud_hide_timeouts.actionbar[playername] = nil
@ -149,7 +150,7 @@ function mcl_title.set(player, type, data)
player:hud_change(huds_idx[type][player], "number", hex_color) player:hud_change(huds_idx[type][player], "number", hex_color)
--apply bold and italic --apply bold and italic
player:hud_change(huds_idx[type][player], "style", style_to_bits(data.bold, data.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) 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 return true
@ -158,7 +159,7 @@ end
function mcl_title.remove(player, type) function mcl_title.remove(player, type)
if player then if player then
player:hud_change(huds_idx[type][player], "text", "") player:hud_change(huds_idx[type][player], "text", "")
player:hud_change(huds_idx[type][player], "style", 0) --no styling --player:hud_change(huds_idx[type][player], "style", 0) --no styling
end end
end end
@ -193,8 +194,8 @@ minetest.register_globalstep(function(dtime)
end) end)
--TEMP STUFF!! --DEBUG STUFF!!
--TODO: remove then testing/tweaking done --[[
minetest.register_chatcommand("title", { minetest.register_chatcommand("title", {
func = function(name, param) func = function(name, param)
local player = minetest.get_player_by_name(name) local player = minetest.get_player_by_name(name)
@ -232,3 +233,4 @@ minetest.register_chatcommand("all", {
mcl_title.set(player, "actionbar", {text=param, color="gold"}) mcl_title.set(player, "actionbar", {text=param, color="gold"})
end, end,
}) })
]]

View File

@ -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>.

View File

@ -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)

View File

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