Add support for double chests
This commit is contained in:
@@ -5,16 +5,41 @@ local math = _G["math"]
|
|||||||
local string = _G["string"]
|
local string = _G["string"]
|
||||||
local table = _G["table"]
|
local table = _G["table"]
|
||||||
|
|
||||||
|
local mcl_util
|
||||||
|
|
||||||
|
|
||||||
-- Constants ---------------------------------------------------------------------------------------
|
-- Constants ---------------------------------------------------------------------------------------
|
||||||
|
|
||||||
local MAIN = "main"
|
local MAIN = "main"
|
||||||
local HOTBAR_SIZE = 9
|
local HOTBAR_SIZE = 9
|
||||||
|
|
||||||
|
local CONTAINER = {
|
||||||
|
SMALL = 2,
|
||||||
|
SHULKER = 3,
|
||||||
|
LEFT = 5,
|
||||||
|
RIGHT = 6,
|
||||||
|
}
|
||||||
|
|
||||||
-- Local Functions ---------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
local function consolidate_stacks(stacks)
|
-- Private Functions -------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
local private = {}
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Combine like item stacks to make as compact a list as possible.
|
||||||
|
|
||||||
|
This function avoids allocating new ItemStack objects by altering the counts of the existing
|
||||||
|
stacks to fill up stacks earlier in the array with items from stacks found later in the array.
|
||||||
|
If any given stack is emptied, it is omitted from the returned array.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- stacks:array[ItemStack] - an array-like table of ItemStack objects
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - an new array-like table containing the consolidated item stacks
|
||||||
|
remaining
|
||||||
|
]]
|
||||||
|
function private.consolidate_stacks(stacks)
|
||||||
local result = {}
|
local result = {}
|
||||||
for _, stack in ipairs(stacks) do
|
for _, stack in ipairs(stacks) do
|
||||||
local item_def = core.registered_items[stack:get_name()]
|
local item_def = core.registered_items[stack:get_name()]
|
||||||
@@ -44,57 +69,296 @@ local function consolidate_stacks(stacks)
|
|||||||
return result
|
return result
|
||||||
end
|
end
|
||||||
|
|
||||||
local function extract_inventory_stacks(inventory, skip_count)
|
|
||||||
local result = {}
|
--[[
|
||||||
local first_slot = 1 + (skip_count or 0)
|
Extract an array of item stacks from a given inventory.
|
||||||
local last_slot = inventory:get_size(MAIN)
|
|
||||||
|
Args:
|
||||||
|
- inventory:InvRef - the inventory from which to extract item stacks
|
||||||
|
- target:array[ItemStack]|nil - the array to place the stacks into (a new list as default)
|
||||||
|
- skip_count:int|nil - the number of slots to skip at the start of the list (e.g., the
|
||||||
|
hotbar items from the player's "main" inventory) (0 by default)
|
||||||
|
- list_name:str|nil - the list from which to extract items ("main" by default)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - the list which contains the extracted items
|
||||||
|
]]
|
||||||
|
function private.extract_stacks(inventory, target, skip_count, list_name)
|
||||||
|
target = target or {}
|
||||||
|
skip_count = skip_count or 0
|
||||||
|
list_name = list_name or MAIN
|
||||||
|
|
||||||
|
local first_slot = 1 + skip_count
|
||||||
|
local last_slot = inventory:get_size(list_name)
|
||||||
|
|
||||||
for index = first_slot, last_slot do
|
for index = first_slot, last_slot do
|
||||||
local stack = inventory:get_stack(MAIN, index)
|
local stack = inventory:get_stack(list_name, index)
|
||||||
if stack == nil then goto continue end
|
if stack == nil then goto continue end
|
||||||
if stack:is_empty() then goto continue end
|
if stack:is_empty() then goto continue end
|
||||||
|
|
||||||
table.insert(result, stack)
|
table.insert(target, stack)
|
||||||
|
|
||||||
::continue::
|
::continue::
|
||||||
end
|
end
|
||||||
|
|
||||||
return result
|
return target
|
||||||
end
|
end
|
||||||
|
|
||||||
local function get_human_name(stack)
|
|
||||||
|
--[[
|
||||||
|
Extract item stacks from any valid chest, small or large.
|
||||||
|
|
||||||
|
This function can handle both small and large chests as well as other chest-like objects.
|
||||||
|
Whatever the underlying node, a single list will be returned containing all the item stacks in
|
||||||
|
the (potentially combined) inventory of all the blocks which make up the chest.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- pos:vector - the location of the chest (or half-chest)
|
||||||
|
- target:array[ItemStack]|nil - the array to place the stacks into (a new list as default)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - the list which contains the extracted items
|
||||||
|
]]
|
||||||
|
function private.extract_stacks_from_chest(pos, target)
|
||||||
|
target = target or {}
|
||||||
|
|
||||||
|
local node = core.get_node(pos)
|
||||||
|
if node == nil then return target end
|
||||||
|
|
||||||
|
private.extract_stacks_from_node(pos, target)
|
||||||
|
|
||||||
|
if mcl_util ~= nil then
|
||||||
|
local container_type = core.get_item_group(node.name, "container")
|
||||||
|
if container_type == CONTAINER.LEFT then
|
||||||
|
pos = mcl_util.get_double_container_neighbor_pos(pos, node.param2, "left")
|
||||||
|
private.extract_stacks_from_node(pos, target)
|
||||||
|
elseif container_type == CONTAINER.RIGHT then
|
||||||
|
pos = mcl_util.get_double_container_neighbor_pos(pos, node.param2, "right")
|
||||||
|
private.extract_stacks_from_node(pos, target)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return target
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Extract the item stacks contained in a node's inventory.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- pos:vector - the location of the node whose inventory is to be extracted
|
||||||
|
- target:array[ItemStack]|nil - the array to place the stacks into (a new list as default)
|
||||||
|
- list_name:string - the name of the inventory list to extract ("main" as default)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - the list which contains the extracted items
|
||||||
|
]]
|
||||||
|
function private.extract_stacks_from_node(pos, target, list_name)
|
||||||
|
local inventory = core.get_inventory({type="node", pos=pos})
|
||||||
|
if inventory == nil then return target end
|
||||||
|
|
||||||
|
return private.extract_stacks(inventory, target, 0, list_name)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Retrieve the human-readable name for a given item stack.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- stack:ItemStack - the item stack whose name is desired
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- str - the unlocalized human-readble name for the given item
|
||||||
|
]]
|
||||||
|
function private.get_human_name(stack)
|
||||||
local desc = stack:get_short_description()
|
local desc = stack:get_short_description()
|
||||||
local split, _ = string.find(desc, ")", 1, true)
|
local split, _ = string.find(desc, ")", 1, true)
|
||||||
if split == nil then return desc end
|
if split == nil then return desc end
|
||||||
return string.sub(desc, split+1)
|
return string.sub(desc, split+1)
|
||||||
end
|
end
|
||||||
|
|
||||||
local function inject_inventory(inventory, stacks, skip_count)
|
|
||||||
local first_index = 1 + (skip_count or 0)
|
--[[
|
||||||
local last_index = inventory:get_size(MAIN)
|
Replace the contents of an inventory list with an array of item stacks.
|
||||||
|
|
||||||
|
This function overwrites the inventory list's contents with the provided array of item stacks,
|
||||||
|
including emptying any "extra" positions.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- inventory:InvRef - the inventory to alter
|
||||||
|
- stacks:array[ItemStack] - the item stacks to use as a replacement
|
||||||
|
- list_name:str|nil - the list to overwrite ("main" by default)
|
||||||
|
- skip_count:int - the number of slots at the start of the list to leave untouched (e.g.,
|
||||||
|
the hotbar of the player's "main" inventory list) (0 by default)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - any item stacks which didn't fit into the provided inventory
|
||||||
|
]]
|
||||||
|
function private.inject_stacks(inventory, stacks, skip_count, list_name)
|
||||||
|
list_name = list_name or MAIN
|
||||||
|
skip_count = skip_count or 0
|
||||||
|
|
||||||
|
local first_index = 1 + skip_count
|
||||||
|
local last_index = inventory:get_size(list_name)
|
||||||
|
local stack_index = 1
|
||||||
for inv_index = first_index, last_index do
|
for inv_index = first_index, last_index do
|
||||||
local stack_index = inv_index - first_index + 1
|
inventory:set_stack(list_name, inv_index, stacks[stack_index])
|
||||||
inventory:set_stack(MAIN, inv_index, stacks[stack_index])
|
stack_index = stack_index + 1
|
||||||
|
end
|
||||||
|
|
||||||
|
local remaining = {}
|
||||||
|
while stack_index <= #stacks do
|
||||||
|
table.insert(remaining, stacks[stack_index])
|
||||||
|
stack_index = stack_index + 1
|
||||||
|
end
|
||||||
|
|
||||||
|
return remaining
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Inject item stacks into a chest, replacing the items which were already there.
|
||||||
|
|
||||||
|
This function is aware of both single-node and multi-node chests. In the latter case, it will
|
||||||
|
attempt to fill the left-hand side of the chest before proceeding on to the right-hand side. In
|
||||||
|
either case, if not all of the items could be placed in the chest, the returned list will
|
||||||
|
contain those left over.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- pos:vector - the location of the chest (or half-chest)
|
||||||
|
- stacks:array[ItemStack] - the item stacks to be placed into the chest
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - any items which couldn't be fit into the chest
|
||||||
|
]]
|
||||||
|
function private.inject_stacks_into_chest(pos, stacks)
|
||||||
|
local node = core.get_node(pos)
|
||||||
|
if node == nil then return end
|
||||||
|
|
||||||
|
local left_pos, right_pos = pos, nil
|
||||||
|
|
||||||
|
if mcl_util ~= nil then
|
||||||
|
local container_type = core.get_item_group(node.name, "container")
|
||||||
|
if container_type == CONTAINER.LEFT then
|
||||||
|
left_pos = pos
|
||||||
|
right_pos = mcl_util.get_double_container_neighbor_pos(pos, node.param2, "left")
|
||||||
|
elseif container_type == CONTAINER.RIGHT then
|
||||||
|
left_pos = mcl_util.get_double_container_neighbor_pos(pos, node.param2, "right")
|
||||||
|
right_pos = pos
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
local function is_inventory_node(item_def)
|
local remaining = stacks
|
||||||
if item_def.allow_metadata_inventory_move then return true end
|
if left_pos ~= nil then
|
||||||
if item_def.allow_metadata_inventory_put then return true end
|
remaining = private.inject_stacks_into_node(left_pos, remaining)
|
||||||
if item_def.allow_metadata_inventory_take then return true end
|
end
|
||||||
|
if right_pos ~= nil then
|
||||||
|
remaining = private.inject_stacks_into_node(right_pos, remaining)
|
||||||
|
end
|
||||||
|
|
||||||
|
return remaining
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Replace a given node's inventory with a give set of item stacks.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- pos:vector - the location of the node to modify
|
||||||
|
- stacks:array[ItemStack] - the item stacks to insert
|
||||||
|
- list_name:string|nil - the inventory list to affect ("main" as default)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- array[ItemStack] - any items which couldn't be fit into the node's inventory
|
||||||
|
]]
|
||||||
|
function private.inject_stacks_into_node(pos, stacks, list_name)
|
||||||
|
local inventory = core.get_inventory({type="node", pos=pos})
|
||||||
|
if inventory == nil then return stacks end
|
||||||
|
|
||||||
|
return private.inject_stacks(inventory, stacks, 0, list_name)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Determine whether a certain type of node contains an inventory.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- node:table<node definition> - the node definition to consider
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- true if that node type has an inventory
|
||||||
|
]]
|
||||||
|
function private.is_inventory_node(node_def)
|
||||||
|
if node_def.allow_metadata_inventory_move then return true end
|
||||||
|
if node_def.allow_metadata_inventory_put then return true end
|
||||||
|
if node_def.allow_metadata_inventory_take then return true end
|
||||||
return false
|
return false
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
-- Local Functions (layer 2) ---------------------------------------------------
|
--[[
|
||||||
|
Sort the inventory attached to a chest.
|
||||||
|
|
||||||
local function sort_stacks(stacks)
|
This function will look for a chest at the given coordinates, and both consolidate stacks and
|
||||||
|
sort the contents by their (unlocalized) human-readable name. This function only affects the
|
||||||
|
"main" inventory of the node, so its safe to use on things like furnaces, etc. It is also
|
||||||
|
aware of double-chests added by Minclonia, and will correctly sort all the contents of such
|
||||||
|
chests.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- pos:vector - the location of the node whose inventory should be sorted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- nil
|
||||||
|
]]
|
||||||
|
function private.sort_chest(pos)
|
||||||
|
local stacks = private.extract_stacks_from_chest(pos)
|
||||||
|
stacks = private.consolidate_stacks(stacks)
|
||||||
|
stacks = private.sort_stacks(stacks)
|
||||||
|
private.inject_stacks_into_chest(pos, stacks)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Sort the player's main inventory list (excluding the hotbar).
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- player:ObjectRef - the player whose inventory is to be sorted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- nil
|
||||||
|
]]
|
||||||
|
function private.sort_player_inventory(player)
|
||||||
|
local inventory = player:get_inventory()
|
||||||
|
if inventory == nil then return end
|
||||||
|
|
||||||
|
local stacks = private.extract_stacks(inventory, {}, HOTBAR_SIZE)
|
||||||
|
stacks = private.consolidate_stacks(stacks)
|
||||||
|
stacks = private.sort_stacks(stacks)
|
||||||
|
private.inject_stacks(inventory, stacks, HOTBAR_SIZE)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
--[[
|
||||||
|
Sort a list of item stacks according to human-readable name.
|
||||||
|
|
||||||
|
The sorting is performed in place using the unlocalized human-readable name for each item taken
|
||||||
|
from the item's "short" description. If multiple stacks have the same name, then the size of
|
||||||
|
the stack (largest to smallest) is used to break the tie.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- stacks:array[ItemStack] - the array/table to be sorted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- nil
|
||||||
|
]]
|
||||||
|
function private.sort_stacks(stacks)
|
||||||
table.sort(stacks, function(a, b)
|
table.sort(stacks, function(a, b)
|
||||||
if a == nil then return false end
|
if a == nil then return false end
|
||||||
if b == nil then return true end
|
if b == nil then return true end
|
||||||
|
|
||||||
local a_name = get_human_name(a)
|
local a_name = private.get_human_name(a)
|
||||||
local b_name = get_human_name(b)
|
local b_name = private.get_human_name(b)
|
||||||
if a_name ~= b_name then
|
if a_name ~= b_name then
|
||||||
return a_name < b_name
|
return a_name < b_name
|
||||||
end
|
end
|
||||||
@@ -109,29 +373,20 @@ local function sort_stacks(stacks)
|
|||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
-- Local Functions (layer 3) ---------------------------------------------------
|
--[[
|
||||||
|
Watch a given type of node for changes to its inventory.
|
||||||
|
|
||||||
local function sort_node_inventory(inventory)
|
This function uses the standard callback functions for a node definition (i.e., the various
|
||||||
local stacks = extract_inventory_stacks(inventory)
|
on_metadata_inventory_* functions), and ensures the existing function is called first, so it's
|
||||||
stacks = consolidate_stacks(stacks)
|
safe to use with other mods.
|
||||||
stacks = sort_stacks(stacks)
|
|
||||||
inject_inventory(inventory, stacks)
|
|
||||||
end
|
|
||||||
|
|
||||||
local function sort_player_inventory(player)
|
Args:
|
||||||
local inventory = player:get_inventory()
|
- table<node definition> - the node type to watch
|
||||||
if inventory == nil then return end
|
|
||||||
|
|
||||||
local stacks = extract_inventory_stacks(inventory, HOTBAR_SIZE)
|
Returns:
|
||||||
stacks = consolidate_stacks(stacks)
|
- nil
|
||||||
stacks = sort_stacks(stacks)
|
]]
|
||||||
inject_inventory(inventory, stacks, HOTBAR_SIZE)
|
function private.watch_node_inventory(node_def)
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
-- Local Functions (layer 4) ---------------------------------------------------
|
|
||||||
|
|
||||||
local function watch_node_inventory(node_def)
|
|
||||||
local old_omi_move = node_def.on_metadata_inventory_move
|
local old_omi_move = node_def.on_metadata_inventory_move
|
||||||
local old_omi_put = node_def.on_metadata_inventory_put
|
local old_omi_put = node_def.on_metadata_inventory_put
|
||||||
local old_omi_take = node_def.on_metadata_inventory_take
|
local old_omi_take = node_def.on_metadata_inventory_take
|
||||||
@@ -140,15 +395,15 @@ local function watch_node_inventory(node_def)
|
|||||||
on_metadata_inventory_move = (function(
|
on_metadata_inventory_move = (function(
|
||||||
pos, from_list, from_index, to_list, to_index, count, player)
|
pos, from_list, from_index, to_list, to_index, count, player)
|
||||||
old_omi_move(pos, from_list, from_index, to_list, to_index, count, player)
|
old_omi_move(pos, from_list, from_index, to_list, to_index, count, player)
|
||||||
sort_node_inventory(core.get_inventory({type="node", pos=pos}))
|
private.sort_chest(pos)
|
||||||
end),
|
end),
|
||||||
on_metadata_inventory_put = (function(pos, listname, index, stack, player)
|
on_metadata_inventory_put = (function(pos, listname, index, stack, player)
|
||||||
old_omi_put(pos, listname, index, stack, player)
|
old_omi_put(pos, listname, index, stack, player)
|
||||||
sort_node_inventory(core.get_inventory({type="node", pos=pos}))
|
private.sort_chest(pos)
|
||||||
end),
|
end),
|
||||||
on_metadata_inventory_take = (function(pos, listname, index, stack, player)
|
on_metadata_inventory_take = (function(pos, listname, index, stack, player)
|
||||||
old_omi_take(pos, listname, index, stack, player)
|
old_omi_take(pos, listname, index, stack, player)
|
||||||
sort_node_inventory(core.get_inventory({type="node", pos=pos}))
|
private.sort_chest(pos)
|
||||||
end)
|
end)
|
||||||
})
|
})
|
||||||
end
|
end
|
||||||
@@ -157,23 +412,23 @@ end
|
|||||||
-- Registrations -----------------------------------------------------------------------------------
|
-- Registrations -----------------------------------------------------------------------------------
|
||||||
|
|
||||||
core.register_on_joinplayer(function(player, last_login)
|
core.register_on_joinplayer(function(player, last_login)
|
||||||
sort_player_inventory(player)
|
private.sort_player_inventory(player)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
core.register_on_player_inventory_action(function(player, action, inventory, inventory_info)
|
core.register_on_player_inventory_action(function(player, action, inventory, inventory_info)
|
||||||
sort_player_inventory(player)
|
private.sort_player_inventory(player)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
core.register_on_item_eat(function(hp_change, replace_with_item, itemstack, player, pointed_thing)
|
core.register_on_item_eat(function(hp_change, replace_with_item, itemstack, player, pointed_thing)
|
||||||
sort_player_inventory(player)
|
private.sort_player_inventory(player)
|
||||||
end)
|
end)
|
||||||
|
|
||||||
core.register_on_mods_loaded(function()
|
core.register_on_mods_loaded(function()
|
||||||
|
mcl_util = _G["mcl_util"]
|
||||||
|
|
||||||
for name, node_def in pairs(core.registered_nodes) do
|
for name, node_def in pairs(core.registered_nodes) do
|
||||||
if not is_inventory_node(node_def) then goto continue end
|
if private.is_inventory_node(node_def) then
|
||||||
|
private.watch_node_inventory(node_def)
|
||||||
watch_node_inventory(node_def)
|
end
|
||||||
|
|
||||||
::continue::
|
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
|
|||||||
Reference in New Issue
Block a user