[MOD 0.11.x] canInsert() that returns a count

[Rseding91]

This isn't so much a mod its self as it is a function for modders to use. It's a function that takes an entity, a table of inventory indexes and a item stack and returns a table with the ["count"] that can be inserted and the count of slots ["slots"] that will get used by inserting that many of the stack.


Example usage:

Code: Select all

local result = canInsert(game.player, {[1] = 2}, {name = "iron-ore", count = 5000})
-- "2" for player inventory index 2 (the main inventory)

if result["count"] > 0 then
	game.player.print("Inserting: " .. result["count"] .. " iron-ore using: " .. result["slots"] .. " empty slots.")
	game.player.insert({name = "iron-ore", count = result["count"]})
end

For a more complex usage example see my mod "Faster Spilling" -> here


Current version: 1.1.0

code

Code: Select all

function canInsert(_entity, _index, _stack)
	-- NOTE: if checking the hotbar and the player has their hotbar filtered and there's nothing in the filtered slot caninsert will return true for that slot
	local stackSize = game.itemprototypes[_stack.name].stacksize
	local results = {["count"] = 0, ["slots"] = 0}
	local toInsertCount = _stack.count
	
	if toInsertCount ~= 0 then
		for _,index in pairs(_index) do
			inventoryContents = _entity.getinventory(index)
			
			for slot = 1,#inventoryContents do
				contents = inventoryContents[slot]
				
				if contents ~= nil then
					-- Slot with contents
					if contents.name == _stack.name then
						if contents.count < stackSize then
							if toInsertCount >= stackSize - contents.count then
								results["count"] = results["count"] + (stackSize - contents.count)
								toInsertCount = toInsertCount - (stackSize - contents.count)
							else
								results["count"] = results["count"] + toInsertCount
								toInsertCount = 0
								break
							end
						end
					end
				else
					-- Empty slot
					results["slots"] = results["slots"] + 1
					
					if toInsertCount >= stackSize then
						results["count"] = results["count"] + stackSize
						toInsertCount = toInsertCount - stackSize
					else
						results["count"] = results["count"] + toInsertCount
						toInsertCount = 0
						break
					end
				end
			end
			
			if toInsertCount == 0 then
				break
			end
		end
	end
	
	return results
end

File download:

canInsert.zip

(622 Bytes) Downloaded 286 times

[SHiRKiT]

Maybe there should be a shared library for that? I know FreeER did something like this. Maybe there could be a Github repo to store those methods that people judge useful.