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 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
void	setKickMessage (const std::string & message)
	~PlayerLoginEvent () 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 () override 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) override 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::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 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