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

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

@@ -15,8 +15,19 @@ class BoardTakeClientPacket(Packet):
     Reading a post on a town board
     """
     _byte_size: int = 0
-    _board_id: int = None # type: ignore [assignment]
-    _post_id: int = None # type: ignore [assignment]
+    _board_id: int
+    _post_id: int
+
+    def __init__(self, *, board_id: int, post_id: int):
+        """
+        Create a new instance of BoardTakeClientPacket.
+
+        Args:
+            board_id (int): (Value range is 0-64008.)
+            post_id (int): (Value range is 0-64008.)
+        """
+        self._board_id = board_id
+        self._post_id = post_id
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +41,12 @@ class BoardTakeClientPacket(Packet):
 
     @property
     def board_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._board_id
 
-    @board_id.setter
-    def board_id(self, board_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._board_id = board_id
-
     @property
     def post_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._post_id
 
-    @post_id.setter
-    def post_id(self, post_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._post_id = post_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -98,12 +85,16 @@ class BoardTakeClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (BoardTakeClientPacket): The data to serialize.
         """
-        if data._board_id is None:
-            raise SerializationError("board_id must be provided.")
-        writer.add_short(data._board_id)
-        if data._post_id is None:
-            raise SerializationError("post_id must be provided.")
-        writer.add_short(data._post_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._board_id is None:
+                raise SerializationError("board_id must be provided.")
+            writer.add_short(data._board_id)
+            if data._post_id is None:
+                raise SerializationError("post_id must be provided.")
+            writer.add_short(data._post_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "BoardTakeClientPacket":
@@ -116,14 +107,14 @@ class BoardTakeClientPacket(Packet):
         Returns:
             BoardTakeClientPacket: The data to serialize.
         """
-        data: BoardTakeClientPacket = BoardTakeClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._board_id = reader.get_short()
-            data._post_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            board_id = reader.get_short()
+            post_id = reader.get_short()
+            result = BoardTakeClientPacket(board_id=board_id, post_id=post_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/book_request_client_packet.py

@@ -12,10 +12,19 @@ from .....data.eo_reader import EoReader
 
 class BookRequestClientPacket(Packet):
     """
-    Request for a player's book
+    Request for a player's book
     """
     _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 BookRequestClientPacket.
+
+        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 BookRequestClientPacket(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 BookRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (BookRequestClientPacket): 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) -> "BookRequestClientPacket":
@@ -96,13 +97,13 @@ class BookRequestClientPacket(Packet):
         Returns:
             BookRequestClientPacket: The data to serialize.
         """
-        data: BookRequestClientPacket = BookRequestClientPacket()
         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 = BookRequestClientPacket(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/byte_coords.py

@@ -12,8 +12,19 @@ class ByteCoords:
     Map coordinates with raw 1-byte values
     """
     _byte_size: int = 0
-    _x: int = None # type: ignore [assignment]
-    _y: int = None # type: ignore [assignment]
+    _x: int
+    _y: int
+
+    def __init__(self, *, x: int, y: int):
+        """
+        Create a new instance of ByteCoords.
+
+        Args:
+            x (int): (Value range is 0-255.)
+            y (int): (Value range is 0-255.)
+        """
+        self._x = x
+        self._y = y
 
     @property
     def byte_size(self) -> int:
@@ -27,36 +38,12 @@ class ByteCoords:
 
     @property
     def x(self) -> int:
-        """
-        Note:
-          - Value range is 0-255.
-        """
         return self._x
 
-    @x.setter
-    def x(self, x: int) -> None:
-        """
-        Note:
-          - Value range is 0-255.
-        """
-        self._x = x
-
     @property
     def y(self) -> int:
-        """
-        Note:
-          - Value range is 0-255.
-        """
         return self._y
 
-    @y.setter
-    def y(self, y: int) -> None:
-        """
-        Note:
-          - Value range is 0-255.
-        """
-        self._y = y
-
     @staticmethod
     def serialize(writer: EoWriter, data: "ByteCoords") -> None:
         """
@@ -66,12 +53,16 @@ class ByteCoords:
             writer (EoWriter): The writer that the data will be serialized to.
             data (ByteCoords): The data to serialize.
         """
-        if data._x is None:
-            raise SerializationError("x must be provided.")
-        writer.add_byte(data._x)
-        if data._y is None:
-            raise SerializationError("y must be provided.")
-        writer.add_byte(data._y)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._x is None:
+                raise SerializationError("x must be provided.")
+            writer.add_byte(data._x)
+            if data._y is None:
+                raise SerializationError("y must be provided.")
+            writer.add_byte(data._y)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ByteCoords":
@@ -84,14 +75,14 @@ class ByteCoords:
         Returns:
             ByteCoords: The data to serialize.
         """
-        data: ByteCoords = ByteCoords()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._x = reader.get_byte()
-            data._y = reader.get_byte()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            x = reader.get_byte()
+            y = reader.get_byte()
+            result = ByteCoords(x=x, y=y)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -18,8 +18,19 @@ class ChairRequestClientPacket(Packet):
     Sitting on a chair
     """
     _byte_size: int = 0
-    _sit_action: SitAction = None # type: ignore [assignment]
-    _sit_action_data: 'ChairRequestClientPacket.SitActionData' = None
+    _sit_action: SitAction
+    _sit_action_data: 'ChairRequestClientPacket.SitActionData'
+
+    def __init__(self, *, sit_action: SitAction, sit_action_data: 'ChairRequestClientPacket.SitActionData' = None):
+        """
+        Create a new instance of ChairRequestClientPacket.
+
+        Args:
+            sit_action (SitAction): 
+            sit_action_data (ChairRequestClientPacket.SitActionData): Data associated with the `sit_action` field.
+        """
+        self._sit_action = sit_action
+        self._sit_action_data = sit_action_data
 
     @property
     def byte_size(self) -> int:
@@ -35,21 +46,13 @@ class ChairRequestClientPacket(Packet):
     def sit_action(self) -> SitAction:
         return self._sit_action
 
-    @sit_action.setter
-    def sit_action(self, sit_action: SitAction) -> None:
-        self._sit_action = sit_action
-
     @property
     def sit_action_data(self) -> 'ChairRequestClientPacket.SitActionData':
         """
-        ChairRequestClientPacket.SitActionData: Gets or sets the data associated with the `sit_action` field.
+        ChairRequestClientPacket.SitActionData: Data associated with the `sit_action` field.
         """
         return self._sit_action_data
 
-    @sit_action_data.setter
-    def sit_action_data(self, sit_action_data: 'ChairRequestClientPacket.SitActionData') -> None:
-        self._sit_action_data = sit_action_data
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -88,13 +91,17 @@ class ChairRequestClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (ChairRequestClientPacket): The data to serialize.
         """
-        if data._sit_action is None:
-            raise SerializationError("sit_action must be provided.")
-        writer.add_char(int(data._sit_action))
-        if data._sit_action == SitAction.Sit:
-            if not isinstance(data._sit_action_data, ChairRequestClientPacket.SitActionDataSit):
-                raise SerializationError("Expected sit_action_data to be type ChairRequestClientPacket.SitActionDataSit for sit_action " + SitAction(data._sit_action).name + ".")
-            ChairRequestClientPacket.SitActionDataSit.serialize(writer, data._sit_action_data)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._sit_action is None:
+                raise SerializationError("sit_action must be provided.")
+            writer.add_char(int(data._sit_action))
+            if data._sit_action == SitAction.Sit:
+                if not isinstance(data._sit_action_data, ChairRequestClientPacket.SitActionDataSit):
+                    raise SerializationError("Expected sit_action_data to be type ChairRequestClientPacket.SitActionDataSit for sit_action " + SitAction(data._sit_action).name + ".")
+                ChairRequestClientPacket.SitActionDataSit.serialize(writer, data._sit_action_data)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ChairRequestClientPacket":
@@ -107,15 +114,16 @@ class ChairRequestClientPacket(Packet):
         Returns:
             ChairRequestClientPacket: The data to serialize.
         """
-        data: ChairRequestClientPacket = ChairRequestClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._sit_action = SitAction(reader.get_char())
-            if data._sit_action == SitAction.Sit:
-                data._sit_action_data = ChairRequestClientPacket.SitActionDataSit.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            sit_action = SitAction(reader.get_char())
+            sit_action_data: ChairRequestClientPacket.SitActionData = None
+            if sit_action == SitAction.Sit:
+                sit_action_data = ChairRequestClientPacket.SitActionDataSit.deserialize(reader)
+            result = ChairRequestClientPacket(sit_action=sit_action, sit_action_data=sit_action_data)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 
@@ -123,17 +131,25 @@ class ChairRequestClientPacket(Packet):
         return f"ChairRequestClientPacket(byte_size={repr(self._byte_size)}, sit_action={repr(self._sit_action)}, sit_action_data={repr(self._sit_action_data)})"
 
     SitActionData = Union['ChairRequestClientPacket.SitActionDataSit', None]
-    SitActionData.__doc__ = \
-        """
-        Data associated with different values of the `sit_action` field.
-        """
+    """
+    Data associated with different values of the `sit_action` field.
+    """
 
     class SitActionDataSit:
         """
         Data associated with sit_action value SitAction.Sit
         """
         _byte_size: int = 0
-        _coords: Coords = None # type: ignore [assignment]
+        _coords: Coords
+
+        def __init__(self, *, coords: Coords):
+            """
+            Create a new instance of ChairRequestClientPacket.SitActionDataSit.
+
+            Args:
+                coords (Coords): 
+            """
+            self._coords = coords
 
         @property
         def byte_size(self) -> int:
@@ -149,10 +165,6 @@ class ChairRequestClientPacket(Packet):
         def coords(self) -> Coords:
             return self._coords
 
-        @coords.setter
-        def coords(self, coords: Coords) -> None:
-            self._coords = coords
-
         @staticmethod
         def serialize(writer: EoWriter, data: "ChairRequestClientPacket.SitActionDataSit") -> None:
             """
@@ -162,9 +174,13 @@ class ChairRequestClientPacket(Packet):
                 writer (EoWriter): The writer that the data will be serialized to.
                 data (ChairRequestClientPacket.SitActionDataSit): The data to serialize.
             """
-            if data._coords is None:
-                raise SerializationError("coords must be provided.")
-            Coords.serialize(writer, data._coords)
+            old_string_sanitization_mode: bool = writer.string_sanitization_mode
+            try:
+                if data._coords is None:
+                    raise SerializationError("coords must be provided.")
+                Coords.serialize(writer, data._coords)
+            finally:
+                writer.string_sanitization_mode = old_string_sanitization_mode
 
         @staticmethod
         def deserialize(reader: EoReader) -> "ChairRequestClientPacket.SitActionDataSit":
@@ -177,13 +193,13 @@ class ChairRequestClientPacket(Packet):
             Returns:
                 ChairRequestClientPacket.SitActionDataSit: The data to serialize.
             """
-            data: ChairRequestClientPacket.SitActionDataSit = ChairRequestClientPacket.SitActionDataSit()
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
-                data._coords = Coords.deserialize(reader)
-                data._byte_size = reader.position - reader_start_position
-                return data
+                coords = Coords.deserialize(reader)
+                result = ChairRequestClientPacket.SitActionDataSit(coords=coords)
+                result._byte_size = reader.position - reader_start_position
+                return result
             finally:
                 reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -16,12 +16,31 @@ class CharacterCreateClientPacket(Packet):
     Confirm creating a character
     """
     _byte_size: int = 0
-    _session_id: int = None # type: ignore [assignment]
-    _gender: Gender = None # type: ignore [assignment]
-    _hair_style: int = None # type: ignore [assignment]
-    _hair_color: int = None # type: ignore [assignment]
-    _skin: int = None # type: ignore [assignment]
-    _name: str = None # type: ignore [assignment]
+    _session_id: int
+    _gender: Gender
+    _hair_style: int
+    _hair_color: int
+    _skin: int
+    _name: str
+
+    def __init__(self, *, session_id: int, gender: Gender, hair_style: int, hair_color: int, skin: int, name: str):
+        """
+        Create a new instance of CharacterCreateClientPacket.
+
+        Args:
+            session_id (int): (Value range is 0-64008.)
+            gender (Gender): 
+            hair_style (int): (Value range is 0-64008.)
+            hair_color (int): (Value range is 0-64008.)
+            skin (int): (Value range is 0-64008.)
+            name (str): 
+        """
+        self._session_id = session_id
+        self._gender = gender
+        self._hair_style = hair_style
+        self._hair_color = hair_color
+        self._skin = skin
+        self._name = name
 
     @property
     def byte_size(self) -> int:
@@ -35,84 +54,28 @@ class CharacterCreateClientPacket(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
-
     @property
     def gender(self) -> Gender:
         return self._gender
 
-    @gender.setter
-    def gender(self, gender: Gender) -> None:
-        self._gender = gender
-
     @property
     def hair_style(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._hair_style
 
-    @hair_style.setter
-    def hair_style(self, hair_style: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._hair_style = hair_style
-
     @property
     def hair_color(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._hair_color
 
-    @hair_color.setter
-    def hair_color(self, hair_color: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._hair_color = hair_color
-
     @property
     def skin(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._skin
 
-    @skin.setter
-    def skin(self, skin: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._skin = skin
-
     @property
     def name(self) -> str:
         return self._name
 
-    @name.setter
-    def name(self, name: str) -> None:
-        self._name = name
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -151,26 +114,32 @@ class CharacterCreateClientPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CharacterCreateClientPacket): The data to serialize.
         """
-        if data._session_id is None:
-            raise SerializationError("session_id must be provided.")
-        writer.add_short(data._session_id)
-        if data._gender is None:
-            raise SerializationError("gender must be provided.")
-        writer.add_short(int(data._gender))
-        if data._hair_style is None:
-            raise SerializationError("hair_style must be provided.")
-        writer.add_short(data._hair_style)
-        if data._hair_color is None:
-            raise SerializationError("hair_color must be provided.")
-        writer.add_short(data._hair_color)
-        if data._skin is None:
-            raise SerializationError("skin must be provided.")
-        writer.add_short(data._skin)
-        writer.add_byte(0xFF)
-        if data._name is None:
-            raise SerializationError("name must be provided.")
-        writer.add_string(data._name)
-        writer.add_byte(0xFF)
+        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_short(data._session_id)
+            if data._gender is None:
+                raise SerializationError("gender must be provided.")
+            writer.add_short(int(data._gender))
+            if data._hair_style is None:
+                raise SerializationError("hair_style must be provided.")
+            writer.add_short(data._hair_style)
+            if data._hair_color is None:
+                raise SerializationError("hair_color must be provided.")
+            writer.add_short(data._hair_color)
+            if data._skin is None:
+                raise SerializationError("skin must be provided.")
+            writer.add_short(data._skin)
+            writer.add_byte(0xFF)
+            if data._name is None:
+                raise SerializationError("name must be provided.")
+            writer.add_string(data._name)
+            writer.add_byte(0xFF)
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CharacterCreateClientPacket":
@@ -183,22 +152,22 @@ class CharacterCreateClientPacket(Packet):
         Returns:
             CharacterCreateClientPacket: The data to serialize.
         """
-        data: CharacterCreateClientPacket = CharacterCreateClientPacket()
         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_short()
-            data._gender = Gender(reader.get_short())
-            data._hair_style = reader.get_short()
-            data._hair_color = reader.get_short()
-            data._skin = reader.get_short()
+            session_id = reader.get_short()
+            gender = Gender(reader.get_short())
+            hair_style = reader.get_short()
+            hair_color = reader.get_short()
+            skin = reader.get_short()
             reader.next_chunk()
-            data._name = reader.get_string()
+            name = reader.get_string()
             reader.next_chunk()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = CharacterCreateClientPacket(session_id=session_id, gender=gender, hair_style=hair_style, hair_color=hair_color, skin=skin, name=name)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode