Class endstone::ServerCommandEvent

ClassList > endstone > ServerCommandEvent

Called when the console runs a command, early in the process. More...

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

Inherits the following classes: endstone::ServerEvent

Public Static Attributes

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

Public Functions

Type	Name
	ServerCommandEvent (CommandSender & sender, std::string command)
std::string	getCommand () const
virtual std::string	getEventName () override const
CommandSender &	getSender () const
virtual bool	isCancellable () override const
void	setCommand (std::string message)

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

Detailed Description

You should not use this except for a few cases like logging commands, blocking commands on certain places, or applying modifiers.

The command message contains a slash '/' at the start

Public Static Attributes Documentation

variable NAME

const std::string endstone::ServerCommandEvent::NAME;

---

Public Functions Documentation

function ServerCommandEvent

inline endstone::ServerCommandEvent::ServerCommandEvent (
    CommandSender & sender,
    std::string command
) 

---

function getCommand

inline std::string endstone::ServerCommandEvent::getCommand () const

Gets the command that the server is attempting to execute from the console

Returns:

Command the server is attempting to execute

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getSender

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

Get the command sender.

Returns:

The sender

---

function isCancellable

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

---

function setCommand

inline void endstone::ServerCommandEvent::setCommand (
    std::string message
) 

Sets the command that the server will execute

Parameters:

• message New message that the server will execute

---

---

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