Skip to content

quest_dialog_server_packet

QuestDialogServerPacket

Bases: Packet

Quest selection dialog

Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
class QuestDialogServerPacket(Packet):
    """
    Quest selection dialog
    """
    _byte_size: int = 0
    _quest_count: int
    _behavior_id: int
    _quest_id: int
    _session_id: int
    _dialog_id: int
    _quest_entries: tuple[DialogQuestEntry, ...]
    _dialog_entries: tuple[DialogEntry, ...]

    def __init__(self, *, behavior_id: int, quest_id: int, session_id: int, dialog_id: int, quest_entries: Iterable[DialogQuestEntry], dialog_entries: Iterable[DialogEntry]):
        """
        Create a new instance of QuestDialogServerPacket.

        Args:
            behavior_id (int): (Value range is 0-64008.)
            quest_id (int): (Value range is 0-64008.)
            session_id (int): (Value range is 0-64008.)
            dialog_id (int): (Value range is 0-64008.)
            quest_entries (Iterable[DialogQuestEntry]): (Length must be 252 or less.)
            dialog_entries (Iterable[DialogEntry]): 
        """
        self._behavior_id = behavior_id
        self._quest_id = quest_id
        self._session_id = session_id
        self._dialog_id = dialog_id
        self._quest_entries = tuple(quest_entries)
        self._quest_count = len(self._quest_entries)
        self._dialog_entries = tuple(dialog_entries)

    @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 behavior_id(self) -> int:
        return self._behavior_id

    @property
    def quest_id(self) -> int:
        return self._quest_id

    @property
    def session_id(self) -> int:
        return self._session_id

    @property
    def dialog_id(self) -> int:
        return self._dialog_id

    @property
    def quest_entries(self) -> tuple[DialogQuestEntry, ...]:
        return self._quest_entries

    @property
    def dialog_entries(self) -> tuple[DialogEntry, ...]:
        return self._dialog_entries

    @staticmethod
    def family() -> PacketFamily:
        """
        Returns the packet family associated with this packet.

        Returns:
            PacketFamily: The packet family associated with this packet.
        """
        return PacketFamily.Quest

    @staticmethod
    def action() -> PacketAction:
        """
        Returns the packet action associated with this packet.

        Returns:
            PacketAction: The packet action associated with this packet.
        """
        return PacketAction.Dialog

    def write(self, writer):
        """
        Serializes and writes this packet to the provided EoWriter.

        Args:
            writer (EoWriter): the writer that this packet will be written to.
        """
        QuestDialogServerPacket.serialize(writer, self)

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (QuestDialogServerPacket): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            writer.string_sanitization_mode = True
            if data._quest_count is None:
                raise SerializationError("quest_count must be provided.")
            writer.add_char(data._quest_count)
            if data._behavior_id is None:
                raise SerializationError("behavior_id must be provided.")
            writer.add_short(data._behavior_id)
            if data._quest_id is None:
                raise SerializationError("quest_id must be provided.")
            writer.add_short(data._quest_id)
            if data._session_id is None:
                raise SerializationError("session_id must be provided.")
            writer.add_short(data._session_id)
            if data._dialog_id is None:
                raise SerializationError("dialog_id must be provided.")
            writer.add_short(data._dialog_id)
            writer.add_byte(0xFF)
            if data._quest_entries is None:
                raise SerializationError("quest_entries must be provided.")
            if len(data._quest_entries) > 252:
                raise SerializationError(f"Expected length of quest_entries to be 252 or less, got {len(data._quest_entries)}.")
            for i in range(data._quest_count):
                DialogQuestEntry.serialize(writer, data._quest_entries[i])
                writer.add_byte(0xFF)
            if data._dialog_entries is None:
                raise SerializationError("dialog_entries must be provided.")
            for i in range(len(data._dialog_entries)):
                DialogEntry.serialize(writer, data._dialog_entries[i])
                writer.add_byte(0xFF)
            writer.string_sanitization_mode = False
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            QuestDialogServerPacket: 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
            quest_count = reader.get_char()
            behavior_id = reader.get_short()
            quest_id = reader.get_short()
            session_id = reader.get_short()
            dialog_id = reader.get_short()
            reader.next_chunk()
            quest_entries = []
            for i in range(quest_count):
                quest_entries.append(DialogQuestEntry.deserialize(reader))
                reader.next_chunk()
            dialog_entries = []
            while reader.remaining > 0:
                dialog_entries.append(DialogEntry.deserialize(reader))
                reader.next_chunk()
            reader.chunked_reading_mode = False
            result = QuestDialogServerPacket(behavior_id=behavior_id, quest_id=quest_id, session_id=session_id, dialog_id=dialog_id, quest_entries=quest_entries, dialog_entries=dialog_entries)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"QuestDialogServerPacket(byte_size={repr(self._byte_size)}, behavior_id={repr(self._behavior_id)}, quest_id={repr(self._quest_id)}, session_id={repr(self._session_id)}, dialog_id={repr(self._dialog_id)}, quest_entries={repr(self._quest_entries)}, dialog_entries={repr(self._dialog_entries)})"

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.

behavior_id: int property

quest_id: int property

session_id: int property

dialog_id: int property

quest_entries: tuple[DialogQuestEntry, ...] property

dialog_entries: tuple[DialogEntry, ...] property

__init__(*, behavior_id, quest_id, session_id, dialog_id, quest_entries, dialog_entries)

Create a new instance of QuestDialogServerPacket.

Parameters:

Name Type Description Default
behavior_id int

(Value range is 0-64008.)

 required
quest_id int

(Value range is 0-64008.)

 required
session_id int

(Value range is 0-64008.)

 required
dialog_id int

(Value range is 0-64008.)

 required
quest_entries Iterable[DialogQuestEntry]

(Length must be 252 or less.)

 required
dialog_entries Iterable[DialogEntry]
required
Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def __init__(self, *, behavior_id: int, quest_id: int, session_id: int, dialog_id: int, quest_entries: Iterable[DialogQuestEntry], dialog_entries: Iterable[DialogEntry]):
    """
    Create a new instance of QuestDialogServerPacket.

    Args:
        behavior_id (int): (Value range is 0-64008.)
        quest_id (int): (Value range is 0-64008.)
        session_id (int): (Value range is 0-64008.)
        dialog_id (int): (Value range is 0-64008.)
        quest_entries (Iterable[DialogQuestEntry]): (Length must be 252 or less.)
        dialog_entries (Iterable[DialogEntry]): 
    """
    self._behavior_id = behavior_id
    self._quest_id = quest_id
    self._session_id = session_id
    self._dialog_id = dialog_id
    self._quest_entries = tuple(quest_entries)
    self._quest_count = len(self._quest_entries)
    self._dialog_entries = tuple(dialog_entries)

family() staticmethod

Returns the packet family associated with this packet.

Returns:

Name Type Description
PacketFamily PacketFamily

The packet family associated with this packet.
Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
84
85
86
87
88
89
90
91
92
@staticmethod
def family() -> PacketFamily:
    """
    Returns the packet family associated with this packet.

    Returns:
        PacketFamily: The packet family associated with this packet.
    """
    return PacketFamily.Quest

action() staticmethod

Returns the packet action associated with this packet.

Returns:

Name Type Description
PacketAction PacketAction

The packet action associated with this packet.
Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
 94
 95
 96
 97
 98
 99
100
101
102
@staticmethod
def action() -> PacketAction:
    """
    Returns the packet action associated with this packet.

    Returns:
        PacketAction: The packet action associated with this packet.
    """
    return PacketAction.Dialog

write(writer)

Serializes and writes this packet to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

the writer that this packet will be written to.

 required
Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
104
105
106
107
108
109
110
111
def write(self, writer):
    """
    Serializes and writes this packet to the provided EoWriter.

    Args:
        writer (EoWriter): the writer that this packet will be written to.
    """
    QuestDialogServerPacket.serialize(writer, self)

serialize(writer, data) staticmethod

Serializes an instance of QuestDialogServerPacket to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data QuestDialogServerPacket

The data to serialize.

 required
Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
@staticmethod
def serialize(writer: EoWriter, data: "QuestDialogServerPacket") -> None:
    """
    Serializes an instance of `QuestDialogServerPacket` to the provided `EoWriter`.

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (QuestDialogServerPacket): The data to serialize.
    """
    old_string_sanitization_mode: bool = writer.string_sanitization_mode
    try:
        writer.string_sanitization_mode = True
        if data._quest_count is None:
            raise SerializationError("quest_count must be provided.")
        writer.add_char(data._quest_count)
        if data._behavior_id is None:
            raise SerializationError("behavior_id must be provided.")
        writer.add_short(data._behavior_id)
        if data._quest_id is None:
            raise SerializationError("quest_id must be provided.")
        writer.add_short(data._quest_id)
        if data._session_id is None:
            raise SerializationError("session_id must be provided.")
        writer.add_short(data._session_id)
        if data._dialog_id is None:
            raise SerializationError("dialog_id must be provided.")
        writer.add_short(data._dialog_id)
        writer.add_byte(0xFF)
        if data._quest_entries is None:
            raise SerializationError("quest_entries must be provided.")
        if len(data._quest_entries) > 252:
            raise SerializationError(f"Expected length of quest_entries to be 252 or less, got {len(data._quest_entries)}.")
        for i in range(data._quest_count):
            DialogQuestEntry.serialize(writer, data._quest_entries[i])
            writer.add_byte(0xFF)
        if data._dialog_entries is None:
            raise SerializationError("dialog_entries must be provided.")
        for i in range(len(data._dialog_entries)):
            DialogEntry.serialize(writer, data._dialog_entries[i])
            writer.add_byte(0xFF)
        writer.string_sanitization_mode = False
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

Deserializes an instance of QuestDialogServerPacket 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
QuestDialogServerPacket 'QuestDialogServerPacket'

The data to serialize.
Source code in src/eolib/protocol/_generated/net/server/quest_dialog_server_packet.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
@staticmethod
def deserialize(reader: EoReader) -> "QuestDialogServerPacket":
    """
    Deserializes an instance of `QuestDialogServerPacket` from the provided `EoReader`.

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

    Returns:
        QuestDialogServerPacket: 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
        quest_count = reader.get_char()
        behavior_id = reader.get_short()
        quest_id = reader.get_short()
        session_id = reader.get_short()
        dialog_id = reader.get_short()
        reader.next_chunk()
        quest_entries = []
        for i in range(quest_count):
            quest_entries.append(DialogQuestEntry.deserialize(reader))
            reader.next_chunk()
        dialog_entries = []
        while reader.remaining > 0:
            dialog_entries.append(DialogEntry.deserialize(reader))
            reader.next_chunk()
        reader.chunked_reading_mode = False
        result = QuestDialogServerPacket(behavior_id=behavior_id, quest_id=quest_id, session_id=session_id, dialog_id=dialog_id, quest_entries=quest_entries, dialog_entries=dialog_entries)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode