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, const int packet_id, std::string_view payload, SocketAddress address, const int sub_client_id)
SocketAddress	getAddress () const Gets the network address to which this packet is being sent.
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 Returns the player involved in this event.
int	getSubClientId () const Gets the SubClient ID.
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,
    const int packet_id,
    std::string_view payload,
    SocketAddress address,
    const int sub_client_id
)

function getAddress¶

Gets the network address to which this packet is being sent.

inline SocketAddress endstone::PacketReceiveEvent::getAddress () const

Returns:

The SocketAddress of the destination client.

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¶

Returns the player involved in this event.

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

Note:

This may return nullptr if the packet is sent before the player completes the login process.

Returns:

Player who is involved in this event

function getSubClientId¶

Gets the SubClient ID.

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

Note:

Range is 0 to 3 (0 = primary client; 1-3 = split-screen clients).

Returns:

The SubClient ID.

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