Class endstone::BlockBreakEvent

ClassList > endstone > BlockBreakEvent

Called when a block is broken by a player. More...

• #include <endstone/event/block/block_break_event.h>

Inherits the following classes: endstone::Cancellable

Public Functions

Type	Name
	BlockBreakEvent (std::unique_ptr< Block > block, Player & player)
	ENDSTONE_EVENT (BlockBreakEvent)
Player &	getPlayer () const Gets the Player that is breaking the block involved in this event.
	~BlockBreakEvent () override

Public Functions inherited from endstone::Cancellable

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event.
virtual bool	isCancelled () override const Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) override Sets the cancellation state of this event.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0 Cancels this event.
virtual bool	isCancelled () const = 0 Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) = 0 Sets the cancellation state of this event.
virtual	~ICancellable () = default

Detailed Description

If a BlockBreakEvent is cancelled, the block will not break and experience will not drop.

Public Functions Documentation

function BlockBreakEvent

inline explicit endstone::BlockBreakEvent::BlockBreakEvent (
    std::unique_ptr< Block > block,
    Player & player
) 

---

function ENDSTONE_EVENT

endstone::BlockBreakEvent::ENDSTONE_EVENT (
    BlockBreakEvent
) 

---

function getPlayer

Gets the Player that is breaking the block involved in this event.

inline Player & endstone::BlockBreakEvent::getPlayer () const

Returns:

The Player that is breaking the block involved in this event

---

function ~BlockBreakEvent

endstone::BlockBreakEvent::~BlockBreakEvent () override

---

---

The documentation for this class was generated from the following file include/endstone/event/block/block_break_event.h