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 Functions

Type	Name
	ENDSTONE_EVENT (ScriptMessageEvent)
	ScriptMessageEvent (std::string message_id, std::string message, const CommandSender & sender)
const std::string &	getMessage () const Get the message to send.
const std::string &	getMessageId () const Get the message id to send.
const CommandSender &	getSender () const Gets the command sender who sent the script message.

Public Functions inherited from endstone::Cancellable

See endstone::Cancellable

Type	Name
virtual void	cancel () Cancel this event.
virtual bool	isCancelled () override const Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) override Sets the cancellation state of this event.

Public Functions inherited from endstone::ICancellable

See endstone::ICancellable

Type	Name
virtual void	cancel () = 0 Cancels this event.
virtual bool	isCancelled () const = 0 Gets the cancellation state of this event.
virtual void	setCancelled (bool cancel) = 0 Sets the cancellation state of this event.
virtual	~ICancellable () = default

Public Functions Documentation

function ENDSTONE_EVENT

endstone::ScriptMessageEvent::ENDSTONE_EVENT (
    ScriptMessageEvent
) 

---

function ScriptMessageEvent

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

---

function getMessage

Get the message to send.

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

Returns:

Message to send

---

function getMessageId

Get the message id to send.

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

Returns:

Message id to send

---

function getSender

Gets the command sender who sent the script message.

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

Returns:

Command sender who sent the script message.

---

---

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