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

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
void	setCommand (std::string command)
	~PlayerCommandEvent () override

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