Class endstone::PlayerChatEvent

ClassList > endstone > PlayerChatEvent

Called when a player sends a chat message.

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

Inherits the following classes: endstone::Cancellable

Public Static Attributes

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

Public Functions

Type	Name
	PlayerChatEvent (Player & player, std::string message)
virtual std::string	getEventName () override const
std::string	getMessage () const
void	setMessage (std::string message)
	~PlayerChatEvent () 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 () 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) 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::PlayerChatEvent::NAME;

---

Public Functions Documentation

function PlayerChatEvent

inline explicit endstone::PlayerChatEvent::PlayerChatEvent (
    Player & player,
    std::string message
) 

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getMessage

inline std::string endstone::PlayerChatEvent::getMessage () const

Gets the message that the player is attempting to send.

Returns:

Message the player is attempting to send

---

function setMessage

inline void endstone::PlayerChatEvent::setMessage (
    std::string message
) 

Sets the message that the player will send.

Parameters:

• message New message that the player will send

---

function ~PlayerChatEvent

endstone::PlayerChatEvent::~PlayerChatEvent () override

---

---

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