HOOK_PLAYER_BREAKING_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 breaks a block, before the block is actually broken in the World. Plugins may refuse the breaking.

See also the HOOK_PLAYER_BROKEN_BLOCK hook for a similar hook called after the block is broken.


Callback function

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

function OnPlayerBreakingBlock(Player, BlockX, BlockY, BlockZ, BlockFace, BlockType, BlockMeta)

Parameters:

NameTypeNotes
PlayercPlayerThe player who is digging the block
BlockXnumberX-coord of the block
BlockYnumberY-coord of the block
BlockZnumberZ-coord of the block
BlockFacenumberFace of the block upon which the player is acting. One of the BLOCK_FACE_ constants
BlockTypeBLOCKTYPEThe block type of the block being broken
BlockMetaNIBBLETYPEThe block meta of the block being broken

If the function returns false or no value, other plugins' callbacks are called, and then the block is broken. If the function returns true, no other plugin's callback is called and the block breaking is cancelled. The server re-sends the block back to the player to replace it (the player's client already thinks the block was broken).


Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_PLAYER_BREAKING_BLOCK, MyOnPlayerBreakingBlock);
Generated on 2017-02-20 13:00:36, Build ID Unknown, Commit approx: 9cb1ad546f09066cd9949fd0e4fa7fd2e54dd519