Class endstone::BlockPlaceEvent¶

ClassList > endstone > BlockPlaceEvent

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

#include <endstone/event/block/block_place_event.h>

Inherits the following classes: endstone::Cancellable

Public Static Attributes¶

Type	Name
const std::string	NAME = `"BlockPlaceEvent"`

Public Functions¶

Type	Name
	BlockPlaceEvent (std::unique_ptr< BlockState > placed_block, std::shared_ptr< Block > replaced_block, std::shared_ptr< Block > placed_against, Player & player)
Block &	getBlockAgainst () const Gets the block that this block was placed against.
BlockState &	getBlockPlacedState () const Gets the BlockState for the block which was placed.
Block &	getBlockReplaced () const Gets the block which was replaced.
virtual std::string	getEventName () override const
Player &	getPlayer () const Gets the player who placed the block involved in this event.
	~BlockPlaceEvent () 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 () 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) 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 BlockPlaceEvent is cancelled, the block will not be placed.

Public Static Attributes Documentation¶

variable NAME¶

const std::string endstone::BlockPlaceEvent::NAME;

Public Functions Documentation¶

function BlockPlaceEvent¶

inline explicit endstone::BlockPlaceEvent::BlockPlaceEvent (
    std::unique_ptr< BlockState > placed_block,
    std::shared_ptr< Block > replaced_block,
    std::shared_ptr< Block > placed_against,
    Player & player
)

function getBlockAgainst¶

Gets the block that this block was placed against.

inline Block & endstone::BlockPlaceEvent::getBlockAgainst () const

Returns:

Block the block that the new block was placed against

function getBlockPlacedState¶

Gets the BlockState for the block which was placed.

inline BlockState & endstone::BlockPlaceEvent::getBlockPlacedState () const

Returns:

The BlockState for the block which was placed.

function getBlockReplaced¶

Gets the block which was replaced.

inline Block & endstone::BlockPlaceEvent::getBlockReplaced () const

Returns:

The Block which was replaced.

function getEventName¶

inline virtual std::string endstone::BlockPlaceEvent::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 who placed the block involved in this event.

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

Returns:

The Player who placed the block involved in this event

function ~BlockPlaceEvent¶

endstone::BlockPlaceEvent::~BlockPlaceEvent () override

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