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

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

@@ -17,10 +17,24 @@ class InitInitClientPacket(Packet):
     This packet is unencrypted.
     """
     _byte_size: int = 0
-    _challenge: int = None # type: ignore [assignment]
-    _version: Version = None # type: ignore [assignment]
-    _hdid_length: int = None # type: ignore [assignment]
-    _hdid: str = None # type: ignore [assignment]
+    _challenge: int
+    _version: Version
+    _hdid_length: int
+    _hdid: str
+
+    def __init__(self, *, challenge: int, version: Version, hdid: str):
+        """
+        Create a new instance of InitInitClientPacket.
+
+        Args:
+            challenge (int): (Value range is 0-16194276.)
+            version (Version): 
+            hdid (str): (Length must be 252 or less.)
+        """
+        self._challenge = challenge
+        self._version = version
+        self._hdid = hdid
+        self._hdid_length = len(self._hdid)
 
     @property
     def byte_size(self) -> int:
@@ -34,45 +48,16 @@ class InitInitClientPacket(Packet):
 
     @property
     def challenge(self) -> int:
-        """
-        Note:
-          - Value range is 0-16194276.
-        """
         return self._challenge
 
-    @challenge.setter
-    def challenge(self, challenge: int) -> None:
-        """
-        Note:
-          - Value range is 0-16194276.
-        """
-        self._challenge = challenge
-
     @property
     def version(self) -> Version:
         return self._version
 
-    @version.setter
-    def version(self, version: Version) -> None:
-        self._version = version
-
     @property
     def hdid(self) -> str:
-        """
-        Note:
-          - Length must be 252 or less.
-        """
         return self._hdid
 
-    @hdid.setter
-    def hdid(self, hdid: str) -> None:
-        """
-        Note:
-          - Length must be 252 or less.
-        """
-        self._hdid = hdid
-        self._hdid_length = len(self._hdid)
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -142,17 +127,17 @@ class InitInitClientPacket(Packet):
         Returns:
             InitInitClientPacket: The data to serialize.
         """
-        data: InitInitClientPacket = InitInitClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._challenge = reader.get_three()
-            data._version = Version.deserialize(reader)
+            challenge = reader.get_three()
+            version = Version.deserialize(reader)
             reader.get_char()
-            data._hdid_length = reader.get_char()
-            data._hdid = reader.get_fixed_string(data._hdid_length, False)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            hdid_length = reader.get_char()
+            hdid = reader.get_fixed_string(hdid_length, False)
+            result = InitInitClientPacket(challenge=challenge, version=version, hdid=hdid)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -17,8 +17,19 @@ class ItemDropClientPacket(Packet):
     Dropping items on the ground
     """
     _byte_size: int = 0
-    _item: ThreeItem = None # type: ignore [assignment]
-    _coords: ByteCoords = None # type: ignore [assignment]
+    _item: ThreeItem
+    _coords: ByteCoords
+
+    def __init__(self, *, item: ThreeItem, coords: ByteCoords):
+        """
+        Create a new instance of ItemDropClientPacket.
+
+        Args:
+            item (ThreeItem): 
+            coords (ByteCoords): The official client sends 255 byte values for the coords if an item is dropped via the GUI button. 255 values here should be interpreted to mean "drop at current coords". Otherwise, the x and y fields contain encoded numbers that must be explicitly decoded to get the actual x and y values.
+        """
+        self._item = item
+        self._coords = coords
 
     @property
     def byte_size(self) -> int:
@@ -34,10 +45,6 @@ class ItemDropClientPacket(Packet):
     def item(self) -> ThreeItem:
         return self._item
 
-    @item.setter
-    def item(self, item: ThreeItem) -> None:
-        self._item = item
-
     @property
     def coords(self) -> ByteCoords:
         """
@@ -49,17 +56,6 @@ class ItemDropClientPacket(Packet):
         """
         return self._coords
 
-    @coords.setter
-    def coords(self, coords: ByteCoords) -> None:
-        """
-        The official client sends 255 byte values for the coords if an item is dropped via
-        the GUI button.
-        255 values here should be interpreted to mean "drop at current coords".
-        Otherwise, the x and y fields contain encoded numbers that must be explicitly
-        decoded to get the actual x and y values.
-        """
-        self._coords = coords
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -120,14 +116,14 @@ class ItemDropClientPacket(Packet):
         Returns:
             ItemDropClientPacket: The data to serialize.
         """
-        data: ItemDropClientPacket = ItemDropClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._item = ThreeItem.deserialize(reader)
-            data._coords = ByteCoords.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            item = ThreeItem.deserialize(reader)
+            coords = ByteCoords.deserialize(reader)
+            result = ItemDropClientPacket(item=item, 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/item_get_client_packet.py

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

@@ -16,7 +16,16 @@ class ItemJunkClientPacket(Packet):
     Junking items
     """
     _byte_size: int = 0
-    _item: Item = None # type: ignore [assignment]
+    _item: Item
+
+    def __init__(self, *, item: Item):
+        """
+        Create a new instance of ItemJunkClientPacket.
+
+        Args:
+            item (Item): 
+        """
+        self._item = item
 
     @property
     def byte_size(self) -> int:
@@ -32,10 +41,6 @@ class ItemJunkClientPacket(Packet):
     def item(self) -> Item:
         return self._item
 
-    @item.setter
-    def item(self, item: Item) -> None:
-        self._item = item
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -93,13 +98,13 @@ class ItemJunkClientPacket(Packet):
         Returns:
             ItemJunkClientPacket: The data to serialize.
         """
-        data: ItemJunkClientPacket = ItemJunkClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._item = Item.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            item = Item.deserialize(reader)
+            result = ItemJunkClientPacket(item=item)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

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

@@ -15,7 +15,16 @@ class JukeboxMsgClientPacket(Packet):
     Requesting a song on a jukebox
     """
     _byte_size: int = 0
-    _track_id: int = None # type: ignore [assignment]
+    _track_id: int
+
+    def __init__(self, *, track_id: int):
+        """
+        Create a new instance of JukeboxMsgClientPacket.
+
+        Args:
+            track_id (int): This value is 0-indexed (Value range is 0-64008.)
+        """
+        self._track_id = track_id
 
     @property
     def byte_size(self) -> int:
@@ -31,22 +40,9 @@ class JukeboxMsgClientPacket(Packet):
     def track_id(self) -> int:
         """
         This value is 0-indexed
-
-        Note:
-          - Value range is 0-64008.
         """
         return self._track_id
 
-    @track_id.setter
-    def track_id(self, track_id: int) -> None:
-        """
-        This value is 0-indexed
-
-        Note:
-          - Value range is 0-64008.
-        """
-        self._track_id = track_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -106,15 +102,15 @@ class JukeboxMsgClientPacket(Packet):
         Returns:
             JukeboxMsgClientPacket: The data to serialize.
         """
-        data: JukeboxMsgClientPacket = JukeboxMsgClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.get_char()
             reader.get_char()
-            data._track_id = reader.get_short()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            track_id = reader.get_short()
+            result = JukeboxMsgClientPacket(track_id=track_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/jukebox_open_client_packet.py

@@ -16,7 +16,16 @@ class JukeboxOpenClientPacket(Packet):
     Opening the jukebox listing
     """
     _byte_size: int = 0
-    _coords: Coords = None # type: ignore [assignment]
+    _coords: Coords
+
+    def __init__(self, *, coords: Coords):
+        """
+        Create a new instance of JukeboxOpenClientPacket.
+
+        Args:
+            coords (Coords): 
+        """
+        self._coords = coords
 
     @property
     def byte_size(self) -> int:
@@ -32,10 +41,6 @@ class JukeboxOpenClientPacket(Packet):
     def coords(self) -> Coords:
         return self._coords
 
-    @coords.setter
-    def coords(self, coords: Coords) -> None:
-        self._coords = coords
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -93,13 +98,13 @@ class JukeboxOpenClientPacket(Packet):
         Returns:
             JukeboxOpenClientPacket: The data to serialize.
         """
-        data: JukeboxOpenClientPacket = JukeboxOpenClientPacket()
         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 = JukeboxOpenClientPacket(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/jukebox_use_client_packet.py

@@ -15,8 +15,19 @@ class JukeboxUseClientPacket(Packet):
     Playing a note with the bard skill
     """
     _byte_size: int = 0
-    _instrument_id: int = None # type: ignore [assignment]
-    _note_id: int = None # type: ignore [assignment]
+    _instrument_id: int
+    _note_id: int
+
+    def __init__(self, *, instrument_id: int, note_id: int):
+        """
+        Create a new instance of JukeboxUseClientPacket.
+
+        Args:
+            instrument_id (int): (Value range is 0-252.)
+            note_id (int): (Value range is 0-252.)
+        """
+        self._instrument_id = instrument_id
+        self._note_id = note_id
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +41,12 @@ class JukeboxUseClientPacket(Packet):
 
     @property
     def instrument_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._instrument_id
 
-    @instrument_id.setter
-    def instrument_id(self, instrument_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._instrument_id = instrument_id
-
     @property
     def note_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._note_id
 
-    @note_id.setter
-    def note_id(self, note_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._note_id = note_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -120,14 +107,14 @@ class JukeboxUseClientPacket(Packet):
         Returns:
             JukeboxUseClientPacket: The data to serialize.
         """
-        data: JukeboxUseClientPacket = JukeboxUseClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._instrument_id = reader.get_char()
-            data._note_id = reader.get_char()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            instrument_id = reader.get_char()
+            note_id = reader.get_char()
+            result = JukeboxUseClientPacket(instrument_id=instrument_id, note_id=note_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/locker_add_client_packet.py

@@ -17,8 +17,19 @@ class LockerAddClientPacket(Packet):
     Adding an item to a bank locker
     """
     _byte_size: int = 0
-    _locker_coords: Coords = None # type: ignore [assignment]
-    _deposit_item: ThreeItem = None # type: ignore [assignment]
+    _locker_coords: Coords
+    _deposit_item: ThreeItem
+
+    def __init__(self, *, locker_coords: Coords, deposit_item: ThreeItem):
+        """
+        Create a new instance of LockerAddClientPacket.
+
+        Args:
+            locker_coords (Coords): 
+            deposit_item (ThreeItem): 
+        """
+        self._locker_coords = locker_coords
+        self._deposit_item = deposit_item
 
     @property
     def byte_size(self) -> int:
@@ -34,18 +45,10 @@ class LockerAddClientPacket(Packet):
     def locker_coords(self) -> Coords:
         return self._locker_coords
 
-    @locker_coords.setter
-    def locker_coords(self, locker_coords: Coords) -> None:
-        self._locker_coords = locker_coords
-
     @property
     def deposit_item(self) -> ThreeItem:
         return self._deposit_item
 
-    @deposit_item.setter
-    def deposit_item(self, deposit_item: ThreeItem) -> None:
-        self._deposit_item = deposit_item
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -106,14 +109,14 @@ class LockerAddClientPacket(Packet):
         Returns:
             LockerAddClientPacket: The data to serialize.
         """
-        data: LockerAddClientPacket = LockerAddClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._locker_coords = Coords.deserialize(reader)
-            data._deposit_item = ThreeItem.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            locker_coords = Coords.deserialize(reader)
+            deposit_item = ThreeItem.deserialize(reader)
+            result = LockerAddClientPacket(locker_coords=locker_coords, deposit_item=deposit_item)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,6 +15,11 @@ class LockerBuyClientPacket(Packet):
     """
     _byte_size: int = 0
 
+    def __init__(self):
+        """
+        Create a new instance of LockerBuyClientPacket.
+        """
+
     @property
     def byte_size(self) -> int:
         """
@@ -80,13 +85,13 @@ class LockerBuyClientPacket(Packet):
         Returns:
             LockerBuyClientPacket: The data to serialize.
         """
-        data: LockerBuyClientPacket = LockerBuyClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.get_char()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = LockerBuyClientPacket()
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -16,7 +16,16 @@ class LockerOpenClientPacket(Packet):
     Opening a bank locker
     """
     _byte_size: int = 0
-    _locker_coords: Coords = None # type: ignore [assignment]
+    _locker_coords: Coords
+
+    def __init__(self, *, locker_coords: Coords):
+        """
+        Create a new instance of LockerOpenClientPacket.
+
+        Args:
+            locker_coords (Coords): 
+        """
+        self._locker_coords = locker_coords
 
     @property
     def byte_size(self) -> int:
@@ -32,10 +41,6 @@ class LockerOpenClientPacket(Packet):
     def locker_coords(self) -> Coords:
         return self._locker_coords
 
-    @locker_coords.setter
-    def locker_coords(self, locker_coords: Coords) -> None:
-        self._locker_coords = locker_coords
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -93,13 +98,13 @@ class LockerOpenClientPacket(Packet):
         Returns:
             LockerOpenClientPacket: The data to serialize.
         """
-        data: LockerOpenClientPacket = LockerOpenClientPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._locker_coords = Coords.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            locker_coords = Coords.deserialize(reader)
+            result = LockerOpenClientPacket(locker_coords=locker_coords)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode