Quest history / progress reply. More...

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

Classes
class	PageDataProgress
	Data associated with page value Progress. More...
class	PageDataHistory
	Data associated with page value History. More...

Public Types
using	PageData = std::variant<std::monostate, PageDataProgress, PageDataHistory>
	Data associated with different values of the page field.

Public Member Functions
const PageDataProgress *	AsProgress () const noexcept
	Gets the data associated with page value Progress.
PageDataProgress *	AsProgress () noexcept
	Gets the data associated with page value Progress.
const PageDataHistory *	AsHistory () const noexcept
	Gets the data associated with page value History.
PageDataHistory *	AsHistory () noexcept
	Gets the data associated with page value History.
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 QuestListServerPacket &other) const
	Compares this object with another for equality.
bool	operator!= (const QuestListServerPacket &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 QuestListServerPacket	ForProgress (PageDataProgress data)
	Creates a new QuestListServerPacket with page set to Progress.
static QuestListServerPacket	ForHistory (PageDataHistory data)
	Creates a new QuestListServerPacket with page set to History.

Public Attributes
net::QuestPage	page {}
int	quests_count {}
PageData	page_data {}
	Data associated with the page field.

Static Public Attributes
static constexpr PacketFamily	FAMILY = PacketFamily::Quest
	The packet family associated with this packet.
static constexpr PacketAction	ACTION = PacketAction::List
	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

Quest history / progress reply.

Member Typedef Documentation

◆ PageData

using eolib::protocol::net::server::QuestListServerPacket::PageData = std::variant<std::monostate, PageDataProgress, PageDataHistory>

Data associated with different values of the page field.

Member Function Documentation

◆ AsProgress() [1/2]

const PageDataProgress * eolib::protocol::net::server::QuestListServerPacket::AsProgress ( ) const

inlinenoexcept

Gets the data associated with page value Progress.

Returns: the data, or nullptr if page_data holds the data for a different value.

◆ AsProgress() [2/2]

PageDataProgress * eolib::protocol::net::server::QuestListServerPacket::AsProgress ( )

inlinenoexcept

Gets the data associated with page value Progress.

Returns: the data, or nullptr if page_data holds the data for a different value.

◆ AsHistory() [1/2]

const PageDataHistory * eolib::protocol::net::server::QuestListServerPacket::AsHistory ( ) const

inlinenoexcept

Gets the data associated with page value History.

Returns: the data, or nullptr if page_data holds the data for a different value.

◆ AsHistory() [2/2]

PageDataHistory * eolib::protocol::net::server::QuestListServerPacket::AsHistory ( )

inlinenoexcept

Gets the data associated with page value History.

Returns: the data, or nullptr if page_data holds the data for a different value.

◆ ForProgress()

QuestListServerPacket eolib::protocol::net::server::QuestListServerPacket::ForProgress ( PageDataProgress data )

static

Creates a new QuestListServerPacket with page set to Progress.

Parameters

data	the data associated with page Progress.

Returns: the created object.

◆ ForHistory()

QuestListServerPacket eolib::protocol::net::server::QuestListServerPacket::ForHistory ( PageDataHistory data )

static

Creates a new QuestListServerPacket with page set to History.

Parameters

data	the data associated with page History.

Returns: the created object.

◆ Family()

PacketFamily eolib::protocol::net::server::QuestListServerPacket::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::QuestListServerPacket::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::QuestListServerPacket::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::QuestListServerPacket::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::QuestListServerPacket::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::QuestListServerPacket::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::QuestListServerPacket::operator== ( const QuestListServerPacket & 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::QuestListServerPacket::operator!= ( const QuestListServerPacket & 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::QuestListServerPacket::FAMILY = PacketFamily::Quest

staticconstexpr

The packet family associated with this packet.

◆ ACTION

PacketAction eolib::protocol::net::server::QuestListServerPacket::ACTION = PacketAction::List

staticconstexpr

The packet action associated with this packet.

◆ page

net::QuestPage eolib::protocol::net::server::QuestListServerPacket::page {}

◆ quests_count

int eolib::protocol::net::server::QuestListServerPacket::quests_count {}

Note

Value range is 0-64008.

◆ page_data

PageData eolib::protocol::net::server::QuestListServerPacket::page_data {}

Data associated with the page field.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PageData

Member Function Documentation

◆ AsProgress() [1/2]

◆ AsProgress() [2/2]

◆ AsHistory() [1/2]

◆ AsHistory() [2/2]

◆ ForProgress()

◆ ForHistory()

◆ Family()

◆ Action()

◆ ByteSize()

◆ Serialize()

◆ Deserialize()

◆ ToString()

◆ operator==()

◆ operator!=()

Member Data Documentation

◆ FAMILY

◆ ACTION

◆ page

◆ quests_count

◆ page_data