Skip to content

Class endstone::PlayerEvent

ClassList > endstone > PlayerEvent

Represents a player related event.

  • #include <endstone/event/player/player_event.h>

Inherits the following classes: endstone::Event

Inherited by the following classes: endstone::PlayerChatEvent, endstone::PlayerCommandEvent, endstone::PlayerDeathEvent, endstone::PlayerInteractActorEvent, endstone::PlayerInteractEvent, endstone::PlayerJoinEvent, endstone::PlayerKickEvent, endstone::PlayerLoginEvent, endstone::PlayerQuitEvent, endstone::PlayerTeleportEvent

Public Functions

Type Name
PlayerEvent (Player & player)
Player & getPlayer () const
~PlayerEvent () override

Public Functions inherited from endstone::Event

See endstone::Event

Type Name
Event (bool async=false)
Event (const Event &) = delete
virtual std::string getEventName () const = 0
bool isAsynchronous () const
virtual bool isCancellable () const = 0
bool isCancelled () const
Event & operator= (const Event &) = delete
void setCancelled (bool cancel)
virtual ~Event () = default

Public Functions Documentation

function PlayerEvent

inline explicit endstone::PlayerEvent::PlayerEvent (
    Player & player
) 

function getPlayer

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

Returns the player involved in this event

Returns:

Player who is involved in this event


function ~PlayerEvent

endstone::PlayerEvent::~PlayerEvent () override


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