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::Cancellable, endstone::PlayerBedLeaveEvent, endstone::PlayerDimensionChangeEvent, endstone::PlayerExpChangeEvent, endstone::PlayerHideActorEvent, endstone::PlayerInputEvent, endstone::PlayerJoinEvent, endstone::PlayerLevelChangeEvent, endstone::PlayerQuitEvent, endstone::PlayerRecipeBookSettingsChangeEvent, endstone::PlayerRespawnEvent, endstone::PlayerRiptideEvent, endstone::PlayerShowActorEvent, endstone::PlayerToggleCrawlEvent, endstone::PlayerToggleFlightEvent, endstone::PlayerToggleSneakEvent, endstone::PlayerToggleSprintEvent

Public Functions

Type	Name
	PlayerEvent (const NotNull< Player > & player)
const NotNull< Player > &	getPlayer () const Returns the player involved in this event.
	~PlayerEvent () override

Public Functions inherited from endstone::Event

See endstone::Event

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete
	Event (Event &&) = default
virtual std::string	getEventName () const = 0 Gets a user-friendly identifier for this event.
bool	isAsynchronous () const Any custom event that should not by synchronized with other events must use the specific constructor.
Event &	operator= (const Event &) = delete
Event &	operator= (Event &&) = default
virtual	~Event () = default

Protected Attributes

Type	Name
NotNull< Player >	player_

Public Functions Documentation

function PlayerEvent

inline explicit endstone::PlayerEvent::PlayerEvent (
    const  NotNull < Player > & player
) 

---

function getPlayer

Returns the player involved in this event.

inline const  NotNull < Player > & endstone::PlayerEvent::getPlayer () const

Returns:

Player who is involved in this event

---

function ~PlayerEvent

endstone::PlayerEvent::~PlayerEvent () override

---

Protected Attributes Documentation

variable player_

NotNull<Player> endstone::PlayerEvent::player_;

---

---

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