Class endstone::PlayerKickEvent

ClassList > endstone > PlayerKickEvent

Called when a player gets kicked from the server.

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

Inherits the following classes: endstone::PlayerEvent

Public Static Attributes

Type	Name
const std::string	NAME = = "PlayerKickEvent"

Public Functions

Type	Name
	PlayerKickEvent (Player & player, std::string reason)
virtual std::string	getEventName () override const
std::string	getReason () const Gets the reason why the player is getting kicked.
virtual bool	isCancellable () override const
void	setReason (std::string reason) Sets the reason why the player is getting kicked.
	~PlayerKickEvent () override

Public Functions inherited from endstone::PlayerEvent

See endstone::PlayerEvent

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 Static Attributes Documentation

variable NAME

const std::string endstone::PlayerKickEvent::NAME;

---

Public Functions Documentation

function PlayerKickEvent

inline explicit endstone::PlayerKickEvent::PlayerKickEvent (
    Player & player,
    std::string reason
) 

---

function getEventName

inline virtual std::string endstone::PlayerKickEvent::getEventName () override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getReason

Gets the reason why the player is getting kicked.

inline std::string endstone::PlayerKickEvent::getReason () const

Returns:

string kick reason

---

function isCancellable

inline virtual bool endstone::PlayerKickEvent::isCancellable () override const

Whether the event can be cancelled by a plugin or the server.

Returns:

true if this event can be cancelled

Implements endstone::Event::isCancellable

---

function setReason

Sets the reason why the player is getting kicked.

inline void endstone::PlayerKickEvent::setReason (
    std::string reason
) 

Parameters:

• reason kick reason

---

function ~PlayerKickEvent

endstone::PlayerKickEvent::~PlayerKickEvent () override

---

---

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