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

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

@@ -0,0 +1,91 @@
+# Generated from the eo-protocol XML specification.
+#
+# This file should not be modified.
+# Changes will be lost when code is regenerated.
+
+from ...coords import Coords
+from ....serialization_error import SerializationError
+from .....data.eo_writer import EoWriter
+from .....data.eo_reader import EoReader
+
+class TileEffect:
+    """
+    An effect playing on a tile
+    """
+    _byte_size: int = 0
+    _coords: Coords
+    _effect_id: int
+
+    def __init__(self, *, coords: Coords, effect_id: int):
+        """
+        Create a new instance of TileEffect.
+
+        Args:
+            coords (Coords): 
+            effect_id (int): (Value range is 0-64008.)
+        """
+        self._coords = coords
+        self._effect_id = effect_id
+
+    @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 coords(self) -> Coords:
+        return self._coords
+
+    @property
+    def effect_id(self) -> int:
+        return self._effect_id
+
+    @staticmethod
+    def serialize(writer: EoWriter, data: "TileEffect") -> None:
+        """
+        Serializes an instance of `TileEffect` to the provided `EoWriter`.
+
+        Args:
+            writer (EoWriter): The writer that the data will be serialized to.
+            data (TileEffect): The data to serialize.
+        """
+        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._effect_id is None:
+                raise SerializationError("effect_id must be provided.")
+            writer.add_short(data._effect_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
+
+    @staticmethod
+    def deserialize(reader: EoReader) -> "TileEffect":
+        """
+        Deserializes an instance of `TileEffect` from the provided `EoReader`.
+
+        Args:
+            reader (EoReader): The writer that the data will be serialized to.
+
+        Returns:
+            TileEffect: The data to serialize.
+        """
+        old_chunked_reading_mode: bool = reader.chunked_reading_mode
+        try:
+            reader_start_position: int = reader.position
+            coords = Coords.deserialize(reader)
+            effect_id = reader.get_short()
+            result = TileEffect(coords=coords, effect_id=effect_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
+        finally:
+            reader.chunked_reading_mode = old_chunked_reading_mode
+
+    def __repr__(self):
+        return f"TileEffect(byte_size={repr(self._byte_size)}, coords={repr(self._coords)}, effect_id={repr(self._effect_id)})"

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

@@ -3,6 +3,8 @@
 # This file should not be modified.
 # Changes will be lost when code is regenerated.
 
+from __future__ import annotations
+from collections.abc import Iterable
 from .trade_item_data import TradeItemData
 from ..packet_family import PacketFamily
 from ..packet_action import PacketAction
@@ -16,7 +18,16 @@ class TradeAdminServerPacket(Packet):
     Trade updated (items changed while trade was accepted)
     """
     _byte_size: int = 0
-    _trade_data: TradeItemData = None # type: ignore [assignment]
+    _trade_data: tuple[TradeItemData, ...]
+
+    def __init__(self, *, trade_data: Iterable[TradeItemData]):
+        """
+        Create a new instance of TradeAdminServerPacket.
+
+        Args:
+            trade_data (Iterable[TradeItemData]): (Length must be `2`.)
+        """
+        self._trade_data = tuple(trade_data)
 
     @property
     def byte_size(self) -> int:
@@ -29,13 +40,9 @@ class TradeAdminServerPacket(Packet):
         return self._byte_size
 
     @property
-    def trade_data(self) -> TradeItemData:
+    def trade_data(self) -> tuple[TradeItemData, ...]:
         return self._trade_data
 
-    @trade_data.setter
-    def trade_data(self, trade_data: TradeItemData) -> None:
-        self._trade_data = trade_data
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -74,9 +81,19 @@ class TradeAdminServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (TradeAdminServerPacket): The data to serialize.
         """
-        if data._trade_data is None:
-            raise SerializationError("trade_data must be provided.")
-        TradeItemData.serialize(writer, data._trade_data)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._trade_data is None:
+                raise SerializationError("trade_data must be provided.")
+            if len(data._trade_data) != 2:
+                raise SerializationError(f"Expected length of trade_data to be exactly 2, got {len(data._trade_data)}.")
+            for i in range(2):
+                TradeItemData.serialize(writer, data._trade_data[i])
+                writer.add_byte(0xFF)
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "TradeAdminServerPacket":
@@ -89,13 +106,18 @@ class TradeAdminServerPacket(Packet):
         Returns:
             TradeAdminServerPacket: The data to serialize.
         """
-        data: TradeAdminServerPacket = TradeAdminServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._trade_data = TradeItemData.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            reader.chunked_reading_mode = True
+            trade_data = []
+            for i in range(2):
+                trade_data.append(TradeItemData.deserialize(reader))
+                reader.next_chunk()
+            reader.chunked_reading_mode = False
+            result = TradeAdminServerPacket(trade_data=trade_data)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,8 +15,19 @@ class TradeAgreeServerPacket(Packet):
     Partner agree state updated
     """
     _byte_size: int = 0
-    _partner_player_id: int = None # type: ignore [assignment]
-    _agree: bool = None # type: ignore [assignment]
+    _partner_player_id: int
+    _agree: bool
+
+    def __init__(self, *, partner_player_id: int, agree: bool):
+        """
+        Create a new instance of TradeAgreeServerPacket.
+
+        Args:
+            partner_player_id (int): (Value range is 0-64008.)
+            agree (bool): 
+        """
+        self._partner_player_id = partner_player_id
+        self._agree = agree
 
     @property
     def byte_size(self) -> int:
@@ -30,28 +41,12 @@ class TradeAgreeServerPacket(Packet):
 
     @property
     def partner_player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._partner_player_id
 
-    @partner_player_id.setter
-    def partner_player_id(self, partner_player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._partner_player_id = partner_player_id
-
     @property
     def agree(self) -> bool:
         return self._agree
 
-    @agree.setter
-    def agree(self, agree: bool) -> None:
-        self._agree = agree
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -90,12 +85,16 @@ class TradeAgreeServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (TradeAgreeServerPacket): The data to serialize.
         """
-        if data._partner_player_id is None:
-            raise SerializationError("partner_player_id must be provided.")
-        writer.add_short(data._partner_player_id)
-        if data._agree is None:
-            raise SerializationError("agree must be provided.")
-        writer.add_char(1 if data._agree else 0)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._partner_player_id is None:
+                raise SerializationError("partner_player_id must be provided.")
+            writer.add_short(data._partner_player_id)
+            if data._agree is None:
+                raise SerializationError("agree must be provided.")
+            writer.add_char(1 if data._agree else 0)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "TradeAgreeServerPacket":
@@ -108,14 +107,14 @@ class TradeAgreeServerPacket(Packet):
         Returns:
             TradeAgreeServerPacket: The data to serialize.
         """
-        data: TradeAgreeServerPacket = TradeAgreeServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._partner_player_id = reader.get_short()
-            data._agree = reader.get_char() != 0
-            data._byte_size = reader.position - reader_start_position
-            return data
+            partner_player_id = reader.get_short()
+            agree = reader.get_char() != 0
+            result = TradeAgreeServerPacket(partner_player_id=partner_player_id, agree=agree)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

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

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

@@ -4,6 +4,7 @@
 # Changes will be lost when code is regenerated.
 
 from __future__ import annotations
+from collections.abc import Iterable
 from ..item import Item
 from ....serialization_error import SerializationError
 from .....data.eo_writer import EoWriter
@@ -14,10 +15,19 @@ class TradeItemData:
     Trade window item data
     """
     _byte_size: int = 0
-    _partner_player_id: int = None # type: ignore [assignment]
-    _partner_items: list[Item] = None # type: ignore [assignment]
-    _your_player_id: int = None # type: ignore [assignment]
-    _your_items: list[Item] = None # type: ignore [assignment]
+    _player_id: int
+    _items: tuple[Item, ...]
+
+    def __init__(self, *, player_id: int, items: Iterable[Item]):
+        """
+        Create a new instance of TradeItemData.
+
+        Args:
+            player_id (int): (Value range is 0-64008.)
+            items (Iterable[Item]): 
+        """
+        self._player_id = player_id
+        self._items = tuple(items)
 
     @property
     def byte_size(self) -> int:
@@ -30,52 +40,12 @@ class TradeItemData:
         return self._byte_size
 
     @property
-    def partner_player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        return self._partner_player_id
-
-    @partner_player_id.setter
-    def partner_player_id(self, partner_player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._partner_player_id = partner_player_id
+    def player_id(self) -> int:
+        return self._player_id
 
     @property
-    def partner_items(self) -> list[Item]:
-        return self._partner_items
-
-    @partner_items.setter
-    def partner_items(self, partner_items: list[Item]) -> None:
-        self._partner_items = partner_items
-
-    @property
-    def your_player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        return self._your_player_id
-
-    @your_player_id.setter
-    def your_player_id(self, your_player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._your_player_id = your_player_id
-
-    @property
-    def your_items(self) -> list[Item]:
-        return self._your_items
-
-    @your_items.setter
-    def your_items(self, your_items: list[Item]) -> None:
-        self._your_items = your_items
+    def items(self) -> tuple[Item, ...]:
+        return self._items
 
     @staticmethod
     def serialize(writer: EoWriter, data: "TradeItemData") -> None:
@@ -86,22 +56,17 @@ class TradeItemData:
             writer (EoWriter): The writer that the data will be serialized to.
             data (TradeItemData): The data to serialize.
         """
-        if data._partner_player_id is None:
-            raise SerializationError("partner_player_id must be provided.")
-        writer.add_short(data._partner_player_id)
-        if data._partner_items is None:
-            raise SerializationError("partner_items must be provided.")
-        for i in range(len(data._partner_items)):
-            Item.serialize(writer, data._partner_items[i])
-        writer.add_byte(0xFF)
-        if data._your_player_id is None:
-            raise SerializationError("your_player_id must be provided.")
-        writer.add_short(data._your_player_id)
-        if data._your_items is None:
-            raise SerializationError("your_items must be provided.")
-        for i in range(len(data._your_items)):
-            Item.serialize(writer, data._your_items[i])
-        writer.add_byte(0xFF)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._player_id is None:
+                raise SerializationError("player_id must be provided.")
+            writer.add_short(data._player_id)
+            if data._items is None:
+                raise SerializationError("items must be provided.")
+            for i in range(len(data._items)):
+                Item.serialize(writer, data._items[i])
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "TradeItemData":
@@ -114,28 +79,19 @@ class TradeItemData:
         Returns:
             TradeItemData: The data to serialize.
         """
-        data: TradeItemData = TradeItemData()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            reader.chunked_reading_mode = True
-            data._partner_player_id = reader.get_short()
-            partner_items_length = int(reader.remaining / 6)
-            data._partner_items = []
-            for i in range(partner_items_length):
-                data._partner_items.append(Item.deserialize(reader))
-            reader.next_chunk()
-            data._your_player_id = reader.get_short()
-            your_items_length = int(reader.remaining / 6)
-            data._your_items = []
-            for i in range(your_items_length):
-                data._your_items.append(Item.deserialize(reader))
-            reader.next_chunk()
-            reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            player_id = reader.get_short()
+            items_length = int(reader.remaining / 6)
+            items = []
+            for i in range(items_length):
+                items.append(Item.deserialize(reader))
+            result = TradeItemData(player_id=player_id, items=items)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 
     def __repr__(self):
-        return f"TradeItemData(byte_size={repr(self._byte_size)}, partner_player_id={repr(self._partner_player_id)}, partner_items={repr(self._partner_items)}, your_player_id={repr(self._your_player_id)}, your_items={repr(self._your_items)})"
+        return f"TradeItemData(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, items={repr(self._items)})"

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

@@ -15,10 +15,25 @@ class TradeOpenServerPacket(Packet):
     Trade window opens
     """
     _byte_size: int = 0
-    _partner_player_id: int = None # type: ignore [assignment]
-    _partner_player_name: str = None # type: ignore [assignment]
-    _your_player_id: int = None # type: ignore [assignment]
-    _your_player_name: str = None # type: ignore [assignment]
+    _partner_player_id: int
+    _partner_player_name: str
+    _your_player_id: int
+    _your_player_name: str
+
+    def __init__(self, *, partner_player_id: int, partner_player_name: str, your_player_id: int, your_player_name: str):
+        """
+        Create a new instance of TradeOpenServerPacket.
+
+        Args:
+            partner_player_id (int): (Value range is 0-64008.)
+            partner_player_name (str): 
+            your_player_id (int): (Value range is 0-64008.)
+            your_player_name (str): 
+        """
+        self._partner_player_id = partner_player_id
+        self._partner_player_name = partner_player_name
+        self._your_player_id = your_player_id
+        self._your_player_name = your_player_name
 
     @property
     def byte_size(self) -> int:
@@ -32,52 +47,20 @@ class TradeOpenServerPacket(Packet):
 
     @property
     def partner_player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._partner_player_id
 
-    @partner_player_id.setter
-    def partner_player_id(self, partner_player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._partner_player_id = partner_player_id
-
     @property
     def partner_player_name(self) -> str:
         return self._partner_player_name
 
-    @partner_player_name.setter
-    def partner_player_name(self, partner_player_name: str) -> None:
-        self._partner_player_name = partner_player_name
-
     @property
     def your_player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._your_player_id
 
-    @your_player_id.setter
-    def your_player_id(self, your_player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._your_player_id = your_player_id
-
     @property
     def your_player_name(self) -> str:
         return self._your_player_name
 
-    @your_player_name.setter
-    def your_player_name(self, your_player_name: str) -> None:
-        self._your_player_name = your_player_name
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -116,20 +99,26 @@ class TradeOpenServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (TradeOpenServerPacket): The data to serialize.
         """
-        if data._partner_player_id is None:
-            raise SerializationError("partner_player_id must be provided.")
-        writer.add_short(data._partner_player_id)
-        if data._partner_player_name is None:
-            raise SerializationError("partner_player_name must be provided.")
-        writer.add_string(data._partner_player_name)
-        writer.add_byte(0xFF)
-        if data._your_player_id is None:
-            raise SerializationError("your_player_id must be provided.")
-        writer.add_short(data._your_player_id)
-        if data._your_player_name is None:
-            raise SerializationError("your_player_name must be provided.")
-        writer.add_string(data._your_player_name)
-        writer.add_byte(0xFF)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._partner_player_id is None:
+                raise SerializationError("partner_player_id must be provided.")
+            writer.add_short(data._partner_player_id)
+            if data._partner_player_name is None:
+                raise SerializationError("partner_player_name must be provided.")
+            writer.add_string(data._partner_player_name)
+            writer.add_byte(0xFF)
+            if data._your_player_id is None:
+                raise SerializationError("your_player_id must be provided.")
+            writer.add_short(data._your_player_id)
+            if data._your_player_name is None:
+                raise SerializationError("your_player_name must be provided.")
+            writer.add_string(data._your_player_name)
+            writer.add_byte(0xFF)
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "TradeOpenServerPacket":
@@ -142,20 +131,20 @@ class TradeOpenServerPacket(Packet):
         Returns:
             TradeOpenServerPacket: The data to serialize.
         """
-        data: TradeOpenServerPacket = TradeOpenServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._partner_player_id = reader.get_short()
-            data._partner_player_name = reader.get_string()
+            partner_player_id = reader.get_short()
+            partner_player_name = reader.get_string()
             reader.next_chunk()
-            data._your_player_id = reader.get_short()
-            data._your_player_name = reader.get_string()
+            your_player_id = reader.get_short()
+            your_player_name = reader.get_string()
             reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = TradeOpenServerPacket(partner_player_id=partner_player_id, partner_player_name=partner_player_name, your_player_id=your_player_id, your_player_name=your_player_name)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode