Class endstone::PlayerCommandEvent

ClassList > endstone > PlayerCommandEvent

Called whenever a player runs a command.

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

Inherits the following classes: endstone::PlayerEvent

Public Static Attributes

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

Public Functions

Type	Name
	PlayerCommandEvent (Player & player, std::string command)
std::string	getCommand () const
virtual std::string	getEventName () override const
virtual bool	isCancellable () override const
void	setCommand (std::string command)
	~PlayerCommandEvent () override

Public Functions inherited from endstone::PlayerEvent

See endstone::PlayerEvent

Type	Name
	PlayerEvent (Player & player)
Player &	getPlayer () const
	~PlayerEvent () override

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

---

Public Functions Documentation

function PlayerCommandEvent

inline explicit endstone::PlayerCommandEvent::PlayerCommandEvent (
    Player & player,
    std::string command
) 

---

function getCommand

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

Gets the command that the player is attempting to send.

Returns:

Command the player is attempting to send

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function isCancellable

inline virtual bool endstone::PlayerCommandEvent::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::PlayerCommandEvent::setCommand (
    std::string command
) 

Sets the command that the player will send.

Parameters:

• command New command that the player will send

---

function ~PlayerCommandEvent

endstone::PlayerCommandEvent::~PlayerCommandEvent () override

---

---

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