Refactor snippets
Wuzzy
parent
125cb1ed89
commit
d6b8820ba2
7
API.md
7
API.md
|
|
@ -17,8 +17,11 @@ Once this mod had overwritten the `description` field of an item was overwritten
|
|||
|
||||
Register a custom snippet function.
|
||||
`func` is a function of the form `func(itemstring)`.
|
||||
It will be called for (nearly) every itemstring and it must return a string you want to append to this item or `nil` if nothing shall be appended.
|
||||
You can optionally return the text color in `"#RRGGBB"` format as the second return value.
|
||||
It will be called for (nearly) every itemstring.
|
||||
|
||||
Returns: Two values, the first one is required.
|
||||
1st return value: A string you want to append to this item or `nil` if nothing shall be appended.
|
||||
2nd return value: If nil, `tt` will take of the text color. If a ColorString in `"#RRGGBB"` format, entire text is colorized in this color. Return `false` to force `tt` to not apply text any colorization (useful if you want to call `minetest.colorize` yourself.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
|
|||
301
init.lua
301
init.lua
|
|
@ -73,149 +73,192 @@ local function get_min_digtime(caps)
|
|||
return mintime, unique
|
||||
end
|
||||
|
||||
tt.register_snippet = function(func)
|
||||
table.insert(tt.registered_snippets, func)
|
||||
end
|
||||
|
||||
--- CORE SNIPPETS ---
|
||||
|
||||
tt.register_snippet(function(itemstring)
|
||||
local def = minetest.registered_items[itemstring]
|
||||
-- Custom text
|
||||
if def._tt_help then
|
||||
return def._tt_help, false
|
||||
end
|
||||
end)
|
||||
|
||||
tt.register_snippet(function(itemstring)
|
||||
local def = minetest.registered_items[itemstring]
|
||||
local desc = ""
|
||||
-- Tool info
|
||||
if def.tool_capabilities then
|
||||
-- Digging times
|
||||
local digs = ""
|
||||
local d
|
||||
if def.tool_capabilities.groupcaps then
|
||||
for group, caps in pairs(def.tool_capabilities.groupcaps) do
|
||||
local mintime, unique_mintime
|
||||
if caps.times then
|
||||
mintime, unique_mintime = get_min_digtime(caps)
|
||||
if mintime and (mintime > 0 and (not unique_mintime)) then
|
||||
d = S("Digs @1 blocks", group) .. "\n"
|
||||
d = d .. S("Minimum dig time: @1s", string.format("%.2f", mintime))
|
||||
digs = digs .. "\n" .. d
|
||||
elseif mintime and mintime == 0 then
|
||||
d = S("Digs @1 blocks instantly", group)
|
||||
digs = digs .. "\n" .. d
|
||||
end
|
||||
end
|
||||
end
|
||||
if digs ~= "" then
|
||||
desc = desc .. minetest.colorize(COLOR_DEFAULT, digs)
|
||||
end
|
||||
end
|
||||
-- Weapon stats
|
||||
if def.tool_capabilities.damage_groups then
|
||||
for group, damage in pairs(def.tool_capabilities.damage_groups) do
|
||||
local msg
|
||||
if group == "fleshy" then
|
||||
if damage >= 0 then
|
||||
msg = S("Damage: @1", damage)
|
||||
else
|
||||
msg = S("Healing: @1", math.abs(damage))
|
||||
end
|
||||
else
|
||||
if damage >= 0 then
|
||||
msg = S("Damage (@1): @2", group, damage)
|
||||
else
|
||||
msg = S("Healing (@1): @2", group, math.abs(damage))
|
||||
end
|
||||
end
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, msg)
|
||||
end
|
||||
local full_punch_interval = def.tool_capabilities.full_punch_interval
|
||||
if not full_punch_interval then
|
||||
full_punch_interval = 1
|
||||
end
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Full punch interval: @1s", full_punch_interval))
|
||||
end
|
||||
end
|
||||
if desc == "" then
|
||||
desc = nil
|
||||
end
|
||||
return desc, false
|
||||
end)
|
||||
|
||||
tt.register_snippet(function(itemstring)
|
||||
local def = minetest.registered_items[itemstring]
|
||||
local desc
|
||||
-- Food
|
||||
if def._tt_food then
|
||||
desc = S("Food item")
|
||||
if def._tt_food_hp then
|
||||
local msg = S("+@1 food points", def._tt_food_hp)
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, msg)
|
||||
end
|
||||
-- NOTE: This is unused atm
|
||||
--[[if def._tt_food_satiation then
|
||||
if def._tt_food_satiation >= 0 then
|
||||
msg = S("+@1 satiation", def._tt_food_satiation)
|
||||
else
|
||||
msg = S("@1 satiation", def._tt_food_satiation)
|
||||
end
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, msg)
|
||||
end]]
|
||||
end
|
||||
return desc, false
|
||||
end)
|
||||
|
||||
tt.register_snippet(function(itemstring)
|
||||
local def = minetest.registered_items[itemstring]
|
||||
local desc = ""
|
||||
-- Node info
|
||||
if def.damage_per_second then
|
||||
if def.damage_per_second > 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DANGER, S("Contact damage: @1 per second", def.damage_per_second))
|
||||
elseif def.damage_per_second < 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_GOOD, S("Contact healing: @1 per second", math.abs(def.damage_per_second)))
|
||||
end
|
||||
end
|
||||
if def.drowning and def.drowning ~= 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DANGER, S("Drowning damage: @1", def.drowning))
|
||||
end
|
||||
local tmp = minetest.get_item_group(itemstring, "fall_damage_add_percent")
|
||||
if tmp > 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DANGER, S("Fall damage: +@1%", tmp))
|
||||
elseif tmp == -100 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_GOOD, S("No fall damage"))
|
||||
elseif tmp < 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Fall damage: @1%", tmp))
|
||||
end
|
||||
-- Movement-related node facts
|
||||
if minetest.get_item_group(itemstring, "disable_jump") == 1 and not def.climbable then
|
||||
if def.liquidtype == "none" then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("No jumping"))
|
||||
else
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("No swimming upwards"))
|
||||
end
|
||||
end
|
||||
if def.climbable then
|
||||
if minetest.get_item_group(itemstring, "disable_jump") == 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Climbable (only downwards)"))
|
||||
else
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Climbable"))
|
||||
end
|
||||
end
|
||||
if minetest.get_item_group(itemstring, "slippery") >= 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Slippery"))
|
||||
end
|
||||
local tmp = minetest.get_item_group(itemstring, "bouncy")
|
||||
if tmp >= 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Bouncy (@1%)", tmp))
|
||||
end
|
||||
-- Node appearance
|
||||
tmp = def.light_source
|
||||
if tmp and tmp >= 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Luminance: @1", tmp))
|
||||
end
|
||||
if desc == "" then
|
||||
desc = nil
|
||||
end
|
||||
return desc, false
|
||||
end)
|
||||
|
||||
|
||||
-- Apply item description update
|
||||
|
||||
local function append_descs()
|
||||
for itemstring, def in pairs(minetest.registered_items) do
|
||||
if itemstring ~= "" and itemstring ~= "air" and itemstring ~= "ignore" and itemstring ~= "unknown" and def ~= nil and def.description ~= nil and def.description ~= "" and def._tt_ignore ~= true then
|
||||
local desc = def.description
|
||||
local orig_desc = desc
|
||||
-- Custom text
|
||||
if def._tt_help then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, def._tt_help)
|
||||
end
|
||||
-- Tool info
|
||||
if def.tool_capabilities then
|
||||
-- Digging times
|
||||
local digs = ""
|
||||
local d
|
||||
if def.tool_capabilities.groupcaps then
|
||||
for group, caps in pairs(def.tool_capabilities.groupcaps) do
|
||||
local mintim, unique_mintime
|
||||
if caps.times then
|
||||
mintime, unique_mintime = get_min_digtime(caps)
|
||||
if mintime and (mintime > 0 and (not unique_mintime)) then
|
||||
d = S("Digs @1 blocks", group) .. "\n"
|
||||
d = d .. S("Minimum dig time: @1s", string.format("%.2f", mintime))
|
||||
digs = digs .. "\n" .. d
|
||||
elseif mintime and mintime == 0 then
|
||||
d = S("Digs @1 blocks instantly", group)
|
||||
digs = digs .. "\n" .. d
|
||||
end
|
||||
end
|
||||
end
|
||||
if digs ~= "" then
|
||||
desc = desc .. minetest.colorize(COLOR_DEFAULT, digs)
|
||||
end
|
||||
end
|
||||
-- Weapon stats
|
||||
if def.tool_capabilities.damage_groups then
|
||||
for group, damage in pairs(def.tool_capabilities.damage_groups) do
|
||||
local msg
|
||||
if group == "fleshy" then
|
||||
if damage >= 0 then
|
||||
msg = S("Damage: @1", damage)
|
||||
else
|
||||
msg = S("Healing: @1", math.abs(damage))
|
||||
end
|
||||
else
|
||||
if damage >= 0 then
|
||||
msg = S("Damage (@1): @2", group, damage)
|
||||
else
|
||||
msg = S("Healing (@1): @2", group, math.abs(damage))
|
||||
end
|
||||
end
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, msg)
|
||||
end
|
||||
local full_punch_interval = def.tool_capabilities.full_punch_interval
|
||||
if not full_punch_interval then
|
||||
full_punch_interval = 1
|
||||
end
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Full punch interval: @1s", full_punch_interval))
|
||||
end
|
||||
end
|
||||
-- Food
|
||||
if def._tt_food then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Food item"))
|
||||
if def._tt_food_hp then
|
||||
local msg = S("+@1 food points", def._tt_food_hp)
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, msg)
|
||||
end
|
||||
-- NOTE: This is unused atm
|
||||
--[[if def._tt_food_satiation then
|
||||
if def._tt_food_satiation >= 0 then
|
||||
msg = S("+@1 satiation", def._tt_food_satiation)
|
||||
else
|
||||
msg = S("@1 satiation", def._tt_food_satiation)
|
||||
end
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, msg)
|
||||
end]]
|
||||
end
|
||||
-- Node info
|
||||
-- Damage-related
|
||||
do
|
||||
if def.damage_per_second then
|
||||
if def.damage_per_second > 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DANGER, S("Contact damage: @1 per second", def.damage_per_second))
|
||||
elseif def.damage_per_second < 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_GOOD, S("Contact healing: @1 per second", math.abs(def.damage_per_second)))
|
||||
end
|
||||
end
|
||||
if def.drowning and def.drowning ~= 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DANGER, S("Drowning damage: @1", def.drowning))
|
||||
end
|
||||
local tmp = minetest.get_item_group(itemstring, "fall_damage_add_percent")
|
||||
if tmp > 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DANGER, S("Fall damage: +@1%", tmp))
|
||||
elseif tmp == -100 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_GOOD, S("No fall damage"))
|
||||
elseif tmp < 0 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Fall damage: @1%", tmp))
|
||||
end
|
||||
end
|
||||
-- Movement-related node facts
|
||||
if minetest.get_item_group(itemstring, "disable_jump") == 1 and not def.climbable then
|
||||
if def.liquidtype == "none" then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("No jumping"))
|
||||
else
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("No swimming upwards"))
|
||||
end
|
||||
end
|
||||
if def.climbable then
|
||||
if minetest.get_item_group(itemstring, "disable_jump") == 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Climbable (only downwards)"))
|
||||
else
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Climbable"))
|
||||
end
|
||||
end
|
||||
if minetest.get_item_group(itemstring, "slippery") >= 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Slippery"))
|
||||
end
|
||||
local tmp = minetest.get_item_group(itemstring, "bouncy")
|
||||
if tmp >= 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Bouncy (@1%)", tmp))
|
||||
end
|
||||
-- Node appearance
|
||||
tmp = def.light_source
|
||||
if tmp and tmp >= 1 then
|
||||
desc = desc .. "\n" .. minetest.colorize(COLOR_DEFAULT, S("Luminance: @1", tmp))
|
||||
end
|
||||
-- Custom functions
|
||||
local first = true
|
||||
-- Apply snippets
|
||||
for s=1, #tt.registered_snippets do
|
||||
local str, snippet_color = tt.registered_snippets[s](itemstring)
|
||||
if not snippet_color then
|
||||
if snippet_color == nil then
|
||||
snippet_color = COLOR_DEFAULT
|
||||
elseif snippet_color == false then
|
||||
snipped_color = false
|
||||
end
|
||||
if str then
|
||||
desc = desc .. "\n" .. minetest.colorize(snippet_color, str)
|
||||
if first then
|
||||
first = false
|
||||
else
|
||||
desc = desc .. "\n"
|
||||
end
|
||||
if snippet_color == false then
|
||||
desc = desc .. minetest.colorize(snippet_color, str)
|
||||
else
|
||||
desc = desc .. str
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
minetest.override_item(itemstring, { description = desc, _tt_original_description = orig_desc })
|
||||
if desc ~= def.description then
|
||||
minetest.override_item(itemstring, { description = desc, _tt_original_description = orig_desc })
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
tt.register_snippet = function(func)
|
||||
table.insert(tt.registered_snippets, func)
|
||||
end
|
||||
|
||||
minetest.register_on_mods_loaded(append_descs)
|
||||
|
|
|
|||
Loading…
Reference in New Issue