eolib::protocol::net::server::EffectUseServerPacket Class Reference

Map effect. More...

#include <eolib/protocol/net/server/packets.hpp>

Inherits eolib::protocol::net::Packet.

Classes
class	EffectDataQuake
	Data associated with effect value Quake. More...

Public Types
using	EffectData = std::variant<std::monostate, EffectDataQuake>
	Data associated with different values of the effect field.

Public Member Functions
const EffectDataQuake *	AsQuake () const noexcept
	Gets the data associated with effect value Quake.
EffectDataQuake *	AsQuake () noexcept
	Gets the data associated with effect value Quake.
PacketFamily	Family () const noexcept override
	Gets the packet family associated with this packet.
PacketAction	Action () const noexcept override
	Gets the packet action associated with this packet.
int	ByteSize () const noexcept override
	Gets the size of the data that this object was deserialized from.
void	Serialize (data::EoWriter &writer) const override
	Serializes this object to the provided writer.
void	Deserialize (data::EoReader &reader) override
	Deserializes this object from the provided reader, replacing its current data.
std::string	ToString () const override
	Gets a human-readable representation of this object, for debugging purposes.
bool	operator== (const EffectUseServerPacket &other) const
	Compares this object with another for equality.
bool	operator!= (const EffectUseServerPacket &other) const
	Compares this object with another for inequality.
Public Member Functions inherited from eolib::protocol::Serializable
virtual	~Serializable ()=default

Static Public Member Functions
static EffectUseServerPacket	ForQuake (EffectDataQuake data)
	Creates a new EffectUseServerPacket with effect set to Quake.

Public Attributes
MapEffect	effect {}
EffectData	effect_data {}
	Data associated with the effect field.

Static Public Attributes
static constexpr PacketFamily	FAMILY = PacketFamily::Effect
	The packet family associated with this packet.
static constexpr PacketAction	ACTION = PacketAction::Use
	The packet action associated with this packet.

Additional Inherited Members
Protected Member Functions inherited from eolib::protocol::Serializable
	Serializable ()=default
	Serializable (const Serializable &)=default
	Serializable (Serializable &&)=default
Serializable &	operator= (const Serializable &)=default
Serializable &	operator= (Serializable &&)=default

Detailed Description

Map effect.

Member Typedef Documentation

EffectData

using eolib::protocol::net::server::EffectUseServerPacket::EffectData = std::variant<std::monostate, EffectDataQuake>

Data associated with different values of the effect field.

Member Function Documentation

AsQuake() [1/2]

const EffectDataQuake * eolib::protocol::net::server::EffectUseServerPacket::AsQuake ( ) const

inlinenoexcept

Gets the data associated with effect value Quake.

Returns

the data, or nullptr if effect_data holds the data for a different value.

AsQuake() [2/2]

EffectDataQuake * eolib::protocol::net::server::EffectUseServerPacket::AsQuake ( )

inlinenoexcept

Gets the data associated with effect value Quake.

Returns

the data, or nullptr if effect_data holds the data for a different value.

ForQuake()

EffectUseServerPacket eolib::protocol::net::server::EffectUseServerPacket::ForQuake ( EffectDataQuake data )

static

Creates a new EffectUseServerPacket with effect set to Quake.

Parameters

data	the data associated with effect Quake.

Returns

the created object.

Family()

PacketFamily eolib::protocol::net::server::EffectUseServerPacket::Family ( ) const

inlineoverridevirtualnoexcept

Gets the packet family associated with this packet.

Returns

the packet family.

Implements eolib::protocol::net::Packet.

Action()

PacketAction eolib::protocol::net::server::EffectUseServerPacket::Action ( ) const

inlineoverridevirtualnoexcept

Gets the packet action associated with this packet.

Returns

the packet action.

Implements eolib::protocol::net::Packet.

ByteSize()

int eolib::protocol::net::server::EffectUseServerPacket::ByteSize ( ) const

overridevirtualnoexcept

Gets the size of the data that this object was deserialized from.

Returns

the deserialized size in bytes, or 0 for an object that was not deserialized.

Implements eolib::protocol::Serializable.

Serialize()

void eolib::protocol::net::server::EffectUseServerPacket::Serialize ( data::EoWriter & writer ) const

overridevirtual

Serializes this object to the provided writer.

Parameters

writer

the writer that the data will be written to.

Exceptions

SerializationError

if the object's data is invalid for serialization.

Implements eolib::protocol::Serializable.

Deserialize()

void eolib::protocol::net::server::EffectUseServerPacket::Deserialize ( data::EoReader & reader )

overridevirtual

Deserializes this object from the provided reader, replacing its current data.

Parameters

reader

the reader that the data will be read from.

Implements eolib::protocol::Serializable.

ToString()

std::string eolib::protocol::net::server::EffectUseServerPacket::ToString ( ) const

overridevirtual

Gets a human-readable representation of this object, for debugging purposes.

Returns

the object's fields and values, as a string.

Implements eolib::protocol::Serializable.

operator==()

bool eolib::protocol::net::server::EffectUseServerPacket::operator==

(

const EffectUseServerPacket &

other

)

const

Compares this object with another for equality.

The deserialized byte size is not compared.

Parameters

other

the object to compare with.

Returns

true if all fields are equal, otherwise false.

operator!=()

bool eolib::protocol::net::server::EffectUseServerPacket::operator!=

(

const EffectUseServerPacket &

other

)

const

Compares this object with another for inequality.

The deserialized byte size is not compared.

Parameters

other

the object to compare with.

Returns

true if any field differs, otherwise false.

Member Data Documentation

FAMILY

PacketFamily eolib::protocol::net::server::EffectUseServerPacket::FAMILY = PacketFamily::Effect

staticconstexpr

The packet family associated with this packet.

ACTION

PacketAction eolib::protocol::net::server::EffectUseServerPacket::ACTION = PacketAction::Use

staticconstexpr

The packet action associated with this packet.

effect

MapEffect eolib::protocol::net::server::EffectUseServerPacket::effect {}

effect_data

EffectData eolib::protocol::net::server::EffectUseServerPacket::effect_data {}

Data associated with the effect field.