This hook is called when a player has right-clicked a block with an item that can be used (is not placeable, is not food and clicked block is not use-able), such as a bucket or a hoe. It is called before Cuberite processes the usage (places fluid / turns dirt to farmland). Plugins may refuse the interaction by returning true.

Note that the block coords given in this callback are for the (solid) block that is being clicked, not the air block between it and the player.

To get the world at which the right-click occurred, use the cPlayer:GetWorld() function. To get the item that the player is using, use the cPlayer:GetEquippedItem() function.

See also the HOOK_PLAYER_USED_ITEM for a similar hook called after the use, the HOOK_PLAYER_USING_BLOCK and HOOK_PLAYER_USED_BLOCK for similar hooks called when a player interacts with a block, such as a chest.

Callback function

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

function OnPlayerUsingItem(Player, BlockX, BlockY, BlockZ, BlockFace, CursorX, CursorY, CursorZ, BlockType, BlockMeta)

Parameters:

If the function returns false or no value, other plugins' callbacks are called and then Cuberite processes the interaction. If the function returns true, no other callbacks are called for this event and the interaction is silently dropped.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_PLAYER_USING_ITEM, MyOnPlayerUsingItem);