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

eolib/protocol/_generated/net/server/party_list_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 .party_member import PartyMember
 from ..packet_family import PacketFamily
 from ..packet_action import PacketAction
@@ -17,7 +18,16 @@ class PartyListServerPacket(Packet):
     Party member list update
     """
     _byte_size: int = 0
-    _members: list[PartyMember] = None # type: ignore [assignment]
+    _members: tuple[PartyMember, ...]
+
+    def __init__(self, *, members: Iterable[PartyMember]):
+        """
+        Create a new instance of PartyListServerPacket.
+
+        Args:
+            members (Iterable[PartyMember]): 
+        """
+        self._members = tuple(members)
 
     @property
     def byte_size(self) -> int:
@@ -30,13 +40,9 @@ class PartyListServerPacket(Packet):
         return self._byte_size
 
     @property
-    def members(self) -> list[PartyMember]:
+    def members(self) -> tuple[PartyMember, ...]:
         return self._members
 
-    @members.setter
-    def members(self, members: list[PartyMember]) -> None:
-        self._members = members
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -98,18 +104,18 @@ class PartyListServerPacket(Packet):
         Returns:
             PartyListServerPacket: The data to serialize.
         """
-        data: PartyListServerPacket = PartyListServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._members = []
+            members = []
             while reader.remaining > 0:
-                data._members.append(PartyMember.deserialize(reader))
+                members.append(PartyMember.deserialize(reader))
                 reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = PartyListServerPacket(members=members)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -12,11 +12,28 @@ class PartyMember:
     A member of the player's party
     """
     _byte_size: int = 0
-    _player_id: int = None # type: ignore [assignment]
-    _leader: bool = None # type: ignore [assignment]
-    _level: int = None # type: ignore [assignment]
-    _hp_percentage: int = None # type: ignore [assignment]
-    _name: str = None # type: ignore [assignment]
+    _player_id: int
+    _leader: bool
+    _level: int
+    _hp_percentage: int
+    _name: str
+
+    def __init__(self, *, player_id: int, leader: bool, level: int, hp_percentage: int, name: str):
+        """
+        Create a new instance of PartyMember.
+
+        Args:
+            player_id (int): (Value range is 0-64008.)
+            leader (bool): 
+            level (int): (Value range is 0-252.)
+            hp_percentage (int): (Value range is 0-252.)
+            name (str): 
+        """
+        self._player_id = player_id
+        self._leader = leader
+        self._level = level
+        self._hp_percentage = hp_percentage
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -30,68 +47,24 @@ class PartyMember:
 
     @property
     def player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._player_id
 
-    @player_id.setter
-    def player_id(self, player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._player_id = player_id
-
     @property
     def leader(self) -> bool:
         return self._leader
 
-    @leader.setter
-    def leader(self, leader: bool) -> None:
-        self._leader = leader
-
     @property
     def level(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._level
 
-    @level.setter
-    def level(self, level: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._level = level
-
     @property
     def hp_percentage(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._hp_percentage
 
-    @hp_percentage.setter
-    def hp_percentage(self, hp_percentage: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._hp_percentage = hp_percentage
-
     @property
     def name(self) -> str:
         return self._name
 
-    @name.setter
-    def name(self, name: str) -> None:
-        self._name = name
-
     @staticmethod
     def serialize(writer: EoWriter, data: "PartyMember") -> None:
         """
@@ -132,17 +105,17 @@ class PartyMember:
         Returns:
             PartyMember: The data to serialize.
         """
-        data: PartyMember = PartyMember()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._player_id = reader.get_short()
-            data._leader = reader.get_char() != 0
-            data._level = reader.get_char()
-            data._hp_percentage = reader.get_char()
-            data._name = reader.get_string()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            player_id = reader.get_short()
+            leader = reader.get_char() != 0
+            level = reader.get_char()
+            hp_percentage = reader.get_char()
+            name = reader.get_string()
+            result = PartyMember(player_id=player_id, leader=leader, level=level, hp_percentage=hp_percentage, name=name)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,7 +15,16 @@ class PartyRemoveServerPacket(Packet):
     Player left the party
     """
     _byte_size: int = 0
-    _player_id: int = None # type: ignore [assignment]
+    _player_id: int
+
+    def __init__(self, *, player_id: int):
+        """
+        Create a new instance of PartyRemoveServerPacket.
+
+        Args:
+            player_id (int): (Value range is 0-64008.)
+        """
+        self._player_id = player_id
 
     @property
     def byte_size(self) -> int:
@@ -29,20 +38,8 @@ class PartyRemoveServerPacket(Packet):
 
     @property
     def player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._player_id
 
-    @player_id.setter
-    def player_id(self, player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._player_id = player_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -100,13 +97,13 @@ class PartyRemoveServerPacket(Packet):
         Returns:
             PartyRemoveServerPacket: The data to serialize.
         """
-        data: PartyRemoveServerPacket = PartyRemoveServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._player_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            player_id = reader.get_short()
+            result = PartyRemoveServerPacket(player_id=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/party_reply_server_packet.py

@@ -17,8 +17,19 @@ class PartyReplyServerPacket(Packet):
     Failed party invite / join request
     """
     _byte_size: int = 0
-    _reply_code: PartyReplyCode = None # type: ignore [assignment]
-    _reply_code_data: 'PartyReplyServerPacket.ReplyCodeData' = None
+    _reply_code: PartyReplyCode
+    _reply_code_data: 'PartyReplyServerPacket.ReplyCodeData'
+
+    def __init__(self, *, reply_code: PartyReplyCode, reply_code_data: 'PartyReplyServerPacket.ReplyCodeData' = None):
+        """
+        Create a new instance of PartyReplyServerPacket.
+
+        Args:
+            reply_code (PartyReplyCode): 
+            reply_code_data (PartyReplyServerPacket.ReplyCodeData): Data associated with the `reply_code` field.
+        """
+        self._reply_code = reply_code
+        self._reply_code_data = reply_code_data
 
     @property
     def byte_size(self) -> int:
@@ -34,21 +45,13 @@ class PartyReplyServerPacket(Packet):
     def reply_code(self) -> PartyReplyCode:
         return self._reply_code
 
-    @reply_code.setter
-    def reply_code(self, reply_code: PartyReplyCode) -> None:
-        self._reply_code = reply_code
-
     @property
     def reply_code_data(self) -> 'PartyReplyServerPacket.ReplyCodeData':
         """
-        PartyReplyServerPacket.ReplyCodeData: Gets or sets the data associated with the `reply_code` field.
+        PartyReplyServerPacket.ReplyCodeData: Data associated with the `reply_code` field.
         """
         return self._reply_code_data
 
-    @reply_code_data.setter
-    def reply_code_data(self, reply_code_data: 'PartyReplyServerPacket.ReplyCodeData') -> None:
-        self._reply_code_data = reply_code_data
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -114,17 +117,18 @@ class PartyReplyServerPacket(Packet):
         Returns:
             PartyReplyServerPacket: The data to serialize.
         """
-        data: PartyReplyServerPacket = PartyReplyServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._reply_code = PartyReplyCode(reader.get_char())
-            if data._reply_code == PartyReplyCode.AlreadyInAnotherParty:
-                data._reply_code_data = PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty.deserialize(reader)
-            elif data._reply_code == PartyReplyCode.AlreadyInYourParty:
-                data._reply_code_data = PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            reply_code = PartyReplyCode(reader.get_char())
+            reply_code_data: PartyReplyServerPacket.ReplyCodeData = None
+            if reply_code == PartyReplyCode.AlreadyInAnotherParty:
+                reply_code_data = PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty.deserialize(reader)
+            elif reply_code == PartyReplyCode.AlreadyInYourParty:
+                reply_code_data = PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty.deserialize(reader)
+            result = PartyReplyServerPacket(reply_code=reply_code, reply_code_data=reply_code_data)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 
@@ -141,7 +145,16 @@ class PartyReplyServerPacket(Packet):
         Data associated with reply_code value PartyReplyCode.AlreadyInAnotherParty
         """
         _byte_size: int = 0
-        _player_name: str = None # type: ignore [assignment]
+        _player_name: str
+
+        def __init__(self, *, player_name: str):
+            """
+            Create a new instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty.
+
+            Args:
+                player_name (str): 
+            """
+            self._player_name = player_name
 
         @property
         def byte_size(self) -> int:
@@ -157,10 +170,6 @@ class PartyReplyServerPacket(Packet):
         def player_name(self) -> str:
             return self._player_name
 
-        @player_name.setter
-        def player_name(self, player_name: str) -> None:
-            self._player_name = player_name
-
         @staticmethod
         def serialize(writer: EoWriter, data: "PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty") -> None:
             """
@@ -189,13 +198,13 @@ class PartyReplyServerPacket(Packet):
             Returns:
                 PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty: The data to serialize.
             """
-            data: PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty = PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty()
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
-                data._player_name = reader.get_string()
-                data._byte_size = reader.position - reader_start_position
-                return data
+                player_name = reader.get_string()
+                result = PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty(player_name=player_name)
+                result._byte_size = reader.position - reader_start_position
+                return result
             finally:
                 reader.chunked_reading_mode = old_chunked_reading_mode
 
@@ -207,7 +216,16 @@ class PartyReplyServerPacket(Packet):
         Data associated with reply_code value PartyReplyCode.AlreadyInYourParty
         """
         _byte_size: int = 0
-        _player_name: str = None # type: ignore [assignment]
+        _player_name: str
+
+        def __init__(self, *, player_name: str):
+            """
+            Create a new instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty.
+
+            Args:
+                player_name (str): 
+            """
+            self._player_name = player_name
 
         @property
         def byte_size(self) -> int:
@@ -223,10 +241,6 @@ class PartyReplyServerPacket(Packet):
         def player_name(self) -> str:
             return self._player_name
 
-        @player_name.setter
-        def player_name(self, player_name: str) -> None:
-            self._player_name = player_name
-
         @staticmethod
         def serialize(writer: EoWriter, data: "PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty") -> None:
             """
@@ -255,13 +269,13 @@ class PartyReplyServerPacket(Packet):
             Returns:
                 PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty: The data to serialize.
             """
-            data: PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty = PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty()
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
-                data._player_name = reader.get_string()
-                data._byte_size = reader.position - reader_start_position
-                return data
+                player_name = reader.get_string()
+                result = PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty(player_name=player_name)
+                result._byte_size = reader.position - reader_start_position
+                return result
             finally:
                 reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -16,9 +16,22 @@ class PartyRequestServerPacket(Packet):
     Received party invite / join request
     """
     _byte_size: int = 0
-    _request_type: PartyRequestType = None # type: ignore [assignment]
-    _inviter_player_id: int = None # type: ignore [assignment]
-    _player_name: str = None # type: ignore [assignment]
+    _request_type: PartyRequestType
+    _inviter_player_id: int
+    _player_name: str
+
+    def __init__(self, *, request_type: PartyRequestType, inviter_player_id: int, player_name: str):
+        """
+        Create a new instance of PartyRequestServerPacket.
+
+        Args:
+            request_type (PartyRequestType): 
+            inviter_player_id (int): (Value range is 0-64008.)
+            player_name (str): 
+        """
+        self._request_type = request_type
+        self._inviter_player_id = inviter_player_id
+        self._player_name = player_name
 
     @property
     def byte_size(self) -> int:
@@ -34,34 +47,14 @@ class PartyRequestServerPacket(Packet):
     def request_type(self) -> PartyRequestType:
         return self._request_type
 
-    @request_type.setter
-    def request_type(self, request_type: PartyRequestType) -> None:
-        self._request_type = request_type
-
     @property
     def inviter_player_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._inviter_player_id
 
-    @inviter_player_id.setter
-    def inviter_player_id(self, inviter_player_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._inviter_player_id = inviter_player_id
-
     @property
     def player_name(self) -> str:
         return self._player_name
 
-    @player_name.setter
-    def player_name(self, player_name: str) -> None:
-        self._player_name = player_name
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -125,15 +118,15 @@ class PartyRequestServerPacket(Packet):
         Returns:
             PartyRequestServerPacket: The data to serialize.
         """
-        data: PartyRequestServerPacket = PartyRequestServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._request_type = PartyRequestType(reader.get_char())
-            data._inviter_player_id = reader.get_short()
-            data._player_name = reader.get_string()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            request_type = PartyRequestType(reader.get_char())
+            inviter_player_id = reader.get_short()
+            player_name = reader.get_string()
+            result = PartyRequestServerPacket(request_type=request_type, inviter_player_id=inviter_player_id, player_name=player_name)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/server/party_target_group_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 .party_exp_share import PartyExpShare
 from ..packet_family import PacketFamily
 from ..packet_action import PacketAction
@@ -17,7 +18,16 @@ class PartyTargetGroupServerPacket(Packet):
     Updated experience and level-ups from party experience
     """
     _byte_size: int = 0
-    _gains: list[PartyExpShare] = None # type: ignore [assignment]
+    _gains: tuple[PartyExpShare, ...]
+
+    def __init__(self, *, gains: Iterable[PartyExpShare]):
+        """
+        Create a new instance of PartyTargetGroupServerPacket.
+
+        Args:
+            gains (Iterable[PartyExpShare]): 
+        """
+        self._gains = tuple(gains)
 
     @property
     def byte_size(self) -> int:
@@ -30,13 +40,9 @@ class PartyTargetGroupServerPacket(Packet):
         return self._byte_size
 
     @property
-    def gains(self) -> list[PartyExpShare]:
+    def gains(self) -> tuple[PartyExpShare, ...]:
         return self._gains
 
-    @gains.setter
-    def gains(self, gains: list[PartyExpShare]) -> None:
-        self._gains = gains
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -95,16 +101,16 @@ class PartyTargetGroupServerPacket(Packet):
         Returns:
             PartyTargetGroupServerPacket: The data to serialize.
         """
-        data: PartyTargetGroupServerPacket = PartyTargetGroupServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             gains_length = int(reader.remaining / 7)
-            data._gains = []
+            gains = []
             for i in range(gains_length):
-                data._gains.append(PartyExpShare.deserialize(reader))
-            data._byte_size = reader.position - reader_start_position
-            return data
+                gains.append(PartyExpShare.deserialize(reader))
+            result = PartyTargetGroupServerPacket(gains=gains)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

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