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

Public Static Attributes

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

Public Functions

Type	Name
	PlayerLoginEvent (Player & player, std::string message="")
virtual std::string	getEventName () override const
const std::string &	getKickMessage () const
virtual bool	isCancellable () override const
void	setKickMessage (const std::string & message)
	~PlayerLoginEvent () 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::PlayerLoginEvent::NAME;

---

Public Functions Documentation

function PlayerLoginEvent

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

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getKickMessage

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

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

Returns:

Current kick message

---

function isCancellable

inline virtual bool endstone::PlayerLoginEvent::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 setKickMessage

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

Sets the kick message to display if event is cancelled

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