Class endstone::ScriptMessageEvent

ClassList > endstone > ScriptMessageEvent

Called when a message is sent by /scriptevent command.

• #include <endstone/event/server/script_message_event.h>

Inherits the following classes: endstone::ServerEvent

Public Static Attributes

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

Public Functions

Type	Name
	ScriptMessageEvent (std::string message_id, std::string message, const CommandSender & sender)
virtual std::string	getEventName () override const
const std::string &	getMessage () const
const std::string &	getMessageId () const
const CommandSender &	getSender () const
virtual bool	isCancellable () override const

Public Functions inherited from endstone::ServerEvent

See endstone::ServerEvent

Type	Name
	Event (bool async=false)
	Event (const Event &) = delete

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::ScriptMessageEvent::NAME;

---

Public Functions Documentation

function ScriptMessageEvent

inline endstone::ScriptMessageEvent::ScriptMessageEvent (
    std::string message_id,
    std::string message,
    const CommandSender & sender
) 

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getMessage

inline const std::string & endstone::ScriptMessageEvent::getMessage () const

Get the message to send.

Returns:

Message to send

---

function getMessageId

inline const std::string & endstone::ScriptMessageEvent::getMessageId () const

Get the message id to send.

Returns:

Message id to send

---

function getSender

inline const CommandSender & endstone::ScriptMessageEvent::getSender () const

Gets the command sender who initiated the command

Returns:

Command sender who initiated the command

---

function isCancellable

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

---

---

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