Class endstone::DataPacketReceiveEvent

ClassList > endstone > DataPacketReceiveEvent

Called when the server receives a packet from a connected client.

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

Inherits the following classes: endstone::Cancellable

Public Static Attributes

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

Public Functions

Type	Name
	DataPacketReceiveEvent (Player & player, std::string_view data)
std::string_view	getData () const Gets the raw packet data.
virtual std::string	getEventName () override const
Player &	getPlayer () 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::DataPacketReceiveEvent::NAME;

---

Public Functions Documentation

function DataPacketReceiveEvent

inline endstone::DataPacketReceiveEvent::DataPacketReceiveEvent (
    Player & player,
    std::string_view data
) 

---

function getData

Gets the raw packet data.

inline std::string_view endstone::DataPacketReceiveEvent::getData () const

Returns:

The packet data.

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getPlayer

inline Player & endstone::DataPacketReceiveEvent::getPlayer () const

Returns the player involved in this event

Returns:

Player who is involved in this event

---

---

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