This hook is called when Cuberite receives a right-click packet from the client. It is called before any processing whatsoever is performed on the packet, meaning that hacked / malicious clients may be trigerring this event very often and with unchecked parameters. Therefore plugin authors are advised to use extreme caution with this callback.

Plugins may refuse the default processing for the packet, causing Cuberite to behave as if the packet has never arrived. This may, however, create inconsistencies in the client - the client may think that they placed a block, while the server didn't process the placing, etc.

Callback function

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

function OnPlayerRightClick(Player, BlockX, BlockY, BlockZ, BlockFace, CursorX, CursorY, CursorZ)

Parameters:

If the function returns false or no value, Cuberite calls other plugins' callbacks and finally sends the packet for further processing.

If the function returns true, no other plugins are called, processing is halted.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_PLAYER_RIGHT_CLICK, MyOnPlayerRightClick);