This hook is called when a player has right-clicked a block that can be used, such as a chest or a lever. It is called before Cuberite processes the usage (sends the UI handling packets / toggles redstone). 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.

See also the HOOK_PLAYER_USED_BLOCK for a similar hook called after the use, the HOOK_PLAYER_USING_ITEM and HOOK_PLAYER_USED_ITEM for similar hooks called when a player interacts with any block with a usable item in hand, such as a bucket.

Callback function

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

function OnPlayerUsingBlock(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 block is treated like any other block (i.e. if it's possible to place a torch on, it will be placed, and so on.)

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_PLAYER_USING_BLOCK, MyOnPlayerUsingBlock);