eolib 1.1.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

eolib/protocol/_generated/net/server/citizen_open_server_packet.py

@@ -4,6 +4,7 @@
 # Changes will be lost when code is regenerated.
 
 from __future__ import annotations
+from collections.abc import Iterable
 from ..packet_family import PacketFamily
 from ..packet_action import PacketAction
 from ....serialization_error import SerializationError
@@ -16,10 +17,25 @@ class CitizenOpenServerPacket(Packet):
     Response from talking to a citizenship NPC
     """
     _byte_size: int = 0
-    _behavior_id: int = None # type: ignore [assignment]
-    _current_home_id: int = None # type: ignore [assignment]
-    _session_id: int = None # type: ignore [assignment]
-    _questions: list[str] = None # type: ignore [assignment]
+    _behavior_id: int
+    _current_home_id: int
+    _session_id: int
+    _questions: tuple[str, ...]
+
+    def __init__(self, *, behavior_id: int, current_home_id: int, session_id: int, questions: Iterable[str]):
+        """
+        Create a new instance of CitizenOpenServerPacket.
+
+        Args:
+            behavior_id (int): (Value range is 0-16194276.)
+            current_home_id (int): (Value range is 0-252.)
+            session_id (int): (Value range is 0-64008.)
+            questions (Iterable[str]): (Length must be `3`.)
+        """
+        self._behavior_id = behavior_id
+        self._current_home_id = current_home_id
+        self._session_id = session_id
+        self._questions = tuple(questions)
 
     @property
     def byte_size(self) -> int:
@@ -33,68 +49,20 @@ class CitizenOpenServerPacket(Packet):
 
     @property
     def behavior_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-16194276.
-        """
         return self._behavior_id
 
-    @behavior_id.setter
-    def behavior_id(self, behavior_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-16194276.
-        """
-        self._behavior_id = behavior_id
-
     @property
     def current_home_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._current_home_id
 
-    @current_home_id.setter
-    def current_home_id(self, current_home_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._current_home_id = current_home_id
-
     @property
     def session_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._session_id
 
-    @session_id.setter
-    def session_id(self, session_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._session_id = session_id
-
     @property
-    def questions(self) -> list[str]:
-        """
-        Note:
-          - Length must be `3`.
-        """
+    def questions(self) -> tuple[str, ...]:
         return self._questions
 
-    @questions.setter
-    def questions(self, questions: list[str]) -> None:
-        """
-        Note:
-          - Length must be `3`.
-        """
-        self._questions = questions
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -133,24 +101,30 @@ class CitizenOpenServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CitizenOpenServerPacket): The data to serialize.
         """
-        if data._behavior_id is None:
-            raise SerializationError("behavior_id must be provided.")
-        writer.add_three(data._behavior_id)
-        if data._current_home_id is None:
-            raise SerializationError("current_home_id must be provided.")
-        writer.add_char(data._current_home_id)
-        if data._session_id is None:
-            raise SerializationError("session_id must be provided.")
-        writer.add_short(data._session_id)
-        writer.add_byte(0xFF)
-        if data._questions is None:
-            raise SerializationError("questions must be provided.")
-        if len(data._questions) != 3:
-            raise SerializationError(f"Expected length of questions to be exactly 3, got {len(data._questions)}.")
-        for i in range(3):
-            if i > 0:
-                writer.add_byte(0xFF)
-            writer.add_string(data._questions[i])
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._behavior_id is None:
+                raise SerializationError("behavior_id must be provided.")
+            writer.add_three(data._behavior_id)
+            if data._current_home_id is None:
+                raise SerializationError("current_home_id must be provided.")
+            writer.add_char(data._current_home_id)
+            if data._session_id is None:
+                raise SerializationError("session_id must be provided.")
+            writer.add_short(data._session_id)
+            writer.add_byte(0xFF)
+            if data._questions is None:
+                raise SerializationError("questions must be provided.")
+            if len(data._questions) != 3:
+                raise SerializationError(f"Expected length of questions to be exactly 3, got {len(data._questions)}.")
+            for i in range(3):
+                if i > 0:
+                    writer.add_byte(0xFF)
+                writer.add_string(data._questions[i])
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CitizenOpenServerPacket":
@@ -163,23 +137,23 @@ class CitizenOpenServerPacket(Packet):
         Returns:
             CitizenOpenServerPacket: The data to serialize.
         """
-        data: CitizenOpenServerPacket = CitizenOpenServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._behavior_id = reader.get_three()
-            data._current_home_id = reader.get_char()
-            data._session_id = reader.get_short()
+            behavior_id = reader.get_three()
+            current_home_id = reader.get_char()
+            session_id = reader.get_short()
             reader.next_chunk()
-            data._questions = []
+            questions = []
             for i in range(3):
-                data._questions.append(reader.get_string())
+                questions.append(reader.get_string())
                 if i + 1 < 3:
                     reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = CitizenOpenServerPacket(behavior_id=behavior_id, current_home_id=current_home_id, session_id=session_id, questions=questions)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/server/citizen_remove_server_packet.py

@@ -16,7 +16,16 @@ class CitizenRemoveServerPacket(Packet):
     Response to giving up citizenship of a town
     """
     _byte_size: int = 0
-    _reply_code: InnUnsubscribeReply = None # type: ignore [assignment]
+    _reply_code: InnUnsubscribeReply
+
+    def __init__(self, *, reply_code: InnUnsubscribeReply):
+        """
+        Create a new instance of CitizenRemoveServerPacket.
+
+        Args:
+            reply_code (InnUnsubscribeReply): 
+        """
+        self._reply_code = reply_code
 
     @property
     def byte_size(self) -> int:
@@ -32,10 +41,6 @@ class CitizenRemoveServerPacket(Packet):
     def reply_code(self) -> InnUnsubscribeReply:
         return self._reply_code
 
-    @reply_code.setter
-    def reply_code(self, reply_code: InnUnsubscribeReply) -> None:
-        self._reply_code = reply_code
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -74,9 +79,13 @@ class CitizenRemoveServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CitizenRemoveServerPacket): The data to serialize.
         """
-        if data._reply_code is None:
-            raise SerializationError("reply_code must be provided.")
-        writer.add_char(int(data._reply_code))
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._reply_code is None:
+                raise SerializationError("reply_code must be provided.")
+            writer.add_char(int(data._reply_code))
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CitizenRemoveServerPacket":
@@ -89,13 +98,13 @@ class CitizenRemoveServerPacket(Packet):
         Returns:
             CitizenRemoveServerPacket: The data to serialize.
         """
-        data: CitizenRemoveServerPacket = CitizenRemoveServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._reply_code = InnUnsubscribeReply(reader.get_char())
-            data._byte_size = reader.position - reader_start_position
-            return data
+            reply_code = InnUnsubscribeReply(reader.get_char())
+            result = CitizenRemoveServerPacket(reply_code=reply_code)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/server/citizen_reply_server_packet.py

@@ -15,7 +15,16 @@ class CitizenReplyServerPacket(Packet):
     Response to subscribing to a town
     """
     _byte_size: int = 0
-    _questions_wrong: int = None # type: ignore [assignment]
+    _questions_wrong: int
+
+    def __init__(self, *, questions_wrong: int):
+        """
+        Create a new instance of CitizenReplyServerPacket.
+
+        Args:
+            questions_wrong (int): (Value range is 0-252.)
+        """
+        self._questions_wrong = questions_wrong
 
     @property
     def byte_size(self) -> int:
@@ -29,20 +38,8 @@ class CitizenReplyServerPacket(Packet):
 
     @property
     def questions_wrong(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._questions_wrong
 
-    @questions_wrong.setter
-    def questions_wrong(self, questions_wrong: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._questions_wrong = questions_wrong
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -81,9 +78,13 @@ class CitizenReplyServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CitizenReplyServerPacket): The data to serialize.
         """
-        if data._questions_wrong is None:
-            raise SerializationError("questions_wrong must be provided.")
-        writer.add_char(data._questions_wrong)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._questions_wrong is None:
+                raise SerializationError("questions_wrong must be provided.")
+            writer.add_char(data._questions_wrong)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CitizenReplyServerPacket":
@@ -96,13 +97,13 @@ class CitizenReplyServerPacket(Packet):
         Returns:
             CitizenReplyServerPacket: The data to serialize.
         """
-        data: CitizenReplyServerPacket = CitizenReplyServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._questions_wrong = reader.get_char()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            questions_wrong = reader.get_char()
+            result = CitizenReplyServerPacket(questions_wrong=questions_wrong)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/server/citizen_request_server_packet.py

@@ -15,7 +15,16 @@ class CitizenRequestServerPacket(Packet):
     Reply to requesting sleeping at an inn
     """
     _byte_size: int = 0
-    _cost: int = None # type: ignore [assignment]
+    _cost: int
+
+    def __init__(self, *, cost: int):
+        """
+        Create a new instance of CitizenRequestServerPacket.
+
+        Args:
+            cost (int): (Value range is 0-4097152080.)
+        """
+        self._cost = cost
 
     @property
     def byte_size(self) -> int:
@@ -29,20 +38,8 @@ class CitizenRequestServerPacket(Packet):
 
     @property
     def cost(self) -> int:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
         return self._cost
 
-    @cost.setter
-    def cost(self, cost: int) -> None:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
-        self._cost = cost
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -81,9 +78,13 @@ class CitizenRequestServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CitizenRequestServerPacket): The data to serialize.
         """
-        if data._cost is None:
-            raise SerializationError("cost must be provided.")
-        writer.add_int(data._cost)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._cost is None:
+                raise SerializationError("cost must be provided.")
+            writer.add_int(data._cost)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CitizenRequestServerPacket":
@@ -96,13 +97,13 @@ class CitizenRequestServerPacket(Packet):
         Returns:
             CitizenRequestServerPacket: The data to serialize.
         """
-        data: CitizenRequestServerPacket = CitizenRequestServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._cost = reader.get_int()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            cost = reader.get_int()
+            result = CitizenRequestServerPacket(cost=cost)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/server/connection_player_server_packet.py

@@ -15,8 +15,19 @@ class ConnectionPlayerServerPacket(Packet):
     Ping request
     """
     _byte_size: int = 0
-    _seq1: int = None # type: ignore [assignment]
-    _seq2: int = None # type: ignore [assignment]
+    _seq1: int
+    _seq2: int
+
+    def __init__(self, *, seq1: int, seq2: int):
+        """
+        Create a new instance of ConnectionPlayerServerPacket.
+
+        Args:
+            seq1 (int): (Value range is 0-64008.)
+            seq2 (int): (Value range is 0-252.)
+        """
+        self._seq1 = seq1
+        self._seq2 = seq2
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +41,12 @@ class ConnectionPlayerServerPacket(Packet):
 
     @property
     def seq1(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._seq1
 
-    @seq1.setter
-    def seq1(self, seq1: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._seq1 = seq1
-
     @property
     def seq2(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._seq2
 
-    @seq2.setter
-    def seq2(self, seq2: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._seq2 = seq2
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -98,12 +85,16 @@ class ConnectionPlayerServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (ConnectionPlayerServerPacket): The data to serialize.
         """
-        if data._seq1 is None:
-            raise SerializationError("seq1 must be provided.")
-        writer.add_short(data._seq1)
-        if data._seq2 is None:
-            raise SerializationError("seq2 must be provided.")
-        writer.add_char(data._seq2)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._seq1 is None:
+                raise SerializationError("seq1 must be provided.")
+            writer.add_short(data._seq1)
+            if data._seq2 is None:
+                raise SerializationError("seq2 must be provided.")
+            writer.add_char(data._seq2)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ConnectionPlayerServerPacket":
@@ -116,14 +107,14 @@ class ConnectionPlayerServerPacket(Packet):
         Returns:
             ConnectionPlayerServerPacket: The data to serialize.
         """
-        data: ConnectionPlayerServerPacket = ConnectionPlayerServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._seq1 = reader.get_short()
-            data._seq2 = reader.get_char()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            seq1 = reader.get_short()
+            seq2 = reader.get_char()
+            result = ConnectionPlayerServerPacket(seq1=seq1, seq2=seq2)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode