eolib::protocol::net::server::OnlinePlayer Class Reference

A player in the online list. More...

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

Inherits eolib::protocol::Serializable.

Public Member Functions
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 OnlinePlayer &other) const
	Compares this object with another for equality.
bool	operator!= (const OnlinePlayer &other) const
	Compares this object with another for inequality.
Public Member Functions inherited from eolib::protocol::Serializable
virtual	~Serializable ()=default

Public Attributes
std::string	name {}
std::string	title {}
int	level {}
CharacterIcon	icon {}
int	class_id {}
std::string	guild_tag {}

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

A player in the online list.

Member Function Documentation

ByteSize()

int eolib::protocol::net::server::OnlinePlayer::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::OnlinePlayer::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::OnlinePlayer::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::OnlinePlayer::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::OnlinePlayer::operator==

(

const OnlinePlayer &

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::OnlinePlayer::operator!=

(

const OnlinePlayer &

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

name

std::string eolib::protocol::net::server::OnlinePlayer::name {}

title

std::string eolib::protocol::net::server::OnlinePlayer::title {}

level

int eolib::protocol::net::server::OnlinePlayer::level {}

Note

• Value range is 0-252.

icon

CharacterIcon eolib::protocol::net::server::OnlinePlayer::icon {}

class_id

int eolib::protocol::net::server::OnlinePlayer::class_id {}

Note

• Value range is 0-252.

guild_tag

std::string eolib::protocol::net::server::OnlinePlayer::guild_tag {}