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::Cancellable

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.
void	setReason (std::string reason) Sets the reason why the player is getting kicked.
	~PlayerKickEvent () override

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 () 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) 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 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 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