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

eolib/protocol/_generated/net/client/character_remove_client_packet.py

@@ -15,8 +15,19 @@ class CharacterRemoveClientPacket(Packet):
     Confirm deleting character from an account
     """
     _byte_size: int = 0
-    _session_id: int = None # type: ignore [assignment]
-    _character_id: int = None # type: ignore [assignment]
+    _session_id: int
+    _character_id: int
+
+    def __init__(self, *, session_id: int, character_id: int):
+        """
+        Create a new instance of CharacterRemoveClientPacket.
+
+        Args:
+            session_id (int): (Value range is 0-64008.)
+            character_id (int): The official client sends a short, which gets written as a variable-sized integer (2-4 bytes) due to a quirk of the official encoding routine. However, the official server expects an int. (Value range is 0-4097152080.)
+        """
+        self._session_id = session_id
+        self._character_id = character_id
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +41,17 @@ class CharacterRemoveClientPacket(Packet):
 
     @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 character_id(self) -> int:
         """
-        Note:
-          - Value range is 0-4097152080.
+        The official client sends a short, which gets written as a variable-sized integer
+        (2-4 bytes) due to a quirk of the official encoding routine.
+        However, the official server expects an int.
         """
         return self._character_id
 
-    @character_id.setter
-    def character_id(self, character_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
-        self._character_id = character_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -98,12 +90,16 @@ class CharacterRemoveClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CharacterRemoveClientPacket): The data to serialize.
         """
-        if data._session_id is None:
-            raise SerializationError("session_id must be provided.")
-        writer.add_short(data._session_id)
-        if data._character_id is None:
-            raise SerializationError("character_id must be provided.")
-        writer.add_int(data._character_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._session_id is None:
+                raise SerializationError("session_id must be provided.")
+            writer.add_short(data._session_id)
+            if data._character_id is None:
+                raise SerializationError("character_id must be provided.")
+            writer.add_int(data._character_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CharacterRemoveClientPacket":
@@ -116,14 +112,14 @@ class CharacterRemoveClientPacket(Packet):
         Returns:
             CharacterRemoveClientPacket: The data to serialize.
         """
-        data: CharacterRemoveClientPacket = CharacterRemoveClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._session_id = reader.get_short()
-            data._character_id = reader.get_int()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            session_id = reader.get_short()
+            character_id = reader.get_int()
+            result = CharacterRemoveClientPacket(session_id=session_id, character_id=character_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/client/character_request_client_packet.py

@@ -14,7 +14,16 @@ class CharacterRequestClientPacket(Packet):
     Request to create a character
     """
     _byte_size: int = 0
-    _request_string: str = "NEW" # type: ignore [assignment]
+    _request_string: str
+
+    def __init__(self, *, request_string: str):
+        """
+        Create a new instance of CharacterRequestClientPacket.
+
+        Args:
+            request_string (str): 
+        """
+        self._request_string = "NEW"
 
     @property
     def byte_size(self) -> int:
@@ -68,8 +77,14 @@ class CharacterRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CharacterRequestClientPacket): The data to serialize.
         """
-        writer.add_string(data._request_string)
-        writer.add_byte(0xFF)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            writer.add_string(data._request_string)
+            writer.add_byte(0xFF)
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CharacterRequestClientPacket":
@@ -82,16 +97,16 @@ class CharacterRequestClientPacket(Packet):
         Returns:
             CharacterRequestClientPacket: The data to serialize.
         """
-        data: CharacterRequestClientPacket = CharacterRequestClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._request_string = reader.get_string()
+            request_string = reader.get_string()
             reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = CharacterRequestClientPacket(request_string=request_string)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/client/character_take_client_packet.py

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

eolib/protocol/_generated/net/client/chest_add_client_packet.py

@@ -17,8 +17,19 @@ class ChestAddClientPacket(Packet):
     Placing an item in to a chest
     """
     _byte_size: int = 0
-    _coords: Coords = None # type: ignore [assignment]
-    _add_item: ThreeItem = None # type: ignore [assignment]
+    _coords: Coords
+    _add_item: ThreeItem
+
+    def __init__(self, *, coords: Coords, add_item: ThreeItem):
+        """
+        Create a new instance of ChestAddClientPacket.
+
+        Args:
+            coords (Coords): 
+            add_item (ThreeItem): 
+        """
+        self._coords = coords
+        self._add_item = add_item
 
     @property
     def byte_size(self) -> int:
@@ -34,18 +45,10 @@ class ChestAddClientPacket(Packet):
     def coords(self) -> Coords:
         return self._coords
 
-    @coords.setter
-    def coords(self, coords: Coords) -> None:
-        self._coords = coords
-
     @property
     def add_item(self) -> ThreeItem:
         return self._add_item
 
-    @add_item.setter
-    def add_item(self, add_item: ThreeItem) -> None:
-        self._add_item = add_item
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -84,12 +87,16 @@ class ChestAddClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (ChestAddClientPacket): The data to serialize.
         """
-        if data._coords is None:
-            raise SerializationError("coords must be provided.")
-        Coords.serialize(writer, data._coords)
-        if data._add_item is None:
-            raise SerializationError("add_item must be provided.")
-        ThreeItem.serialize(writer, data._add_item)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._coords is None:
+                raise SerializationError("coords must be provided.")
+            Coords.serialize(writer, data._coords)
+            if data._add_item is None:
+                raise SerializationError("add_item must be provided.")
+            ThreeItem.serialize(writer, data._add_item)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ChestAddClientPacket":
@@ -102,14 +109,14 @@ class ChestAddClientPacket(Packet):
         Returns:
             ChestAddClientPacket: The data to serialize.
         """
-        data: ChestAddClientPacket = ChestAddClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._coords = Coords.deserialize(reader)
-            data._add_item = ThreeItem.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            coords = Coords.deserialize(reader)
+            add_item = ThreeItem.deserialize(reader)
+            result = ChestAddClientPacket(coords=coords, add_item=add_item)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/client/chest_open_client_packet.py

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

eolib/protocol/_generated/net/client/chest_take_client_packet.py

@@ -16,8 +16,19 @@ class ChestTakeClientPacket(Packet):
     Taking an item from a chest
     """
     _byte_size: int = 0
-    _coords: Coords = None # type: ignore [assignment]
-    _take_item_id: int = None # type: ignore [assignment]
+    _coords: Coords
+    _take_item_id: int
+
+    def __init__(self, *, coords: Coords, take_item_id: int):
+        """
+        Create a new instance of ChestTakeClientPacket.
+
+        Args:
+            coords (Coords): 
+            take_item_id (int): (Value range is 0-64008.)
+        """
+        self._coords = coords
+        self._take_item_id = take_item_id
 
     @property
     def byte_size(self) -> int:
@@ -33,26 +44,10 @@ class ChestTakeClientPacket(Packet):
     def coords(self) -> Coords:
         return self._coords
 
-    @coords.setter
-    def coords(self, coords: Coords) -> None:
-        self._coords = coords
-
     @property
     def take_item_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._take_item_id
 
-    @take_item_id.setter
-    def take_item_id(self, take_item_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._take_item_id = take_item_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -91,12 +86,16 @@ class ChestTakeClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (ChestTakeClientPacket): The data to serialize.
         """
-        if data._coords is None:
-            raise SerializationError("coords must be provided.")
-        Coords.serialize(writer, data._coords)
-        if data._take_item_id is None:
-            raise SerializationError("take_item_id must be provided.")
-        writer.add_short(data._take_item_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._coords is None:
+                raise SerializationError("coords must be provided.")
+            Coords.serialize(writer, data._coords)
+            if data._take_item_id is None:
+                raise SerializationError("take_item_id must be provided.")
+            writer.add_short(data._take_item_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ChestTakeClientPacket":
@@ -109,14 +108,14 @@ class ChestTakeClientPacket(Packet):
         Returns:
             ChestTakeClientPacket: The data to serialize.
         """
-        data: ChestTakeClientPacket = ChestTakeClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._coords = Coords.deserialize(reader)
-            data._take_item_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            coords = Coords.deserialize(reader)
+            take_item_id = reader.get_short()
+            result = ChestTakeClientPacket(coords=coords, take_item_id=take_item_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/client/citizen_accept_client_packet.py

@@ -15,8 +15,19 @@ class CitizenAcceptClientPacket(Packet):
     Confirm sleeping at an inn
     """
     _byte_size: int = 0
-    _session_id: int = None # type: ignore [assignment]
-    _behavior_id: int = None # type: ignore [assignment]
+    _session_id: int
+    _behavior_id: int
+
+    def __init__(self, *, session_id: int, behavior_id: int):
+        """
+        Create a new instance of CitizenAcceptClientPacket.
+
+        Args:
+            session_id (int): (Value range is 0-64008.)
+            behavior_id (int): (Value range is 0-64008.)
+        """
+        self._session_id = session_id
+        self._behavior_id = behavior_id
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +41,12 @@ class CitizenAcceptClientPacket(Packet):
 
     @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 behavior_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._behavior_id
 
-    @behavior_id.setter
-    def behavior_id(self, behavior_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._behavior_id = behavior_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -98,12 +85,16 @@ class CitizenAcceptClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CitizenAcceptClientPacket): The data to serialize.
         """
-        if data._session_id is None:
-            raise SerializationError("session_id must be provided.")
-        writer.add_short(data._session_id)
-        if data._behavior_id is None:
-            raise SerializationError("behavior_id must be provided.")
-        writer.add_short(data._behavior_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._session_id is None:
+                raise SerializationError("session_id must be provided.")
+            writer.add_short(data._session_id)
+            if data._behavior_id is None:
+                raise SerializationError("behavior_id must be provided.")
+            writer.add_short(data._behavior_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CitizenAcceptClientPacket":
@@ -116,14 +107,14 @@ class CitizenAcceptClientPacket(Packet):
         Returns:
             CitizenAcceptClientPacket: The data to serialize.
         """
-        data: CitizenAcceptClientPacket = CitizenAcceptClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._session_id = reader.get_short()
-            data._behavior_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            session_id = reader.get_short()
+            behavior_id = reader.get_short()
+            result = CitizenAcceptClientPacket(session_id=session_id, behavior_id=behavior_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/client/citizen_open_client_packet.py

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