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

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

@@ -4,6 +4,7 @@
 # Changes will be lost when code is regenerated.
 
 from __future__ import annotations
+from collections.abc import Iterable
 from .online_player import OnlinePlayer
 from ....serialization_error import SerializationError
 from .....data.eo_writer import EoWriter
@@ -14,8 +15,18 @@ class PlayersList:
     Information about online players
     """
     _byte_size: int = 0
-    _players_count: int = None # type: ignore [assignment]
-    _players: list[OnlinePlayer] = None # type: ignore [assignment]
+    _players_count: int
+    _players: tuple[OnlinePlayer, ...]
+
+    def __init__(self, *, players: Iterable[OnlinePlayer]):
+        """
+        Create a new instance of PlayersList.
+
+        Args:
+            players (Iterable[OnlinePlayer]): (Length must be 64008 or less.)
+        """
+        self._players = tuple(players)
+        self._players_count = len(self._players)
 
     @property
     def byte_size(self) -> int:
@@ -28,22 +39,9 @@ class PlayersList:
         return self._byte_size
 
     @property
-    def players(self) -> list[OnlinePlayer]:
-        """
-        Note:
-          - Length must be 64008 or less.
-        """
+    def players(self) -> tuple[OnlinePlayer, ...]:
         return self._players
 
-    @players.setter
-    def players(self, players: list[OnlinePlayer]) -> None:
-        """
-        Note:
-          - Length must be 64008 or less.
-        """
-        self._players = players
-        self._players_count = len(self._players)
-
     @staticmethod
     def serialize(writer: EoWriter, data: "PlayersList") -> None:
         """
@@ -53,18 +51,23 @@ class PlayersList:
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersList): The data to serialize.
         """
-        if data._players_count is None:
-            raise SerializationError("players_count must be provided.")
-        writer.add_short(data._players_count)
-        writer.add_byte(0xFF)
-        if data._players is None:
-            raise SerializationError("players must be provided.")
-        if len(data._players) > 64008:
-            raise SerializationError(f"Expected length of players to be 64008 or less, got {len(data._players)}.")
-        for i in range(data._players_count):
-            if i > 0:
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._players_count is None:
+                raise SerializationError("players_count must be provided.")
+            writer.add_short(data._players_count)
+            writer.add_byte(0xFF)
+            if data._players is None:
+                raise SerializationError("players must be provided.")
+            if len(data._players) > 64008:
+                raise SerializationError(f"Expected length of players to be 64008 or less, got {len(data._players)}.")
+            for i in range(data._players_count):
+                OnlinePlayer.serialize(writer, data._players[i])
                 writer.add_byte(0xFF)
-            OnlinePlayer.serialize(writer, data._players[i])
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PlayersList":
@@ -77,21 +80,20 @@ class PlayersList:
         Returns:
             PlayersList: The data to serialize.
         """
-        data: PlayersList = PlayersList()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._players_count = reader.get_short()
+            players_count = reader.get_short()
             reader.next_chunk()
-            data._players = []
-            for i in range(data._players_count):
-                data._players.append(OnlinePlayer.deserialize(reader))
-                if i + 1 < data._players_count:
-                    reader.next_chunk()
+            players = []
+            for i in range(players_count):
+                players.append(OnlinePlayer.deserialize(reader))
+                reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = PlayersList(players=players)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -4,6 +4,7 @@
 # Changes will be lost when code is regenerated.
 
 from __future__ import annotations
+from collections.abc import Iterable
 from ....serialization_error import SerializationError
 from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
@@ -14,8 +15,18 @@ class PlayersListFriends:
     Sent in reply to friends list requests.
     """
     _byte_size: int = 0
-    _players_count: int = None # type: ignore [assignment]
-    _players: list[str] = None # type: ignore [assignment]
+    _players_count: int
+    _players: tuple[str, ...]
+
+    def __init__(self, *, players: Iterable[str]):
+        """
+        Create a new instance of PlayersListFriends.
+
+        Args:
+            players (Iterable[str]): (Length must be 64008 or less.)
+        """
+        self._players = tuple(players)
+        self._players_count = len(self._players)
 
     @property
     def byte_size(self) -> int:
@@ -28,22 +39,9 @@ class PlayersListFriends:
         return self._byte_size
 
     @property
-    def players(self) -> list[str]:
-        """
-        Note:
-          - Length must be 64008 or less.
-        """
+    def players(self) -> tuple[str, ...]:
         return self._players
 
-    @players.setter
-    def players(self, players: list[str]) -> None:
-        """
-        Note:
-          - Length must be 64008 or less.
-        """
-        self._players = players
-        self._players_count = len(self._players)
-
     @staticmethod
     def serialize(writer: EoWriter, data: "PlayersListFriends") -> None:
         """
@@ -53,18 +51,23 @@ class PlayersListFriends:
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersListFriends): The data to serialize.
         """
-        if data._players_count is None:
-            raise SerializationError("players_count must be provided.")
-        writer.add_short(data._players_count)
-        writer.add_byte(0xFF)
-        if data._players is None:
-            raise SerializationError("players must be provided.")
-        if len(data._players) > 64008:
-            raise SerializationError(f"Expected length of players to be 64008 or less, got {len(data._players)}.")
-        for i in range(data._players_count):
-            if i > 0:
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._players_count is None:
+                raise SerializationError("players_count must be provided.")
+            writer.add_short(data._players_count)
+            writer.add_byte(0xFF)
+            if data._players is None:
+                raise SerializationError("players must be provided.")
+            if len(data._players) > 64008:
+                raise SerializationError(f"Expected length of players to be 64008 or less, got {len(data._players)}.")
+            for i in range(data._players_count):
+                writer.add_string(data._players[i])
                 writer.add_byte(0xFF)
-            writer.add_string(data._players[i])
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PlayersListFriends":
@@ -77,21 +80,20 @@ class PlayersListFriends:
         Returns:
             PlayersListFriends: The data to serialize.
         """
-        data: PlayersListFriends = PlayersListFriends()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._players_count = reader.get_short()
+            players_count = reader.get_short()
             reader.next_chunk()
-            data._players = []
-            for i in range(data._players_count):
-                data._players.append(reader.get_string())
-                if i + 1 < data._players_count:
-                    reader.next_chunk()
+            players = []
+            for i in range(players_count):
+                players.append(reader.get_string())
+                reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = PlayersListFriends(players=players)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

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

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

@@ -15,7 +15,16 @@ class PlayersNet242ServerPacket(Packet):
     #find command reply - different map
     """
     _byte_size: int = 0
-    _name: str = None # type: ignore [assignment]
+    _name: str
+
+    def __init__(self, *, name: str):
+        """
+        Create a new instance of PlayersNet242ServerPacket.
+
+        Args:
+            name (str): 
+        """
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -31,10 +40,6 @@ class PlayersNet242ServerPacket(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 PlayersNet242ServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersNet242ServerPacket): 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) -> "PlayersNet242ServerPacket":
@@ -88,13 +97,13 @@ class PlayersNet242ServerPacket(Packet):
         Returns:
             PlayersNet242ServerPacket: The data to serialize.
         """
-        data: PlayersNet242ServerPacket = PlayersNet242ServerPacket()
         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 = PlayersNet242ServerPacket(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/players_ping_server_packet.py

@@ -15,7 +15,16 @@ class PlayersPingServerPacket(Packet):
     #find command reply - offline
     """
     _byte_size: int = 0
-    _name: str = None # type: ignore [assignment]
+    _name: str
+
+    def __init__(self, *, name: str):
+        """
+        Create a new instance of PlayersPingServerPacket.
+
+        Args:
+            name (str): 
+        """
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -31,10 +40,6 @@ class PlayersPingServerPacket(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 PlayersPingServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersPingServerPacket): 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) -> "PlayersPingServerPacket":
@@ -88,13 +97,13 @@ class PlayersPingServerPacket(Packet):
         Returns:
             PlayersPingServerPacket: The data to serialize.
         """
-        data: PlayersPingServerPacket = PlayersPingServerPacket()
         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 = PlayersPingServerPacket(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/players_pong_server_packet.py

@@ -15,7 +15,16 @@ class PlayersPongServerPacket(Packet):
     #find command reply - same map
     """
     _byte_size: int = 0
-    _name: str = None # type: ignore [assignment]
+    _name: str
+
+    def __init__(self, *, name: str):
+        """
+        Create a new instance of PlayersPongServerPacket.
+
+        Args:
+            name (str): 
+        """
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -31,10 +40,6 @@ class PlayersPongServerPacket(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 PlayersPongServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersPongServerPacket): 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) -> "PlayersPongServerPacket":
@@ -88,13 +97,13 @@ class PlayersPongServerPacket(Packet):
         Returns:
             PlayersPongServerPacket: The data to serialize.
         """
-        data: PlayersPongServerPacket = PlayersPongServerPacket()
         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 = PlayersPongServerPacket(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/players_remove_server_packet.py

@@ -15,7 +15,16 @@ class PlayersRemoveServerPacket(Packet):
     Nearby player has logged out
     """
     _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 PlayersRemoveServerPacket.
+
+        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 PlayersRemoveServerPacket(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 PlayersRemoveServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PlayersRemoveServerPacket): 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) -> "PlayersRemoveServerPacket":
@@ -96,13 +97,13 @@ class PlayersRemoveServerPacket(Packet):
         Returns:
             PlayersRemoveServerPacket: The data to serialize.
         """
-        data: PlayersRemoveServerPacket = PlayersRemoveServerPacket()
         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 = PlayersRemoveServerPacket(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/players_reply_server_packet.py

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