Rewrite furnace 373/head
authorPilzAdam <pilzadam@minetest.net>
Sat, 6 Dec 2014 17:47:46 +0000 (18:47 +0100)
committerPilzAdam <pilzadam@minetest.net>
Sat, 6 Dec 2014 20:18:02 +0000 (21:18 +0100)
* Move furnace related code into furnace.lua
* Move duplicated code into functions
* Rewrite ABM:
* Easier to follow strcuture (no returns in the middle)
* No unnecessary calls to get_craft_result
* Split logic and "visual feedback" (a bit)
* Fewer calls to meta:set and meta:get
* Better feedback on the current state of the furnace

mods/default/furnace.lua [new file with mode: 0644]
mods/default/init.lua
mods/default/nodes.lua

diff --git a/mods/default/furnace.lua b/mods/default/furnace.lua
new file mode 100644 (file)
index 0000000..d49d8ef
--- /dev/null
@@ -0,0 +1,283 @@
+
+--
+-- Formspecs
+--
+
+local function active_formspec(fuel_percent, item_percent)
+       local formspec = 
+               "size[8,8.5]"..
+               default.gui_bg..
+               default.gui_bg_img..
+               default.gui_slots..
+               "list[current_name;src;2.75,0.5;1,1;]"..
+               "list[current_name;fuel;2.75,2.5;1,1;]"..
+               "image[2.75,1.5;1,1;default_furnace_fire_bg.png^[lowpart:"..
+               (100-fuel_percent)..":default_furnace_fire_fg.png]"..
+               "image[3.75,1.5;1,1;gui_furnace_arrow_bg.png^[lowpart:"..
+               (item_percent)..":gui_furnace_arrow_fg.png^[transformR270]"..
+               "list[current_name;dst;4.75,0.96;2,2;]"..
+               "list[current_player;main;0,4.25;8,1;]"..
+               "list[current_player;main;0,5.5;8,3;8]"..
+               default.get_hotbar_bg(0, 4.25)
+       return formspec
+end
+
+local inactive_formspec =
+       "size[8,8.5]"..
+       default.gui_bg..
+       default.gui_bg_img..
+       default.gui_slots..
+       "list[current_name;src;2.75,0.5;1,1;]"..
+       "list[current_name;fuel;2.75,2.5;1,1;]"..
+       "image[2.75,1.5;1,1;default_furnace_fire_bg.png]"..
+       "image[3.75,1.5;1,1;gui_furnace_arrow_bg.png^[transformR270]"..
+       "list[current_name;dst;4.75,0.96;2,2;]"..
+       "list[current_player;main;0,4.25;8,1;]"..
+       "list[current_player;main;0,5.5;8,3;8]"..
+       default.get_hotbar_bg(0, 4.25)
+
+--
+-- Node callback functions that are the same for active and inactive furnace
+--
+
+local function can_dig(pos, player)
+       local meta = minetest.get_meta(pos);
+       local inv = meta:get_inventory()
+       return inv:is_empty("fuel") and inv:is_empty("dst") and inv:is_empty("src")
+end
+
+local function allow_metadata_inventory_put(pos, listname, index, stack, player)
+       if minetest.is_protected(pos, player:get_player_name()) then
+               return 0
+       end
+       local meta = minetest.get_meta(pos)
+       local inv = meta:get_inventory()
+       if listname == "fuel" then
+               if minetest.get_craft_result({method="fuel", width=1, items={stack}}).time ~= 0 then
+                       if inv:is_empty("src") then
+                               meta:set_string("infotext", "Furnace is empty")
+                       end
+                       return stack:get_count()
+               else
+                       return 0
+               end
+       elseif listname == "src" then
+               return stack:get_count()
+       elseif listname == "dst" then
+               return 0
+       end
+end
+
+local function allow_metadata_inventory_move(pos, from_list, from_index, to_list, to_index, count, player)
+       local meta = minetest.get_meta(pos)
+       local inv = meta:get_inventory()
+       local stack = inv:get_stack(from_list, from_index)
+       return allow_metadata_inventory_put(pos, to_list, to_index, stack, player)
+end
+
+local function allow_metadata_inventory_take(pos, listname, index, stack, player)
+       if minetest.is_protected(pos, player:get_player_name()) then
+               return 0
+       end
+       return stack:get_count()
+end
+
+--
+-- Node definitions
+--
+
+minetest.register_node("default:furnace", {
+       description = "Furnace",
+       tiles = {
+               "default_furnace_top.png", "default_furnace_bottom.png",
+               "default_furnace_side.png", "default_furnace_side.png",
+               "default_furnace_side.png", "default_furnace_front.png"
+       },
+       paramtype2 = "facedir",
+       groups = {cracky=2},
+       legacy_facedir_simple = true,
+       is_ground_content = false,
+       sounds = default.node_sound_stone_defaults(),
+       
+       can_dig = can_dig,
+       
+       allow_metadata_inventory_put = allow_metadata_inventory_put,
+       allow_metadata_inventory_move = allow_metadata_inventory_move,
+       allow_metadata_inventory_take = allow_metadata_inventory_take,
+})
+
+minetest.register_node("default:furnace_active", {
+       description = "Furnace",
+       tiles = {
+               "default_furnace_top.png", "default_furnace_bottom.png",
+               "default_furnace_side.png", "default_furnace_side.png",
+               "default_furnace_side.png",
+               {
+                       image = "default_furnace_front_active.png",
+                       backface_culling = false,
+                       animation = {
+                               type = "vertical_frames",
+                               aspect_w = 16,
+                               aspect_h = 16,
+                               length = 1.5
+                       },
+               }
+       },
+       paramtype2 = "facedir",
+       light_source = 8,
+       drop = "default:furnace",
+       groups = {cracky=2, not_in_creative_inventory=1},
+       legacy_facedir_simple = true,
+       is_ground_content = false,
+       sounds = default.node_sound_stone_defaults(),
+       
+       can_dig = can_dig,
+       
+       aallow_metadata_inventory_put = allow_metadata_inventory_put,
+       allow_metadata_inventory_move = allow_metadata_inventory_move,
+       allow_metadata_inventory_take = allow_metadata_inventory_take,
+})
+
+--
+-- ABM
+--
+
+local function swap_node(pos, name)
+       local node = minetest.get_node(pos)
+       if node.name == name then
+               return
+       end
+       node.name = name
+       minetest.swap_node(pos, node)
+end
+
+minetest.register_abm({
+       nodenames = {"default:furnace", "default:furnace_active"},
+       interval = 1.0,
+       chance = 1,
+       action = function(pos, node, active_object_count, active_object_count_wider)
+               --
+               -- Inizialize metadata
+               --
+               local meta = minetest.get_meta(pos)
+               local fuel_time = meta:get_float("fuel_time") or 0
+               local src_time = meta:get_float("src_time") or 0
+               local fuel_totaltime = meta:get_float("fuel_totaltime") or 0
+               
+               --
+               -- Inizialize inventory
+               --
+               local inv = meta:get_inventory()
+               for listname, size in pairs({
+                               src = 1,
+                               fuel = 1,
+                               dst = 4,
+               }) do
+                       if inv:get_size(listname) ~= size then
+                               inv:set_size(listname, size)
+                       end
+               end
+               local srclist = inv:get_list("src")
+               local fuellist = inv:get_list("fuel")
+               local dstlist = inv:get_list("dst")
+               
+               --
+               -- Cooking
+               --
+               
+               -- Check if we have cookable content
+               local cooked, aftercooked = minetest.get_craft_result({method = "cooking", width = 1, items = srclist})
+               local cookable = true
+               
+               if cooked.time == 0 then
+                       cookable = false
+               end
+               
+               -- Check if we have enough fuel to burn
+               if fuel_time < fuel_totaltime then
+                       -- The furnace is currently active and has enough fuel
+                       fuel_time = fuel_time + 1
+                       
+                       -- If there is a cookable item then check if it is ready yet
+                       if cookable then
+                               src_time = src_time + 1
+                               if src_time >= cooked.time then
+                                       -- Place result in dst list if possible
+                                       if inv:room_for_item("dst", cooked.item) then
+                                               inv:add_item("dst", cooked.item)
+                                               inv:set_stack("src", 1, aftercooked.items[1])
+                                               src_time = 0
+                                       end
+                               end
+                       end
+               else
+                       -- Furnace ran out of fuel
+                       if cookable then
+                               -- We need to get new fuel
+                               local fuel, afterfuel = minetest.get_craft_result({method = "fuel", width = 1, items = fuellist})
+                               
+                               if fuel.time == 0 then
+                                       -- No valid fuel in fuel list
+                                       fuel_totaltime = 0
+                                       fuel_time = 0
+                                       src_time = 0
+                               else
+                                       -- Take fuel from fuel list
+                                       inv:set_stack("fuel", 1, afterfuel.items[1])
+                                       
+                                       fuel_totaltime = fuel.time
+                                       fuel_time = 0
+                                       
+                               end
+                       else
+                               -- We don't need to get new fuel since there is no cookable item
+                               fuel_totaltime = 0
+                               fuel_time = 0
+                               src_time = 0
+                       end
+               end
+               
+               --
+               -- Update formspec, infotext and node
+               --
+               local formspec = inactive_formspec
+               local item_state = ""
+               local item_percent = 0
+               if cookable then
+                       item_percent =  math.floor(src_time / cooked.time * 100)
+                       item_state = item_percent .. "%"
+               else
+                       if srclist[1]:is_empty() then
+                               item_state = "Empty"
+                       else
+                               item_state = "Not cookable"
+                       end
+               end
+               
+               local fuel_state = "Empty"
+               local active = "inactive "
+               if fuel_time <= fuel_totaltime and fuel_totaltime ~= 0 then
+                       active = "active "
+                       local fuel_percent = math.floor(fuel_time / fuel_totaltime * 100)
+                       fuel_state = fuel_percent .. "%"
+                       formspec = active_formspec(fuel_percent, item_percent)
+                       swap_node(pos, "default:furnace_active")
+               else
+                       if not fuellist[1]:is_empty() then
+                               fuel_state = "0%"
+                       end
+                       swap_node(pos, "default:furnace")
+               end
+               
+               local infotext =  "Furnace " .. active .. "(Item: " .. item_state .. "; Fuel: " .. fuel_state .. ")"
+               
+               --
+               -- Set meta values
+               --
+               meta:set_float("fuel_totaltime", fuel_totaltime)
+               meta:set_float("fuel_time", fuel_time)
+               meta:set_float("src_time", src_time)
+               meta:set_string("formspec", formspec)
+               meta:set_string("infotext", infotext)
+       end,
+})
index 7c3d077d0d1df1fecbb82654b5018c98fc9b4703..276af54391e885d58bfc416d2487333263009242 100644 (file)
@@ -38,6 +38,7 @@ default.gui_suvival_form = "size[8,8.5]"..
 -- Load files
 dofile(minetest.get_modpath("default").."/functions.lua")
 dofile(minetest.get_modpath("default").."/nodes.lua")
+dofile(minetest.get_modpath("default").."/furnace.lua")
 dofile(minetest.get_modpath("default").."/tools.lua")
 dofile(minetest.get_modpath("default").."/craftitems.lua")
 dofile(minetest.get_modpath("default").."/crafting.lua")
index 47626e8a1fd54d531d42e8ea174b3addc4dd5344..3c7d4f1375aedad5ac5a82ae4493271b6da4f773 100644 (file)
@@ -868,335 +868,6 @@ minetest.register_node("default:chest_locked", {
        end,
 })
 
-function default.furnace_active(pos, percent, item_percent)
-    local formspec = 
-       "size[8,8.5]"..
-       default.gui_bg..
-       default.gui_bg_img..
-       default.gui_slots..
-       "list[current_name;src;2.75,0.5;1,1;]"..
-       "list[current_name;fuel;2.75,2.5;1,1;]"..
-       "image[2.75,1.5;1,1;default_furnace_fire_bg.png^[lowpart:"..
-       (100-percent)..":default_furnace_fire_fg.png]"..
-        "image[3.75,1.5;1,1;gui_furnace_arrow_bg.png^[lowpart:"..
-        (item_percent*100)..":gui_furnace_arrow_fg.png^[transformR270]"..
-       "list[current_name;dst;4.75,0.96;2,2;]"..
-       "list[current_player;main;0,4.25;8,1;]"..
-       "list[current_player;main;0,5.5;8,3;8]"..
-       default.get_hotbar_bg(0,4.25)
-    return formspec
-  end
-
-function default.get_furnace_active_formspec(pos, percent)
-       local meta = minetest.get_meta(pos)local inv = meta:get_inventory()
-       local srclist = inv:get_list("src")
-       local cooked = nil
-       local aftercooked = nil
-       if srclist then
-               cooked, aftercooked = minetest.get_craft_result({method = "cooking", width = 1, items = srclist})
-       end
-       local item_percent = 0
-       if cooked then
-               item_percent = meta:get_float("src_time")/cooked.time
-       end
-       
-        return default.furnace_active(pos, percent, item_percent)
-end
-
-default.furnace_inactive_formspec =
-       "size[8,8.5]"..
-       default.gui_bg..
-       default.gui_bg_img..
-       default.gui_slots..
-       "list[current_name;src;2.75,0.5;1,1;]"..
-       "list[current_name;fuel;2.75,2.5;1,1;]"..
-       "image[2.75,1.5;1,1;default_furnace_fire_bg.png]"..
-       "image[3.75,1.5;1,1;gui_furnace_arrow_bg.png^[transformR270]"..
-       "list[current_name;dst;4.75,0.96;2,2;]"..
-       "list[current_player;main;0,4.25;8,1;]"..
-       "list[current_player;main;0,5.5;8,3;8]"..
-       default.get_hotbar_bg(0,4.25)
-
-minetest.register_node("default:furnace", {
-       description = "Furnace",
-       tiles = {"default_furnace_top.png", "default_furnace_bottom.png", "default_furnace_side.png",
-               "default_furnace_side.png", "default_furnace_side.png", "default_furnace_front.png"},
-       paramtype2 = "facedir",
-       groups = {cracky=2},
-       legacy_facedir_simple = true,
-       is_ground_content = false,
-       sounds = default.node_sound_stone_defaults(),
-       on_construct = function(pos)
-               local meta = minetest.get_meta(pos)
-               meta:set_string("formspec", default.furnace_inactive_formspec)
-               meta:set_string("infotext", "Furnace")
-               local inv = meta:get_inventory()
-               inv:set_size("fuel", 1)
-               inv:set_size("src", 1)
-               inv:set_size("dst", 4)
-       end,
-       can_dig = function(pos,player)
-               local meta = minetest.get_meta(pos);
-               local inv = meta:get_inventory()
-               if not inv:is_empty("fuel") then
-                       return false
-               elseif not inv:is_empty("dst") then
-                       return false
-               elseif not inv:is_empty("src") then
-                       return false
-               end
-               return true
-       end,
-       allow_metadata_inventory_put = function(pos, listname, index, stack, player)
-               if minetest.is_protected(pos, player:get_player_name()) then
-                       return 0
-               end
-               local meta = minetest.get_meta(pos)
-               local inv = meta:get_inventory()
-               if listname == "fuel" then
-                       if minetest.get_craft_result({method="fuel",width=1,items={stack}}).time ~= 0 then
-                               if inv:is_empty("src") then
-                                       meta:set_string("infotext","Furnace is empty")
-                               end
-                               return stack:get_count()
-                       else
-                               return 0
-                       end
-               elseif listname == "src" then
-                       return stack:get_count()
-               elseif listname == "dst" then
-                       return 0
-               end
-       end,
-       allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
-               if minetest.is_protected(pos, player:get_player_name()) then
-                       return 0
-               end
-               local meta = minetest.get_meta(pos)
-               local inv = meta:get_inventory()
-               local stack = inv:get_stack(from_list, from_index)
-               if to_list == "fuel" then
-                       if minetest.get_craft_result({method="fuel",width=1,items={stack}}).time ~= 0 then
-                               if inv:is_empty("src") then
-                                       meta:set_string("infotext","Furnace is empty")
-                               end
-                               return count
-                       else
-                               return 0
-                       end
-               elseif to_list == "src" then
-                       return count
-               elseif to_list == "dst" then
-                       return 0
-               end
-       end,
-       allow_metadata_inventory_take = function(pos, listname, index, stack, player)
-               if minetest.is_protected(pos, player:get_player_name()) then
-                       return 0
-               end
-               return stack:get_count()
-       end,
-})
-
-minetest.register_node("default:furnace_active", {
-       description = "Furnace",
-       tiles = {
-               "default_furnace_top.png",
-               "default_furnace_bottom.png",
-               "default_furnace_side.png",
-               "default_furnace_side.png",
-               "default_furnace_side.png",
-               {
-                       image = "default_furnace_front_active.png",
-                       backface_culling = false,
-                       animation = {
-                               type = "vertical_frames",
-                               aspect_w = 16,
-                               aspect_h = 16,
-                               length = 1.5
-                       },
-               }
-       },
-       paramtype2 = "facedir",
-       light_source = 8,
-       drop = "default:furnace",
-       groups = {cracky=2, not_in_creative_inventory=1},
-       legacy_facedir_simple = true,
-       is_ground_content = false,
-       sounds = default.node_sound_stone_defaults(),
-       on_construct = function(pos)
-               local meta = minetest.get_meta(pos)
-               meta:set_string("formspec", default.furnace_inactive_formspec)
-               meta:set_string("infotext", "Furnace");
-               local inv = meta:get_inventory()
-               inv:set_size("fuel", 1)
-               inv:set_size("src", 1)
-               inv:set_size("dst", 4)
-       end,
-       can_dig = function(pos,player)
-               local meta = minetest.get_meta(pos);
-               local inv = meta:get_inventory()
-               if not inv:is_empty("fuel") then
-                       return false
-               elseif not inv:is_empty("dst") then
-                       return false
-               elseif not inv:is_empty("src") then
-                       return false
-               end
-               return true
-       end,
-       allow_metadata_inventory_put = function(pos, listname, index, stack, player)
-               if minetest.is_protected(pos, player:get_player_name()) then
-                       return 0
-               end
-               local meta = minetest.get_meta(pos)
-               local inv = meta:get_inventory()
-               if listname == "fuel" then
-                       if minetest.get_craft_result({method="fuel",width=1,items={stack}}).time ~= 0 then
-                               if inv:is_empty("src") then
-                                       meta:set_string("infotext","Furnace is empty")
-                               end
-                               return stack:get_count()
-                       else
-                               return 0
-                       end
-               elseif listname == "src" then
-                       return stack:get_count()
-               elseif listname == "dst" then
-                       return 0
-               end
-       end,
-       allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player)
-               if minetest.is_protected(pos, player:get_player_name()) then
-                       return 0
-               end
-               local meta = minetest.get_meta(pos)
-               local inv = meta:get_inventory()
-               local stack = inv:get_stack(from_list, from_index)
-               if to_list == "fuel" then
-                       if minetest.get_craft_result({method="fuel",width=1,items={stack}}).time ~= 0 then
-                               if inv:is_empty("src") then
-                                       meta:set_string("infotext","Furnace is empty")
-                               end
-                               return count
-                       else
-                               return 0
-                       end
-               elseif to_list == "src" then
-                       return count
-               elseif to_list == "dst" then
-                       return 0
-               end
-       end,
-       allow_metadata_inventory_take = function(pos, listname, index, stack, player)
-               if minetest.is_protected(pos, player:get_player_name()) then
-                       return 0
-               end
-               return stack:get_count()
-       end,
-})
-
-local function swap_node(pos,name)
-       local node = minetest.get_node(pos)
-       if node.name == name then
-               return
-       end
-       node.name = name
-       minetest.swap_node(pos,node)
-end
-
-minetest.register_abm({
-       nodenames = {"default:furnace","default:furnace_active"},
-       interval = 1.0,
-       chance = 1,
-       action = function(pos, node, active_object_count, active_object_count_wider)
-               local meta = minetest.get_meta(pos)
-               for i, name in ipairs({
-                               "fuel_totaltime",
-                               "fuel_time",
-                               "src_totaltime",
-                               "src_time"
-               }) do
-                       if meta:get_string(name) == "" then
-                               meta:set_float(name, 0.0)
-                       end
-               end
-
-               local inv = meta:get_inventory()
-
-               local srclist = inv:get_list("src")
-               local cooked = nil
-               local aftercooked
-               
-               if srclist then
-                       cooked, aftercooked = minetest.get_craft_result({method = "cooking", width = 1, items = srclist})
-               end
-               
-               local was_active = false
-               
-               if meta:get_float("fuel_time") < meta:get_float("fuel_totaltime") then
-                       was_active = true
-                       meta:set_float("fuel_time", meta:get_float("fuel_time") + 1)
-                       meta:set_float("src_time", meta:get_float("src_time") + 1)
-                       if cooked and cooked.item and meta:get_float("src_time") >= cooked.time then
-                               -- check if there's room for output in "dst" list
-                               if inv:room_for_item("dst",cooked.item) then
-                                       -- Put result in "dst" list
-                                       inv:add_item("dst", cooked.item)
-                                       -- take stuff from "src" list
-                                       inv:set_stack("src", 1, aftercooked.items[1])
-                               else
-                                       --print("Could not insert '"..cooked.item:to_string().."'")
-                               end
-                               meta:set_string("src_time", 0)
-                       end
-               end
-               
-               if meta:get_float("fuel_time") < meta:get_float("fuel_totaltime") then
-                       local percent = math.floor(meta:get_float("fuel_time") /
-                                       meta:get_float("fuel_totaltime") * 100)
-                       meta:set_string("infotext","Furnace active: "..percent.."%")
-                       swap_node(pos,"default:furnace_active")
-                       meta:set_string("formspec",default.get_furnace_active_formspec(pos, percent))
-                       return
-               end
-
-               local fuel = nil
-               local afterfuel
-               local cooked = nil
-               local fuellist = inv:get_list("fuel")
-               local srclist = inv:get_list("src")
-               
-               if srclist then
-                       cooked = minetest.get_craft_result({method = "cooking", width = 1, items = srclist})
-               end
-               if fuellist then
-                       fuel, afterfuel = minetest.get_craft_result({method = "fuel", width = 1, items = fuellist})
-               end
-
-               if not fuel or fuel.time <= 0 then
-                       meta:set_string("infotext","Furnace out of fuel")
-                       swap_node(pos,"default:furnace")
-                       meta:set_string("formspec", default.furnace_inactive_formspec)
-                       return
-               end
-
-               if cooked.item:is_empty() then
-                       if was_active then
-                               meta:set_string("infotext","Furnace is empty")
-                               swap_node(pos,"default:furnace")
-                               meta:set_string("formspec", default.furnace_inactive_formspec)
-                       end
-                       return
-               end
-
-               meta:set_string("fuel_totaltime", fuel.time)
-               meta:set_string("fuel_time", 0)
-               
-               inv:set_stack("fuel", 1, afterfuel.items[1])
-       end,
-})
-
 minetest.register_node("default:cobble", {
        description = "Cobblestone",
        tiles = {"default_cobble.png"},