Source code for eolib.protocol.net.server.online_player

# Generated from the eo-protocol XML specification.
#
# This file should not be modified.
# Changes will be lost when code is regenerated.

from .character_icon import CharacterIcon
from ....serialization_error import SerializationError
from .....data.eo_writer import EoWriter
from .....data.eo_reader import EoReader



class OnlinePlayer:
    """
    A player in the online list
    """
    _byte_size: int = 0
    _name: str
    _title: str
    _level: int
    _icon: CharacterIcon
    _class_id: int
    _guild_tag: str



    def __init__(self, *, name: str, title: str, level: int, icon: CharacterIcon, class_id: int, guild_tag: str):
        """
        Create a new instance of OnlinePlayer.

        Args:
            name: 
            title: 
            level: (Value range is 0-252.)
            icon: 
            class_id: (Value range is 0-252.)
            guild_tag: 
        """
        self._name = name
        self._title = title
        self._level = level
        self._icon = icon
        self._class_id = class_id
        self._guild_tag = guild_tag


    @property
    def byte_size(self) -> int:
        """
        The size of the data that this was deserialized from.
        """
        return self._byte_size

    @property
    def name(self) -> str:
        """
        The `name` field.
        """
        return self._name

    @property
    def title(self) -> str:
        """
        The `title` field.
        """
        return self._title

    @property
    def level(self) -> int:
        """
        The `level` field.
        """
        return self._level

    @property
    def icon(self) -> CharacterIcon:
        """
        The `icon` field.
        """
        return self._icon

    @property
    def class_id(self) -> int:
        """
        The `class_id` field.
        """
        return self._class_id

    @property
    def guild_tag(self) -> str:
        """
        The `guild_tag` field.
        """
        return self._guild_tag



    @staticmethod
    def serialize(writer: EoWriter, data: "OnlinePlayer") -> None:
        """
        Serializes an instance of `OnlinePlayer` to the provided `EoWriter`.

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (OnlinePlayer): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            writer.string_sanitization_mode = True
            if data._name is None:
                raise SerializationError("name must be provided.")
            writer.add_string(data._name)
            writer.add_byte(0xFF)
            if data._title is None:
                raise SerializationError("title must be provided.")
            writer.add_string(data._title)
            writer.add_byte(0xFF)
            if data._level is None:
                raise SerializationError("level must be provided.")
            writer.add_char(data._level)
            if data._icon is None:
                raise SerializationError("icon must be provided.")
            writer.add_char(int(data._icon))
            if data._class_id is None:
                raise SerializationError("class_id must be provided.")
            writer.add_char(data._class_id)
            if data._guild_tag is None:
                raise SerializationError("guild_tag must be provided.")
            writer.add_string(data._guild_tag)
            writer.string_sanitization_mode = False
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode




    @staticmethod
    def deserialize(reader: EoReader) -> "OnlinePlayer":
        """
        Deserializes an instance of `OnlinePlayer` from the provided `EoReader`.

        Args:
            reader (EoReader): The writer that the data will be serialized to.

        Returns:
            The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            reader.chunked_reading_mode = True
            name = reader.get_string()
            reader.next_chunk()
            title = reader.get_string()
            reader.next_chunk()
            level = reader.get_char()
            icon = CharacterIcon(reader.get_char())
            class_id = reader.get_char()
            guild_tag = reader.get_string()
            reader.chunked_reading_mode = False
            result = OnlinePlayer(name=name, title=title, level=level, icon=icon, class_id=class_id, guild_tag=guild_tag)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode


    def __repr__(self):
        return f"OnlinePlayer(byte_size={repr(self._byte_size)}, name={repr(self._name)}, title={repr(self._title)}, level={repr(self._level)}, icon={repr(self._icon)}, class_id={repr(self._class_id)}, guild_tag={repr(self._guild_tag)})"