This callback gets called whenever a block is about to be dug. This includes players digging blocks, entities causing blocks to disappear (TNT, Endermen) and natural causes (water washing away a block). Plugins may override the amount and kinds of pickups this action produces.

Callback function

The default name for the callback function is OnBlockToPickups. It has the following signature:

function OnBlockToPickups(World, Digger, BlockX, BlockY, BlockZ, BlockType, BlockMeta, Pickups)

Parameters:

If the function returns false or no value, the next callback in the hook chain will be called. If the function returns true, no other callbacks in the chain will be called.

Either way, the server will then spawn pickups specified in the Pickups parameter, so to disable pickups, you need to Clear the object first, then return true.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_BLOCK_TO_PICKUPS, MyOnBlockToPickups);

Modify pickups

This example callback function makes tall grass drop diamonds when digged by natural causes (washed away by water).

function OnBlockToPickups(a_World, a_Digger, a_BlockX, a_BlockY, a_BlockZ, a_BlockType, a_BlockMeta, a_Pickups)
	if (a_Digger ~= nil) then
		-- Not a natural cause
		return false;
	end
	if (a_BlockType ~= E_BLOCK_TALL_GRASS) then
		-- Not a tall grass being washed away
		return false;
	end

	-- Remove all pickups suggested by Cuberite:
	a_Pickups:Clear();

	-- Drop a diamond:
	a_Pickups:Add(cItem(E_ITEM_DIAMOND));
	return true;
end;