Skip to content

Class endstone::InventoryInteractEvent

ClassList > endstone > InventoryInteractEvent

An abstract base class for events that describe an interaction between a Player and the contents of anInventory .

  • #include <endstone/event/inventory/inventory_interact_event.h>

Inherits the following classes: endstone::Cancellable

Public Functions

Type Name
InventoryInteractEvent (Inventory & inventory, const NotNull< Player > & who_clicked)
const NotNull< Player > & getWhoClicked () const
Gets the player who performed the click.

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

Public Functions Documentation

function InventoryInteractEvent

inline endstone::InventoryInteractEvent::InventoryInteractEvent (
    Inventory & inventory,
    const  NotNull < Player > & who_clicked
) 

function getWhoClicked

Gets the player who performed the click.

inline const  NotNull < Player > & endstone::InventoryInteractEvent::getWhoClicked () const

Returns:

The clicking player



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