Class endstone::PlayerLoginEvent

ClassList > endstone > PlayerLoginEvent

Called when a player attempts to login in.

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

Inherits the following classes: endstone::Cancellable

Public Functions

Type	Name
	ENDSTONE_EVENT (PlayerLoginEvent)
	PlayerLoginEvent (Player & player, std::string message="")
const std::string &	getKickMessage () const Gets the current kick message that will be used if event is cancelled.
void	setKickMessage (const std::string & message) Sets the kick message to display if event is cancelled.
	~PlayerLoginEvent () override

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::PlayerLoginEvent::ENDSTONE_EVENT (
    PlayerLoginEvent
) 

---

function PlayerLoginEvent

inline explicit endstone::PlayerLoginEvent::PlayerLoginEvent (
    Player & player,
    std::string message=""
) 

---

function getKickMessage

Gets the current kick message that will be used if event is cancelled.

inline const std::string & endstone::PlayerLoginEvent::getKickMessage () const

Returns:

Current kick message

---

function setKickMessage

Sets the kick message to display if event is cancelled.

inline void endstone::PlayerLoginEvent::setKickMessage (
    const std::string & message
) 

Parameters:

• message New kick message

---

function ~PlayerLoginEvent

endstone::PlayerLoginEvent::~PlayerLoginEvent () override

---

---

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