Class endstone::PacketReceiveEvent

ClassList > endstone > PacketReceiveEvent

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

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

Inherits the following classes: endstone::Cancellable

Public Static Attributes

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

Public Functions

Type	Name
	PacketReceiveEvent (Player & player, int packet_id, std::string_view payload)
virtual std::string	getEventName () override const
int	getPacketId () const Gets the ID of the packet.
std::string_view	getPayload () const Gets the raw packet data excluding the header.
Player &	getPlayer () const
void	setPayload (std::string_view payload) Sets the raw packet data excluding the header.

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

---

Public Functions Documentation

function PacketReceiveEvent

inline endstone::PacketReceiveEvent::PacketReceiveEvent (
    Player & player,
    int packet_id,
    std::string_view payload
) 

---

function getEventName

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

Gets a user-friendly identifier for this event.

Returns:

name of this event

Implements endstone::Event::getEventName

---

function getPacketId

Gets the ID of the packet.

inline int endstone::PacketReceiveEvent::getPacketId () const

Returns:

The packet ID.

---

function getPayload

Gets the raw packet data excluding the header.

inline std::string_view endstone::PacketReceiveEvent::getPayload () const

Returns:

The packet payload data.

---

function getPlayer

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

Returns the player involved in this event

Returns:

Player who is involved in this event

---

function setPayload

Sets the raw packet data excluding the header.

inline void endstone::PacketReceiveEvent::setPayload (
    std::string_view payload
) 

Returns:

The packet payload data.

---

---

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