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

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

from .quest_requirement_icon import QuestRequirementIcon
from ....serialization_error import SerializationError
from .....data.eo_writer import EoWriter
from .....data.eo_reader import EoReader



class QuestProgressEntry:
    """
    An entry in the Quest Progress window
    """
    _byte_size: int = 0
    _name: str
    _description: str
    _icon: QuestRequirementIcon
    _progress: int
    _target: int



    def __init__(self, *, name: str, description: str, icon: QuestRequirementIcon, progress: int, target: int):
        """
        Create a new instance of QuestProgressEntry.

        Args:
            name: 
            description: 
            icon: 
            progress: (Value range is 0-64008.)
            target: (Value range is 0-64008.)
        """
        self._name = name
        self._description = description
        self._icon = icon
        self._progress = progress
        self._target = target


    @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 description(self) -> str:
        """
        The `description` field.
        """
        return self._description

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

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

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



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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (QuestProgressEntry): 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._description is None:
                raise SerializationError("description must be provided.")
            writer.add_string(data._description)
            writer.add_byte(0xFF)
            if data._icon is None:
                raise SerializationError("icon must be provided.")
            writer.add_short(int(data._icon))
            if data._progress is None:
                raise SerializationError("progress must be provided.")
            writer.add_short(data._progress)
            if data._target is None:
                raise SerializationError("target must be provided.")
            writer.add_short(data._target)
            writer.string_sanitization_mode = False
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode




    @staticmethod
    def deserialize(reader: EoReader) -> "QuestProgressEntry":
        """
        Deserializes an instance of `QuestProgressEntry` 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()
            description = reader.get_string()
            reader.next_chunk()
            icon = QuestRequirementIcon(reader.get_short())
            progress = reader.get_short()
            target = reader.get_short()
            reader.chunked_reading_mode = False
            result = QuestProgressEntry(name=name, description=description, icon=icon, progress=progress, target=target)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode


    def __repr__(self):
        return f"QuestProgressEntry(byte_size={repr(self._byte_size)}, name={repr(self._name)}, description={repr(self._description)}, icon={repr(self._icon)}, progress={repr(self._progress)}, target={repr(self._target)})"