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

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

@@ -16,8 +16,19 @@ class PartyRequestClientPacket(Packet):
     Send party invite / join request
     """
     _byte_size: int = 0
-    _request_type: PartyRequestType = None # type: ignore [assignment]
-    _player_id: int = None # type: ignore [assignment]
+    _request_type: PartyRequestType
+    _player_id: int
+
+    def __init__(self, *, request_type: PartyRequestType, player_id: int):
+        """
+        Create a new instance of PartyRequestClientPacket.
+
+        Args:
+            request_type (PartyRequestType): 
+            player_id (int): (Value range is 0-64008.)
+        """
+        self._request_type = request_type
+        self._player_id = player_id
 
     @property
     def byte_size(self) -> int:
@@ -33,26 +44,10 @@ class PartyRequestClientPacket(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 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:
         """
@@ -91,12 +86,16 @@ class PartyRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PartyRequestClientPacket): 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._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._request_type is None:
+                raise SerializationError("request_type must be provided.")
+            writer.add_char(int(data._request_type))
+            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) -> "PartyRequestClientPacket":
@@ -109,14 +108,14 @@ class PartyRequestClientPacket(Packet):
         Returns:
             PartyRequestClientPacket: The data to serialize.
         """
-        data: PartyRequestClientPacket = PartyRequestClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._request_type = PartyRequestType(reader.get_char())
-            data._player_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            request_type = PartyRequestType(reader.get_char())
+            player_id = reader.get_short()
+            result = PartyRequestClientPacket(request_type=request_type, 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_take_client_packet.py

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

eolib/protocol/_generated/net/client/player_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,7 +17,16 @@ class PlayerRangeRequestClientPacket(Packet):
     Requesting info about nearby players
     """
     _byte_size: int = 0
-    _player_ids: list[int] = None # type: ignore [assignment]
+    _player_ids: tuple[int, ...]
+
+    def __init__(self, *, player_ids: Iterable[int]):
+        """
+        Create a new instance of PlayerRangeRequestClientPacket.
+
+        Args:
+            player_ids (Iterable[int]): (Element value range is 0-64008.)
+        """
+        self._player_ids = tuple(player_ids)
 
     @property
     def byte_size(self) -> int:
@@ -29,21 +39,9 @@ class PlayerRangeRequestClientPacket(Packet):
         return self._byte_size
 
     @property
-    def player_ids(self) -> list[int]:
-        """
-        Note:
-          - Element value range is 0-64008.
-        """
+    def player_ids(self) -> tuple[int, ...]:
         return self._player_ids
 
-    @player_ids.setter
-    def player_ids(self, player_ids: list[int]) -> None:
-        """
-        Note:
-          - Element value range is 0-64008.
-        """
-        self._player_ids = player_ids
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -82,10 +80,14 @@ class PlayerRangeRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayerRangeRequestClientPacket): The data to serialize.
         """
-        if data._player_ids is None:
-            raise SerializationError("player_ids must be provided.")
-        for i in range(len(data._player_ids)):
-            writer.add_short(data._player_ids[i])
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._player_ids is None:
+                raise SerializationError("player_ids must be provided.")
+            for i in range(len(data._player_ids)):
+                writer.add_short(data._player_ids[i])
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PlayerRangeRequestClientPacket":
@@ -98,16 +100,16 @@ class PlayerRangeRequestClientPacket(Packet):
         Returns:
             PlayerRangeRequestClientPacket: The data to serialize.
         """
-        data: PlayerRangeRequestClientPacket = PlayerRangeRequestClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             player_ids_length = int(reader.remaining / 2)
-            data._player_ids = []
+            player_ids = []
             for i in range(player_ids_length):
-                data._player_ids.append(reader.get_short())
-            data._byte_size = reader.position - reader_start_position
-            return data
+                player_ids.append(reader.get_short())
+            result = PlayerRangeRequestClientPacket(player_ids=player_ids)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,7 +15,16 @@ class PlayersAcceptClientPacket(Packet):
     #find command request
     """
     _byte_size: int = 0
-    _name: str = None # type: ignore [assignment]
+    _name: str
+
+    def __init__(self, *, name: str):
+        """
+        Create a new instance of PlayersAcceptClientPacket.
+
+        Args:
+            name (str): 
+        """
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -31,10 +40,6 @@ class PlayersAcceptClientPacket(Packet):
     def name(self) -> str:
         return self._name
 
-    @name.setter
-    def name(self, name: str) -> None:
-        self._name = name
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -73,9 +78,13 @@ class PlayersAcceptClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersAcceptClientPacket): The data to serialize.
         """
-        if data._name is None:
-            raise SerializationError("name must be provided.")
-        writer.add_string(data._name)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._name is None:
+                raise SerializationError("name must be provided.")
+            writer.add_string(data._name)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PlayersAcceptClientPacket":
@@ -88,13 +97,13 @@ class PlayersAcceptClientPacket(Packet):
         Returns:
             PlayersAcceptClientPacket: The data to serialize.
         """
-        data: PlayersAcceptClientPacket = PlayersAcceptClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._name = reader.get_string()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            name = reader.get_string()
+            result = PlayersAcceptClientPacket(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/client/players_list_client_packet.py

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

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

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

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

@@ -15,7 +15,16 @@ class PriestAcceptClientPacket(Packet):
     Accepting a marriage request
     """
     _byte_size: int = 0
-    _session_id: int = None # type: ignore [assignment]
+    _session_id: int
+
+    def __init__(self, *, session_id: int):
+        """
+        Create a new instance of PriestAcceptClientPacket.
+
+        Args:
+            session_id (int): (Value range is 0-64008.)
+        """
+        self._session_id = session_id
 
     @property
     def byte_size(self) -> int:
@@ -29,20 +38,8 @@ class PriestAcceptClientPacket(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
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -81,9 +78,13 @@ class PriestAcceptClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PriestAcceptClientPacket): The data to serialize.
         """
-        if data._session_id is None:
-            raise SerializationError("session_id must be provided.")
-        writer.add_short(data._session_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)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PriestAcceptClientPacket":
@@ -96,13 +97,13 @@ class PriestAcceptClientPacket(Packet):
         Returns:
             PriestAcceptClientPacket: The data to serialize.
         """
-        data: PriestAcceptClientPacket = PriestAcceptClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._session_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            session_id = reader.get_short()
+            result = PriestAcceptClientPacket(session_id=session_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/priest_open_client_packet.py

@@ -15,7 +15,16 @@ class PriestOpenClientPacket(Packet):
     Talking to a priest 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 PriestOpenClientPacket.
+
+        Args:
+            npc_index (int): (Value range is 0-4097152080.)
+        """
+        self._npc_index = npc_index
 
     @property
     def byte_size(self) -> int:
@@ -29,20 +38,8 @@ class PriestOpenClientPacket(Packet):
 
     @property
     def npc_index(self) -> int:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
         return self._npc_index
 
-    @npc_index.setter
-    def npc_index(self, npc_index: int) -> None:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
-        self._npc_index = npc_index
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -81,9 +78,13 @@ class PriestOpenClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PriestOpenClientPacket): The data to serialize.
         """
-        if data._npc_index is None:
-            raise SerializationError("npc_index must be provided.")
-        writer.add_int(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_int(data._npc_index)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PriestOpenClientPacket":
@@ -96,13 +97,13 @@ class PriestOpenClientPacket(Packet):
         Returns:
             PriestOpenClientPacket: The data to serialize.
         """
-        data: PriestOpenClientPacket = PriestOpenClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._npc_index = reader.get_int()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            npc_index = reader.get_int()
+            result = PriestOpenClientPacket(npc_index=npc_index)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,8 +15,19 @@ class PriestRequestClientPacket(Packet):
     Requesting marriage at a priest
     """
     _byte_size: int = 0
-    _session_id: int = None # type: ignore [assignment]
-    _name: str = None # type: ignore [assignment]
+    _session_id: int
+    _name: str
+
+    def __init__(self, *, session_id: int, name: str):
+        """
+        Create a new instance of PriestRequestClientPacket.
+
+        Args:
+            session_id (int): (Value range is 0-4097152080.)
+            name (str): 
+        """
+        self._session_id = session_id
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -30,28 +41,12 @@ class PriestRequestClientPacket(Packet):
 
     @property
     def session_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
         return self._session_id
 
-    @session_id.setter
-    def session_id(self, session_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
-        self._session_id = session_id
-
     @property
     def name(self) -> str:
         return self._name
 
-    @name.setter
-    def name(self, name: str) -> None:
-        self._name = name
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -90,13 +85,19 @@ class PriestRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PriestRequestClientPacket): The data to serialize.
         """
-        if data._session_id is None:
-            raise SerializationError("session_id must be provided.")
-        writer.add_int(data._session_id)
-        writer.add_byte(0xFF)
-        if data._name is None:
-            raise SerializationError("name must be provided.")
-        writer.add_string(data._name)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._session_id is None:
+                raise SerializationError("session_id must be provided.")
+            writer.add_int(data._session_id)
+            writer.add_byte(0xFF)
+            if data._name is None:
+                raise SerializationError("name must be provided.")
+            writer.add_string(data._name)
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PriestRequestClientPacket":
@@ -109,17 +110,17 @@ class PriestRequestClientPacket(Packet):
         Returns:
             PriestRequestClientPacket: The data to serialize.
         """
-        data: PriestRequestClientPacket = PriestRequestClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._session_id = reader.get_int()
+            session_id = reader.get_int()
             reader.next_chunk()
-            data._name = reader.get_string()
+            name = reader.get_string()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = PriestRequestClientPacket(session_id=session_id, name=name)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode