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

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

@@ -15,6 +15,11 @@ class MessagePingClientPacket(Packet):
     """
     _byte_size: int = 0
 
+    def __init__(self):
+        """
+        Create a new instance of MessagePingClientPacket.
+        """
+
     @property
     def byte_size(self) -> int:
         """
@@ -63,9 +68,11 @@ class MessagePingClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (MessagePingClientPacket): The data to serialize.
         """
-        old_writer_length: int = len(writer)
-        if len(writer) == old_writer_length:
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
             writer.add_short(2)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "MessagePingClientPacket":
@@ -78,14 +85,13 @@ class MessagePingClientPacket(Packet):
         Returns:
             MessagePingClientPacket: The data to serialize.
         """
-        data: MessagePingClientPacket = MessagePingClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            if reader.position == reader_start_position:
-                reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            reader.get_short()
+            result = MessagePingClientPacket()
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

eolib/protocol/_generated/net/client/npc_range_request_client_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,8 +17,18 @@ class NpcRangeRequestClientPacket(Packet):
     Requesting info about nearby NPCs
     """
     _byte_size: int = 0
-    _npc_indexes_length: int = None # type: ignore [assignment]
-    _npc_indexes: list[int] = None # type: ignore [assignment]
+    _npc_indexes_length: int
+    _npc_indexes: tuple[int, ...]
+
+    def __init__(self, *, npc_indexes: Iterable[int]):
+        """
+        Create a new instance of NpcRangeRequestClientPacket.
+
+        Args:
+            npc_indexes (Iterable[int]): (Length must be 252 or less.) (Element value range is 0-252.)
+        """
+        self._npc_indexes = tuple(npc_indexes)
+        self._npc_indexes_length = len(self._npc_indexes)
 
     @property
     def byte_size(self) -> int:
@@ -30,24 +41,9 @@ class NpcRangeRequestClientPacket(Packet):
         return self._byte_size
 
     @property
-    def npc_indexes(self) -> list[int]:
-        """
-        Note:
-          - Length must be 252 or less.
-          - Element value range is 0-252.
-        """
+    def npc_indexes(self) -> tuple[int, ...]:
         return self._npc_indexes
 
-    @npc_indexes.setter
-    def npc_indexes(self, npc_indexes: list[int]) -> None:
-        """
-        Note:
-          - Length must be 252 or less.
-          - Element value range is 0-252.
-        """
-        self._npc_indexes = npc_indexes
-        self._npc_indexes_length = len(self._npc_indexes)
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -86,16 +82,20 @@ class NpcRangeRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (NpcRangeRequestClientPacket): The data to serialize.
         """
-        if data._npc_indexes_length is None:
-            raise SerializationError("npc_indexes_length must be provided.")
-        writer.add_char(data._npc_indexes_length)
-        writer.add_byte(255)
-        if data._npc_indexes is None:
-            raise SerializationError("npc_indexes must be provided.")
-        if len(data._npc_indexes) > 252:
-            raise SerializationError(f"Expected length of npc_indexes to be 252 or less, got {len(data._npc_indexes)}.")
-        for i in range(data._npc_indexes_length):
-            writer.add_char(data._npc_indexes[i])
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._npc_indexes_length is None:
+                raise SerializationError("npc_indexes_length must be provided.")
+            writer.add_char(data._npc_indexes_length)
+            writer.add_byte(255)
+            if data._npc_indexes is None:
+                raise SerializationError("npc_indexes must be provided.")
+            if len(data._npc_indexes) > 252:
+                raise SerializationError(f"Expected length of npc_indexes to be 252 or less, got {len(data._npc_indexes)}.")
+            for i in range(data._npc_indexes_length):
+                writer.add_char(data._npc_indexes[i])
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "NpcRangeRequestClientPacket":
@@ -108,17 +108,17 @@ class NpcRangeRequestClientPacket(Packet):
         Returns:
             NpcRangeRequestClientPacket: The data to serialize.
         """
-        data: NpcRangeRequestClientPacket = NpcRangeRequestClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._npc_indexes_length = reader.get_char()
+            npc_indexes_length = reader.get_char()
             reader.get_byte()
-            data._npc_indexes = []
-            for i in range(data._npc_indexes_length):
-                data._npc_indexes.append(reader.get_char())
-            data._byte_size = reader.position - reader_start_position
-            return data
+            npc_indexes = []
+            for i in range(npc_indexes_length):
+                npc_indexes.append(reader.get_char())
+            result = NpcRangeRequestClientPacket(npc_indexes=npc_indexes)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

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

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

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

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

@@ -12,10 +12,19 @@ from .....data.eo_reader import EoReader
 
 class PaperdollRequestClientPacket(Packet):
     """
-    Request for a player's paperdoll
+    Request for a player's paperdoll
     """
     _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 PaperdollRequestClientPacket.
+
+        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 PaperdollRequestClientPacket(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:
         """
@@ -81,9 +78,13 @@ class PaperdollRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PaperdollRequestClientPacket): The data to serialize.
         """
-        if data._player_id is None:
-            raise SerializationError("player_id must be provided.")
-        writer.add_short(data._player_id)
+        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)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PaperdollRequestClientPacket":
@@ -96,13 +97,13 @@ class PaperdollRequestClientPacket(Packet):
         Returns:
             PaperdollRequestClientPacket: The data to serialize.
         """
-        data: PaperdollRequestClientPacket = PaperdollRequestClientPacket()
         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 = PaperdollRequestClientPacket(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/client/party_accept_client_packet.py

@@ -16,8 +16,19 @@ class PartyAcceptClientPacket(Packet):
     Accept party invite / join request
     """
     _byte_size: int = 0
-    _request_type: PartyRequestType = None # type: ignore [assignment]
-    _inviter_player_id: int = None # type: ignore [assignment]
+    _request_type: PartyRequestType
+    _inviter_player_id: int
+
+    def __init__(self, *, request_type: PartyRequestType, inviter_player_id: int):
+        """
+        Create a new instance of PartyAcceptClientPacket.
+
+        Args:
+            request_type (PartyRequestType): 
+            inviter_player_id (int): (Value range is 0-64008.)
+        """
+        self._request_type = request_type
+        self._inviter_player_id = inviter_player_id
 
     @property
     def byte_size(self) -> int:
@@ -33,26 +44,10 @@ class PartyAcceptClientPacket(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
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -91,12 +86,16 @@ class PartyAcceptClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PartyAcceptClientPacket): The data to serialize.
         """
-        if data._request_type is None:
-            raise SerializationError("request_type must be provided.")
-        writer.add_char(int(data._request_type))
-        if data._inviter_player_id is None:
-            raise SerializationError("inviter_player_id must be provided.")
-        writer.add_short(data._inviter_player_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._request_type is None:
+                raise SerializationError("request_type must be provided.")
+            writer.add_char(int(data._request_type))
+            if data._inviter_player_id is None:
+                raise SerializationError("inviter_player_id must be provided.")
+            writer.add_short(data._inviter_player_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PartyAcceptClientPacket":
@@ -109,14 +108,14 @@ class PartyAcceptClientPacket(Packet):
         Returns:
             PartyAcceptClientPacket: The data to serialize.
         """
-        data: PartyAcceptClientPacket = PartyAcceptClientPacket()
         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._byte_size = reader.position - reader_start_position
-            return data
+            request_type = PartyRequestType(reader.get_char())
+            inviter_player_id = reader.get_short()
+            result = PartyAcceptClientPacket(request_type=request_type, inviter_player_id=inviter_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/client/party_remove_client_packet.py

@@ -15,7 +15,16 @@ class PartyRemoveClientPacket(Packet):
     Remove player from a 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 PartyRemoveClientPacket.
+
+        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 PartyRemoveClientPacket(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:
         """
@@ -81,9 +78,13 @@ class PartyRemoveClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PartyRemoveClientPacket): The data to serialize.
         """
-        if data._player_id is None:
-            raise SerializationError("player_id must be provided.")
-        writer.add_short(data._player_id)
+        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)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PartyRemoveClientPacket":
@@ -96,13 +97,13 @@ class PartyRemoveClientPacket(Packet):
         Returns:
             PartyRemoveClientPacket: The data to serialize.
         """
-        data: PartyRemoveClientPacket = PartyRemoveClientPacket()
         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 = PartyRemoveClientPacket(player_id=player_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode