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

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

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

---

---

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