Skip to content

quest_progress_entry

QuestProgressEntry

An entry in the Quest Progress window

Source code in src/eolib/protocol/_generated/net/server/quest_progress_entry.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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 (str): 
            description (str): 
            icon (QuestRequirementIcon): 
            progress (int): (Value range is 0-64008.)
            target (int): (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:
        """
        Returns the size of the data that this was deserialized from.

        Returns:
            int: The size of the data that this was deserialized from.
        """
        return self._byte_size

    @property
    def name(self) -> str:
        return self._name

    @property
    def description(self) -> str:
        return self._description

    @property
    def icon(self) -> QuestRequirementIcon:
        return self._icon

    @property
    def progress(self) -> int:
        return self._progress

    @property
    def target(self) -> int:
        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:
            QuestProgressEntry: 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)})"

byte_size: int property

Returns the size of the data that this was deserialized from.

Returns:

Name Type Description
int int

The size of the data that this was deserialized from.

name: str property

description: str property

icon: QuestRequirementIcon property

progress: int property

target: int property

__init__(*, name, description, icon, progress, target)

Create a new instance of QuestProgressEntry.

Parameters:

Name Type Description Default
name str
required
description str
required
icon QuestRequirementIcon
required
progress int

(Value range is 0-64008.)

 required
target int

(Value range is 0-64008.)

 required
Source code in src/eolib/protocol/_generated/net/server/quest_progress_entry.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def __init__(self, *, name: str, description: str, icon: QuestRequirementIcon, progress: int, target: int):
    """
    Create a new instance of QuestProgressEntry.

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

serialize(writer, data) staticmethod

Serializes an instance of QuestProgressEntry to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data QuestProgressEntry

The data to serialize.

 required
Source code in src/eolib/protocol/_generated/net/server/quest_progress_entry.py 
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@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

deserialize(reader) staticmethod

Deserializes an instance of QuestProgressEntry from the provided EoReader.

Parameters:

Name Type Description Default
reader EoReader

The writer that the data will be serialized to.

 required

Returns:

Name Type Description
QuestProgressEntry QuestProgressEntry

The data to serialize.
Source code in src/eolib/protocol/_generated/net/server/quest_progress_entry.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
@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:
        QuestProgressEntry: 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