HOOK_PLAYER_USING_BLOCK


Index:
Articles
Classes
Hooks

Quick navigation:
BLOCK_SPREAD
BLOCK_TO_PICKUPS
BREWING_COMPLETED
BREWING_COMPLETING
CHAT
CHUNK_AVAILABLE
CHUNK_GENERATED
CHUNK_GENERATING
CHUNK_UNLOADED
CHUNK_UNLOADING
COLLECTING_PICKUP
CRAFTING_NO_RECIPE
DISCONNECT
ENTITY_ADD_EFFECT
ENTITY_CHANGED_WORLD
ENTITY_CHANGING_WORLD
ENTITY_TELEPORT
EXECUTE_COMMAND
EXPLODED
EXPLODING
HANDSHAKE
HOPPER_PULLING_ITEM
HOPPER_PUSHING_ITEM
KILLED
KILLING
LOGIN
PLAYER_ANIMATION
PLAYER_BREAKING_BLOCK
PLAYER_BROKEN_BLOCK
PLAYER_DESTROYED
PLAYER_EATING
PLAYER_FISHED
PLAYER_FISHING
PLAYER_FOOD_LEVEL_CHANGE
PLAYER_JOINED
PLAYER_LEFT_CLICK
PLAYER_MOVING
PLAYER_PLACED_BLOCK
PLAYER_PLACING_BLOCK
PLAYER_RIGHT_CLICK
PLAYER_RIGHT_CLICKING_ENTITY
PLAYER_SHOOTING
PLAYER_SPAWNED
PLAYER_TOSSING_ITEM
PLAYER_USED_BLOCK
PLAYER_USED_ITEM
PLAYER_USING_BLOCK
PLAYER_USING_ITEM
PLUGINS_LOADED
PLUGIN_MESSAGE
POST_CRAFTING
PRE_CRAFTING
PROJECTILE_HIT_BLOCK
PROJECTILE_HIT_ENTITY
SERVER_PING
SPAWNED_ENTITY
SPAWNED_MONSTER
SPAWNING_ENTITY
SPAWNING_MONSTER
TAKE_DAMAGE
TICK
UPDATED_SIGN
UPDATING_SIGN
WEATHER_CHANGED
WEATHER_CHANGING
WORLD_STARTED
WORLD_TICK

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 MyOnPlayerUsingBlock(Player, BlockX, BlockY, BlockZ, BlockFace, CursorX, CursorY, CursorZ, BlockType, BlockMeta)

Parameters:

NameTypeNotes
PlayercPlayerThe player who is using the block
BlockXnumberX-coord of the clicked block
BlockYnumberY-coord of the clicked block
BlockZnumberZ-coord of the clicked block
BlockFacenumberFace of clicked block which has been clicked. One of the BLOCK_FACE_ constants
CursorXnumberX-coord of the cursor crosshair on the block being clicked
CursorYnumberY-coord of the cursor crosshair on the block being clicked
CursorZnumberZ-coord of the cursor crosshair on the block being clicked
BlockTypenumberBlock type of the clicked block
BlockMetanumberBlock meta of the clicked block

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);
Generated on 2017-05-27 01:00:06, Build ID Unknown, Commit approx: 73a3c4e3be1916bdd4830e7ce7454035a1f572f6