Mirrorlandia_minetest/craftguide
1
0
Fork 0
mirror of https://github.com/minetest-mods/craftguide.git synced 2024-11-29 22:03:42 +01:00
Code Issues Projects Releases Wiki Activity

Code clean-up

Browse Source
This commit is contained in:
JPG 2017-03-21 14:26:58 +01:00
parent ee3984da77
commit 86a96c31ad
2 changed files with 99 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.luacheckrc
View File

@ -4,4 +4,5 @@ allow_defined_top = true
read_globals = { read_globals = {
"minetest", "minetest",
"default", "default",
"sfinv_buttons",
} }

199
init.lua
View File

@ -24,7 +24,7 @@ function craftguide:group_to_item(item)
local itemsub = item:sub(7) local itemsub = item:sub(7)
if group_stereotypes[itemsub] then if group_stereotypes[itemsub] then
item = group_stereotypes[itemsub] item = group_stereotypes[itemsub]
elseif reg_items["default:"..itemsub] then elseif reg_items["default:" .. itemsub] then
item = item:gsub("group:", "default:") item = item:gsub("group:", "default:")
else else
for name, def in pairs(reg_items) do for name, def in pairs(reg_items) do
@ -48,11 +48,11 @@ local function colorize(str)
end end
local function get_fueltime(item) local function get_fueltime(item)
return get_result({method="fuel", width=1, items={item}}).time return get_result({method = "fuel", width = 1, items = {item}}).time
end end
function craftguide:get_tooltip(item, recipe_type, cooktime, groups) function craftguide:get_tooltip(item, recipe_type, cooktime, groups)
local tooltip, item_desc = "tooltip["..item..";", "" local tooltip, item_desc = "tooltip[" .. item .. ";", ""
local fueltime = get_fueltime(item) local fueltime = get_fueltime(item)
local has_extras = groups or recipe_type == "cooking" or fueltime > 0 local has_extras = groups or recipe_type == "cooking" or fueltime > 0
@ -61,49 +61,47 @@ function craftguide:get_tooltip(item, recipe_type, cooktime, groups)
item_desc = reg_items[item].description item_desc = reg_items[item].description
end end
else else
return tooltip.."Unknown Item ("..item..")]" return tooltip .. "Unknown Item (" .. item .. ")]"
end end
if groups then if groups then
local groupstr = "Any item belonging to the " local groupstr = "Any item belonging to the "
for i=1, #groups do for i=1, #groups do
groupstr = groupstr..colorize(groups[i]).. groupstr = groupstr .. colorize(groups[i]) ..
(groups[i+1] and " and " or "") (groups[i + 1] and " and " or "")
end end
tooltip = tooltip..groupstr.." group(s)" tooltip = tooltip .. groupstr .. " group(s)"
end
if recipe_type == "cooking" then
tooltip = tooltip..item_desc.."\nCooking time: "..
colorize(cooktime)
end
if fueltime > 0 then
tooltip = tooltip..item_desc.."\nBurning time: "..
colorize(fueltime)
end end
return has_extras and tooltip.."]" or "" if recipe_type == "cooking" then
tooltip = tooltip .. item_desc .. "\nCooking time: " .. colorize(cooktime)
end
if fueltime > 0 then
tooltip = tooltip .. item_desc .. "\nBurning time: " .. colorize(fueltime)
end
return has_extras and tooltip .. "]" or ""
end end
function craftguide:get_recipe(iY, xoffset, tooltip, item, recipe_num, recipes) function craftguide:get_recipe(iY, xoffset, tooltip, item, recipe_num, recipes)
local formspec, recipes_total = "", #recipes local formspec, recipes_total = "", #recipes
if recipes_total > 1 then if recipes_total > 1 then
formspec = formspec.. formspec = formspec ..
"button[0,"..(iY+3)..";2,1;alternate;Alternate]".. "button[0," .. (iY + 3) .. ";2,1;alternate;Alternate]" ..
"label[0,"..(iY+2)..".5;Recipe ".. "label[0," .. (iY + 2) .. ".5;Recipe " ..
recipe_num.." of "..recipes_total.."]" recipe_num .. " of " .. recipes_total .. "]"
end end
local recipe_type = recipes[recipe_num].type local recipe_type = recipes[recipe_num].type
local items = recipes[recipe_num].items local items = recipes[recipe_num].items
local width = recipes[recipe_num].width local width = recipes[recipe_num].width
if recipe_type == "cooking" then if recipe_type == "cooking" or (recipe_type == "normal" and width == 0) then
formspec = formspec.. local icon = recipe_type == "cooking" and "furnace" or "shapeless"
"image["..(xoffset-0.8)..","..(iY+1).. formspec = formspec ..
".5;0.5,0.5;craftguide_furnace.png]" "image[" .. (xoffset - 0.8) .. "," .. (iY + 1) ..
-- Shapeless recipe ".5;0.5,0.5;craftguide_" .. icon .. ".png]"
elseif recipe_type == "normal" and width == 0 then
formspec = formspec..
"image["..(xoffset-0.8)..","..(iY+1)..
".5;0.5,0.5;craftguide_shapeless.png]"
end end
if width == 0 then width = min(3, #items) end if width == 0 then width = min(3, #items) end
@ -112,41 +110,38 @@ function craftguide:get_recipe(iY, xoffset, tooltip, item, recipe_num, recipes)
if recipe_type == "normal" and if recipe_type == "normal" and
width > craftgrid_limit or rows > craftgrid_limit then width > craftgrid_limit or rows > craftgrid_limit then
formspec = formspec.. formspec = formspec ..
"label["..xoffset..","..(iY+2).. "label[" .. xoffset .. "," .. (iY + 2) ..
";Recipe is too big to\nbe displayed (".. ";Recipe is too big to\nbe displayed (" ..
width.."x"..rows..")]" width .. "x" .. rows .. ")]"
else else
for i, v in pairs(items) do for i, v in pairs(items) do
local X = (i-1) % width + xoffset local X = (i - 1) % width + xoffset
local Y = ceil(i / width + iY+2 - min(2, rows)) local Y = ceil(i / width + (iY + 2) - min(2, rows))
if recipe_type == "normal" and if recipe_type == "normal" and width > 3 or rows > 3 then
width > 3 or rows > 3 then
btn_size = width > 3 and 3 / width or 3 / rows btn_size = width > 3 and 3 / width or 3 / rows
X = btn_size * (i % width) + xoffset X = btn_size * (i % width) + xoffset
Y = btn_size * floor((i-1) / width) + iY+3 - Y = btn_size * floor((i - 1) / width) + (iY + 3) - min(2, rows)
min(2, rows)
end end
local groups = extract_groups(v) local groups = extract_groups(v)
local label = groups and "\nG" or "" local label = groups and "\nG" or ""
local item_r = self:group_to_item(v) local item_r = self:group_to_item(v)
local tltip = self:get_tooltip( local tltip = self:get_tooltip(item_r, recipe_type, width, groups)
item_r, recipe_type, width, groups)
formspec = formspec.. formspec = formspec ..
"item_image_button["..X..","..Y..";".. "item_image_button[" .. X .. "," .. Y .. ";" ..
btn_size..","..btn_size..";"..item_r.. btn_size .. "," .. btn_size .. ";" .. item_r ..
";"..item_r..";"..label.."]"..tltip ";" .. item_r .. ";" .. label .. "]" .. tltip
end end
end end
local output = recipes[recipe_num].output local output = recipes[recipe_num].output
return formspec.. return formspec ..
"image["..(xoffset-1)..","..(iY+2).. "image[" .. (xoffset - 1) .. "," .. (iY + 2) ..
".12;0.9,0.7;craftguide_arrow.png]".. ".12;0.9,0.7;craftguide_arrow.png]" ..
"item_image_button["..(xoffset-2)..","..(iY+2)..";1,1;".. "item_image_button[" .. (xoffset - 2) .. "," .. (iY + 2) .. ";1,1;" ..
output..";"..item..";]"..tooltip output .. ";" .. item .. ";]" .. tooltip
end end
function craftguide:get_formspec(player_name, is_fuel) function craftguide:get_formspec(player_name, is_fuel)
@ -159,7 +154,7 @@ function craftguide:get_formspec(player_name, is_fuel)
end end
data.pagemax = max(1, ceil(#data.items / ipp)) data.pagemax = max(1, ceil(#data.items / ipp))
local formspec = "size["..data.iX..","..(iY+3)..".6;]"..[[ local formspec = "size[" .. data.iX .. "," .. (iY + 3) .. ".6;]" .. [[
background[1,1;1,1;craftguide_bg.png;true] background[1,1;1,1;craftguide_bg.png;true]
button[2.4,0.21;0.8,0.5;search;?] button[2.4,0.21;0.8,0.5;search;?]
button[3.05,0.21;0.8,0.5;clear;X] button[3.05,0.21;0.8,0.5;clear;X]
@ -167,52 +162,50 @@ function craftguide:get_formspec(player_name, is_fuel)
tooltip[clear;Reset] tooltip[clear;Reset]
tooltip[size_inc;Increase window size] tooltip[size_inc;Increase window size]
tooltip[size_dec;Decrease window size] tooltip[size_dec;Decrease window size]
field_close_on_enter[filter;false] ]].. field_close_on_enter[filter;false] ]] ..
"button["..(data.iX/2)..",-0.02;0.7,1;size_inc;+]".. "button[" .. (data.iX / 2) .. ",-0.02;0.7,1;size_inc;+]" ..
"button["..((data.iX/2) + 0.5).. "button[" .. ((data.iX / 2) + 0.5) ..
",-0.02;0.7,1;size_dec;-]".. ",-0.02;0.7,1;size_dec;-]" ..
"button["..(data.iX-3)..".4,0;0.8,0.95;prev;<]".. "button[" .. (data.iX - 3) .. ".4,0;0.8,0.95;prev;<]" ..
"label["..(data.iX-2)..".1,0.18;".. "label[" .. (data.iX - 2) .. ".1,0.18;" ..
colorize(data.pagenum).." / "..data.pagemax.."]".. colorize(data.pagenum) .. " / " .. data.pagemax .. "]" ..
"button["..(data.iX-1)..".2,0;0.8,0.95;next;>]".. "button[" .. (data.iX - 1) .. ".2,0;0.8,0.95;next;>]" ..
"field[0.3,0.32;2.5,1;filter;;".. "field[0.3,0.32;2.5,1;filter;;" ..
mt.formspec_escape(data.filter).."]" mt.formspec_escape(data.filter) .. "]"
local even_num = data.iX % 2 == 0 local even_num = data.iX % 2 == 0
local xoffset = data.iX / 2 + (even_num and 0.5 or 0) local xoffset = data.iX / 2 + (even_num and 0.5 or 0)
if not next(data.items) then if not next(data.items) then
formspec = formspec.. formspec = formspec ..
"label["..(xoffset - (even_num and 1.5 or 1)).. "label[" .. (xoffset - (even_num and 1.5 or 1)) .. ",2;No item to show]"
",2;No item to show]"
end end
local first_item = (data.pagenum - 1) * ipp local first_item = (data.pagenum - 1) * ipp
for i = first_item, first_item + ipp - 1 do for i = first_item, first_item + ipp - 1 do
local name = data.items[i+1] local name = data.items[i + 1]
if not name then break end if not name then break end
local X = i % data.iX local X = i % data.iX
local Y = (i % ipp - X) / data.iX + 1 local Y = (i % ipp - X) / data.iX + 1
formspec = formspec.. formspec = formspec ..
"item_image_button["..X..","..Y..";1,1;".. "item_image_button[" .. X .. "," .. Y .. ";1,1;" ..
name..";"..name.."_inv;]" name .. ";" .. name .. "_inv;]"
end end
if data.item and reg_items[data.item] then if data.item and reg_items[data.item] then
local tooltip = self:get_tooltip(data.item) local tooltip = self:get_tooltip(data.item)
if not data.recipes_item or (is_fuel and not if not data.recipes_item or (is_fuel and not get_recipe(data.item).items) then
get_recipe(data.item).items) then formspec = formspec ..
formspec = formspec.. "image[" .. (xoffset - 1) .. "," .. (iY + 2) ..
"image["..(xoffset-1)..","..(iY+2).. ".12;0.9,0.7;craftguide_arrow.png]" ..
".12;0.9,0.7;craftguide_arrow.png]".. "item_image_button[" .. xoffset .. "," .. (iY + 2) ..
"item_image_button["..xoffset..","..(iY+2).. ";1,1;" .. data.item .. ";" .. data.item .. ";]" ..
";1,1;"..data.item..";"..data.item..";]".. tooltip .. "image[" .. (xoffset - 2) .. "," ..
tooltip.."image["..(xoffset-2)..",".. (iY + 1.98) .. ";1,1;craftguide_fire.png]"
(iY+1.98)..";1,1;craftguide_fire.png]"
else else
formspec = formspec..self:get_recipe( formspec = formspec ..
iY, xoffset, tooltip, data.item, self:get_recipe(iY, xoffset, tooltip, data.item,
data.recipe_num, data.recipes_item) data.recipe_num, data.recipes_item)
end end
end end
@ -222,8 +215,10 @@ function craftguide:get_formspec(player_name, is_fuel)
end end
local function player_has_item(T) local function player_has_item(T)
for i=1, #T do for i = 1, #T do
if T[i] then return true end if T[i] then
return true
end
end end
end end
@ -235,6 +230,7 @@ local function group_to_items(group)
items_with_group[counter] = name items_with_group[counter] = name
end end
end end
return items_with_group return items_with_group
end end
@ -252,7 +248,7 @@ function craftguide:recipe_in_inv(inv, item_name, recipes_f)
local group_in_inv = false local group_in_inv = false
if item:sub(1,6) == "group:" then if item:sub(1,6) == "group:" then
local groups = group_to_items(item) local groups = group_to_items(item)
for j=1, #groups do for j = 1, #groups do
if item_in_inv(inv, groups[j]) then if item_in_inv(inv, groups[j]) then
group_in_inv = true group_in_inv = true
end end
@ -263,7 +259,8 @@ function craftguide:recipe_in_inv(inv, item_name, recipes_f)
end end
end end
end end
for i=#show_item_recipes, 1, -1 do
for i = #show_item_recipes, 1, -1 do
if not show_item_recipes[i] then if not show_item_recipes[i] then
remove(recipes, i) remove(recipes, i)
end end
@ -291,8 +288,7 @@ end
function craftguide:get_filter_items(data, player) function craftguide:get_filter_items(data, player)
local filter = data.filter local filter = data.filter
local items_list = progressive_mode and data.init_filter_items or local items_list = progressive_mode and data.init_filter_items or datas.init_items
datas.init_items
local inv = player:get_inventory() local inv = player:get_inventory()
local filtered_list, counter = {}, 0 local filtered_list, counter = {}, 0
@ -301,8 +297,7 @@ function craftguide:get_filter_items(data, player)
local item_desc = reg_items[item].description:lower() local item_desc = reg_items[item].description:lower()
if filter ~= "" then if filter ~= "" then
if item:find(filter, 1, true) or if item:find(filter, 1, true) or item_desc:find(filter, 1, true) then
item_desc:find(filter, 1, true) then
counter = counter + 1 counter = counter + 1
filtered_list[counter] = item filtered_list[counter] = item
end end
@ -327,21 +322,22 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
local data = datas[player_name] local data = datas[player_name]
if fields.clear then if fields.clear then
data.filter, data.item, data.pagenum, data.recipe_num = data.filter, data.item, data.pagenum, data.recipe_num = "", nil, 1, 1
"", nil, 1, 1 data.items = progressive_mode and data.init_filter_items or datas.init_items
data.items = progressive_mode and data.init_filter_items or
datas.init_items
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
elseif fields.alternate then elseif fields.alternate then
local recipe = data.recipes_item[data.recipe_num + 1] local recipe = data.recipes_item[data.recipe_num + 1]
data.recipe_num = recipe and data.recipe_num + 1 or 1 data.recipe_num = recipe and data.recipe_num + 1 or 1
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
elseif (fields.key_enter_field == "filter" or fields.search) and elseif (fields.key_enter_field == "filter" or fields.search) and
fields.filter ~= "" then fields.filter ~= "" then
data.filter = fields.filter:lower() data.filter = fields.filter:lower()
data.pagenum = 1 data.pagenum = 1
craftguide:get_filter_items(data, player) craftguide:get_filter_items(data, player)
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
elseif fields.prev or fields.next then elseif fields.prev or fields.next then
data.pagenum = data.pagenum - (fields.prev and 1 or -1) data.pagenum = data.pagenum - (fields.prev and 1 or -1)
if data.pagenum > data.pagemax then if data.pagenum > data.pagemax then
@ -350,11 +346,13 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
data.pagenum = data.pagemax data.pagenum = data.pagemax
end end
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
elseif (fields.size_inc and data.iX < 12) or elseif (fields.size_inc and data.iX < 12) or
(fields.size_dec and data.iX > 8) then (fields.size_dec and data.iX > 8) then
data.pagenum = 1 data.pagenum = 1
data.iX = data.iX - (fields.size_dec and 1 or -1) data.iX = data.iX - (fields.size_dec and 1 or -1)
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
else for item in pairs(fields) do else for item in pairs(fields) do
if item:find(":") then if item:find(":") then
if item:sub(-4) == "_inv" then if item:sub(-4) == "_inv" then
@ -366,22 +364,18 @@ mt.register_on_player_receive_fields(function(player, formname, fields)
if not recipes and not is_fuel then return end if not recipes and not is_fuel then return end
if item == data.item then if item == data.item then
-- Cycle through alternatives when clicking same item again
if data.recipes_item and #data.recipes_item >= 2 then if data.recipes_item and #data.recipes_item >= 2 then
local recipe = data.recipes_item[data.recipe_num + 1] local recipe = data.recipes_item[data.recipe_num + 1]
data.recipe_num = recipe and data.recipe_num + 1 or 1 data.recipe_num = recipe and data.recipe_num + 1 or 1
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
end end
else else
if progressive_mode then if progressive_mode then
local inv = player:get_inventory() local inv = player:get_inventory()
local _, has_item = local _, has_item = craftguide:recipe_in_inv(inv, item)
craftguide:recipe_in_inv(inv, item)
if not has_item then return end if not has_item then return end
recipes = craftguide:recipe_in_inv( recipes = craftguide:recipe_in_inv(inv, item, recipes)
inv, item, recipes)
end end
data.item = item data.item = item
@ -403,10 +397,9 @@ function craftguide:on_use(itemstack, user)
local data = datas[player_name] local data = datas[player_name]
if progressive_mode or not data then if progressive_mode or not data then
datas[player_name] = {filter="", pagenum=1, iX=9} datas[player_name] = {filter = "", pagenum = 1, iX = 9}
if progressive_mode then if progressive_mode then
craftguide:get_filter_items( craftguide:get_filter_items(datas[player_name], user)
datas[player_name], user)
end end
craftguide:get_formspec(player_name) craftguide:get_formspec(player_name)
else else
@ -419,7 +412,7 @@ mt.register_craftitem("craftguide:book", {
inventory_image = "craftguide_book.png", inventory_image = "craftguide_book.png",
wield_image = "craftguide_book.png", wield_image = "craftguide_book.png",
stack_max = 1, stack_max = 1,
groups = {book=1}, groups = {book = 1},
on_use = function(itemstack, user) on_use = function(itemstack, user)
craftguide:on_use(itemstack, user) craftguide:on_use(itemstack, user)
end end
@ -434,7 +427,7 @@ mt.register_node("craftguide:sign", {
paramtype = "light", paramtype = "light",
paramtype2 = "wallmounted", paramtype2 = "wallmounted",
sunlight_propagates = true, sunlight_propagates = true,
groups = {wood=1, oddly_breakable_by_hand=1, flammable=3}, groups = {wood = 1, oddly_breakable_by_hand = 1, flammable = 3},
node_box = { node_box = {
type = "wallmounted", type = "wallmounted",
wall_top = {-0.4375, 0.4375, -0.3125, 0.4375, 0.5, 0.3125}, wall_top = {-0.4375, 0.4375, -0.3125, 0.4375, 0.5, 0.3125},
@ -474,7 +467,7 @@ mt.register_craft({
burntime = 10 burntime = 10
}) })
if mt.get_modpath("sfinv_buttons") then if rawget(_G, "sfinv_buttons") then
sfinv_buttons.register_button("craftguide", { sfinv_buttons.register_button("craftguide", {
title = "Crafting guide", title = "Crafting guide",
tooltip = "Shows a list of available crafting recipes, cooking recipes and fuels", tooltip = "Shows a list of available crafting recipes, cooking recipes and fuels",