Add `remove_items2` and `can_remove2` as a clean replacements

[SmallJoker]

Reason: tube.remove_items(pos, node, stack, dir, count, listname, i) and tube.can_remove(pos, node, stack, dir, listname, i) are currently flawed as they ..

1. .. have arguments that are ordered differently to the inventory callback API provided by Luanti.
2. .. have a superfluous node arg
3. .. do not provide player information --> useful in can_remove

Request:

• Implement and document tube.remove_items2(pos, listname, index, stack, player, dir) (where dir is additional)
• tube.can_remove2 likewise.
• The returned stack should be removed by pipeworks and not the callback. Compare with on_metadata_inventory_take, where this is already done well.

I also thought of extending fakeplayer with a field to indicate the pipeworks origin, such that allow_metadata_inventory_take could be used, however, then there's no direction information, which might be needed in some cases.

[OgelGames]

Is there a use case that would necessitate this change, or is this just for API parity?

Also, remove_items is intended to be used to replace the injector's default behavior, which does call on_metadata_inventory_take:

pipeworks/filter-injector.lua

Lines 351 to 376 in e23a2fd

	if fromtube.remove_items then
	for i, spos in ipairs(sposes) do
	-- it could be the entire stack...
	item = fromtube.remove_items(frompos, fromnode, frominv:get_stack(frominvname, spos), dir, taken, frominvname, spos)
	local count = math.min(taken, item:get_count())
	taken = taken - count
	real_taken = real_taken + count
	if taken == 0 then break end
	if not filterfor.count then break end
	end
	else
	for i, spos in ipairs(sposes) do
	-- it could be the entire stack...
	local stack = frominv:get_stack(frominvname, spos)
	local count = math.min(taken, stack:get_count())
	item = stack:take_item(taken)
	frominv:set_stack(frominvname, spos, stack)
	if fromdef.on_metadata_inventory_take then
	fromdef.on_metadata_inventory_take(frompos, frominvname, spos, item, fakeplayer)
	end
	taken = taken - count
	real_taken = real_taken + count
	if taken == 0 then break end
	if not filterfor.count then break end
	end
	end

That said, it does lack a reference to the fake player, which could be useful in some cases.

[SmallJoker]

or is this just for API parity?

Mostly API parity and sanity. It's easy to duplicate or delete ItemStacks with the current structure because the removal happens in tube.remove_items, whereas the injected pipeworks item (entity) is calculated after the callback. Removal and spawning should happen in the same mod to ensure the least mistakes.