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 Static Attributes

Type	Name
const std::string	NAME = "BlockBreakEvent"

Public Functions

Type	Name
	BlockBreakEvent (std::unique_ptr< Block > block, Player & player)
virtual std::string	getEventName () override const
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. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual bool	isCancelled () override const Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.
virtual void	setCancelled (bool cancel) override Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0
virtual bool	isCancelled () const = 0
virtual void	setCancelled (bool cancel) = 0
virtual	~ICancellable () = default

Detailed Description

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

Public Static Attributes Documentation

variable NAME

const std::string endstone::BlockBreakEvent::NAME;

---

Public Functions Documentation

function BlockBreakEvent

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

---

function getEventName

inline virtual std::string endstone::BlockBreakEvent::getEventName () override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

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