Skip to Content
⚠ Under Construction
ReferenceC++ APIPlayerLoginEvent

endstone::PlayerLoginEvent

Called when a player attempts to login in.

Bases: endstone::Cancellable< PlayerEvent >

Attributes:

NameDescription
NAME

Functions:

NAME

const std::string endstone::PlayerLoginEvent::NAME;

PlayerLoginEvent

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

getEventName

std::string getEventName() override const

Gets a user-friendly identifier for this event.

Returns:

name of this event

getKickMessage

const std::string &getKickMessage() const

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

Returns:

Current kick message

setKickMessage

void setKickMessage(const std::string &message)

Sets the kick message to display if event is cancelled

Parameters:

  • message New kick message
Last updated on