Skip to content

Class endstone::BlockPistonEvent

ClassList > endstone > BlockPistonEvent

Called when a piston block is triggered.

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

Inherits the following classes: endstone::Cancellable

Inherited by the following classes: endstone::BlockPistonExtendEvent, endstone::BlockPistonRetractEvent

Public Functions

Type Name
BlockPistonEvent (std::unique_ptr< Block > block, BlockFace direction)
BlockFace getDirection () const
Return the direction in which the piston will operate.

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

Public Functions Documentation

function BlockPistonEvent

inline explicit endstone::BlockPistonEvent::BlockPistonEvent (
    std::unique_ptr< Block > block,
    BlockFace direction
) 

function getDirection

Return the direction in which the piston will operate.

inline BlockFace endstone::BlockPistonEvent::getDirection () const

Returns:

direction of the piston



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