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 Functions

Type	Name
	ENDSTONE_EVENT (PlayerKickEvent)
	PlayerKickEvent (Player & player, std::string reason)
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.

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 ENDSTONE_EVENT

endstone::PlayerKickEvent::ENDSTONE_EVENT (
    PlayerKickEvent
) 

---

function PlayerKickEvent

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

---

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

---

---

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