Add mod: show_wielded_item

This commit is contained in:
Wuzzy 2017-07-02 19:34:09 +02:00
parent b7abcabf2f
commit 7a29d8580d
7 changed files with 135 additions and 0 deletions

View File

@ -0,0 +1,19 @@
# Show Wielded Item [`show_wielded_item`]
This Minetest mod displays the name of the wielded item above the hotbar and
statbars.
This mod is compatible with the HUD Bars [`hudbars`] mod.
Compability with other HUD-related mods is possible, but not guaranteed.
Version: 1.0.0
## Credits
Released by Wuzzy.
The original mod code was taken from the file “`item_names.lua`”
found in the Unified Inventory mod maintained by VanessaE. This code
has been later modified.
Original author: 4aiman
## License
This mod is licensed under GNU LGPLv2 or later
(see <https://www.gnu.org/licenses/lgpl-2.1.html>).

View File

@ -0,0 +1 @@
hudbars?

View File

@ -0,0 +1 @@
Displays the name of the wielded item.

View File

@ -0,0 +1,108 @@
-- Based on 4itemnames mod by 4aiman
local wield = {}
local wieldindex = {}
local huds = {}
local dtimes = {}
local dlimit = 3 -- HUD element will be hidden after this many seconds
local hudbars_mod = minetest.get_modpath("hudbars")
local function set_hud(player)
if not player:is_player() then return end
local player_name = player:get_player_name()
-- Fixed offset in config file
local fixed = tonumber(minetest.settings:get("show_wielded_item_y_offset"))
local off
if fixed and fixed ~= -1 then
-- Manual offset
off = {x=0, y=-fixed}
else
-- Default offset
off = {x=0, y=-101}
if hudbars_mod then
-- Tweak offset if hudbars mod was found
local rows = math.floor((#hb.get_hudbar_identifiers()-1) / 2) + 1
local vmargin = tonumber(minetest.settings:get("hudbars_vmargin")) or 24
off.y = -76 - vmargin*rows
end
-- Dirty trick to avoid collision with Minetest's status text (e.g. “Volume changed to 0%”)
if off.y >= -167 and off.y <= -156 then
off.y = -181
end
end
huds[player_name] = player:hud_add({
hud_elem_type = "text",
position = {x=0.5, y=1},
offset = off,
alignment = {x=0, y=0},
number = 0xFFFFFF ,
text = "",
})
end
minetest.register_on_joinplayer(function(player)
set_hud(player)
local name = player:get_player_name()
wield[name] = player:get_wielded_item():get_name()
wieldindex[name] = player:get_wield_index()
end)
minetest.register_on_leaveplayer(function(player)
local name = player:get_player_name()
wield[name] = nil
wieldindex[name] = nil
end)
minetest.register_globalstep(function(dtime)
for _, player in pairs(minetest.get_connected_players()) do
local player_name = player:get_player_name()
local wstack = player:get_wielded_item()
local wname = wstack:get_name()
local windex = player:get_wield_index()
if dtimes[player_name] and dtimes[player_name] < dlimit then
dtimes[player_name] = dtimes[player_name] + dtime
if dtimes[player_name] > dlimit and huds[player_name] then
player:hud_change(huds[player_name], 'text', "")
end
end
-- Update HUD when wielded item or wielded index changed
if wname ~= wield[player_name] or windex ~= wieldindex[player_name] then
wieldindex[player_name] = windex
wield[player_name] = wname
dtimes[player_name] = 0
if huds[player_name] then
local def = minetest.registered_items[wname]
local meta = wstack:get_meta()
--[[ Get description. Order of preference:
* description from metadata
* description from item definition
* itemstring ]]
local desc = meta:get_string("description")
if (desc == nil or desc == "") and def then
desc = def.description
end
if desc == nil or desc == "" then
desc = wname
end
-- Cut off item description after first newline
local firstnewline = string.find(desc, "\n")
if firstnewline then
desc = string.sub(desc, 1, firstnewline-1)
end
player:hud_change(huds[player_name], 'text', desc)
end
end
end
end)

View File

@ -0,0 +1 @@
name = show_wielded_item

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -0,0 +1,5 @@
#Use this setting to manually set the vertical offset of the label which shows
#the name of the wielded item. The offset is in pixels from the bottom of the
#screen.
#Set this to -1 to let the mod guess the offset automatically (recommended).
show_wielded_item_y_offset (Vertical offset of wielded item name display) int -1 -1