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

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

@@ -14,9 +14,22 @@ class NpcUpdatePosition:
     An NPC walking
     """
     _byte_size: int = 0
-    _npc_index: int = None # type: ignore [assignment]
-    _coords: Coords = None # type: ignore [assignment]
-    _direction: Direction = None # type: ignore [assignment]
+    _npc_index: int
+    _coords: Coords
+    _direction: Direction
+
+    def __init__(self, *, npc_index: int, coords: Coords, direction: Direction):
+        """
+        Create a new instance of NpcUpdatePosition.
+
+        Args:
+            npc_index (int): (Value range is 0-252.)
+            coords (Coords): 
+            direction (Direction): 
+        """
+        self._npc_index = npc_index
+        self._coords = coords
+        self._direction = direction
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +43,16 @@ class NpcUpdatePosition:
 
     @property
     def npc_index(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._npc_index
 
-    @npc_index.setter
-    def npc_index(self, npc_index: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._npc_index = npc_index
-
     @property
     def coords(self) -> Coords:
         return self._coords
 
-    @coords.setter
-    def coords(self, coords: Coords) -> None:
-        self._coords = coords
-
     @property
     def direction(self) -> Direction:
         return self._direction
 
-    @direction.setter
-    def direction(self, direction: Direction) -> None:
-        self._direction = direction
-
     @staticmethod
     def serialize(writer: EoWriter, data: "NpcUpdatePosition") -> None:
         """
@@ -69,15 +62,19 @@ class NpcUpdatePosition:
             writer (EoWriter): The writer that the data will be serialized to.
             data (NpcUpdatePosition): The data to serialize.
         """
-        if data._npc_index is None:
-            raise SerializationError("npc_index must be provided.")
-        writer.add_char(data._npc_index)
-        if data._coords is None:
-            raise SerializationError("coords must be provided.")
-        Coords.serialize(writer, data._coords)
-        if data._direction is None:
-            raise SerializationError("direction must be provided.")
-        writer.add_char(int(data._direction))
+        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_char(data._npc_index)
+            if data._coords is None:
+                raise SerializationError("coords must be provided.")
+            Coords.serialize(writer, data._coords)
+            if data._direction is None:
+                raise SerializationError("direction must be provided.")
+            writer.add_char(int(data._direction))
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "NpcUpdatePosition":
@@ -90,15 +87,15 @@ class NpcUpdatePosition:
         Returns:
             NpcUpdatePosition: The data to serialize.
         """
-        data: NpcUpdatePosition = NpcUpdatePosition()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._npc_index = reader.get_char()
-            data._coords = Coords.deserialize(reader)
-            data._direction = Direction(reader.get_char())
-            data._byte_size = reader.position - reader_start_position
-            return data
+            npc_index = reader.get_char()
+            coords = Coords.deserialize(reader)
+            direction = Direction(reader.get_char())
+            result = NpcUpdatePosition(npc_index=npc_index, coords=coords, direction=direction)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -13,12 +13,31 @@ class OnlinePlayer:
     A player in the online list
     """
     _byte_size: int = 0
-    _name: str = None # type: ignore [assignment]
-    _title: str = None # type: ignore [assignment]
-    _level: int = None # type: ignore [assignment]
-    _icon: CharacterIcon = None # type: ignore [assignment]
-    _class_id: int = None # type: ignore [assignment]
-    _guild_tag: str = None # type: ignore [assignment]
+    _name: str
+    _title: str
+    _level: int
+    _icon: CharacterIcon
+    _class_id: int
+    _guild_tag: str
+
+    def __init__(self, *, name: str, title: str, level: int, icon: CharacterIcon, class_id: int, guild_tag: str):
+        """
+        Create a new instance of OnlinePlayer.
+
+        Args:
+            name (str): 
+            title (str): 
+            level (int): (Value range is 0-252.)
+            icon (CharacterIcon): 
+            class_id (int): (Value range is 0-252.)
+            guild_tag (str): 
+        """
+        self._name = name
+        self._title = title
+        self._level = level
+        self._icon = icon
+        self._class_id = class_id
+        self._guild_tag = guild_tag
 
     @property
     def byte_size(self) -> int:
@@ -34,66 +53,26 @@ class OnlinePlayer:
     def name(self) -> str:
         return self._name
 
-    @name.setter
-    def name(self, name: str) -> None:
-        self._name = name
-
     @property
     def title(self) -> str:
         return self._title
 
-    @title.setter
-    def title(self, title: str) -> None:
-        self._title = title
-
     @property
     def level(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._level
 
-    @level.setter
-    def level(self, level: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._level = level
-
     @property
     def icon(self) -> CharacterIcon:
         return self._icon
 
-    @icon.setter
-    def icon(self, icon: CharacterIcon) -> None:
-        self._icon = icon
-
     @property
     def class_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._class_id
 
-    @class_id.setter
-    def class_id(self, class_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._class_id = class_id
-
     @property
     def guild_tag(self) -> str:
         return self._guild_tag
 
-    @guild_tag.setter
-    def guild_tag(self, guild_tag: str) -> None:
-        self._guild_tag = guild_tag
-
     @staticmethod
     def serialize(writer: EoWriter, data: "OnlinePlayer") -> None:
         """
@@ -103,26 +82,32 @@ class OnlinePlayer:
             writer (EoWriter): The writer that the data will be serialized to.
             data (OnlinePlayer): The data to serialize.
         """
-        if data._name is None:
-            raise SerializationError("name must be provided.")
-        writer.add_string(data._name)
-        writer.add_byte(0xFF)
-        if data._title is None:
-            raise SerializationError("title must be provided.")
-        writer.add_string(data._title)
-        writer.add_byte(0xFF)
-        if data._level is None:
-            raise SerializationError("level must be provided.")
-        writer.add_char(data._level)
-        if data._icon is None:
-            raise SerializationError("icon must be provided.")
-        writer.add_char(int(data._icon))
-        if data._class_id is None:
-            raise SerializationError("class_id must be provided.")
-        writer.add_char(data._class_id)
-        if data._guild_tag is None:
-            raise SerializationError("guild_tag must be provided.")
-        writer.add_string(data._guild_tag)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            writer.string_sanitization_mode = True
+            if data._name is None:
+                raise SerializationError("name must be provided.")
+            writer.add_string(data._name)
+            writer.add_byte(0xFF)
+            if data._title is None:
+                raise SerializationError("title must be provided.")
+            writer.add_string(data._title)
+            writer.add_byte(0xFF)
+            if data._level is None:
+                raise SerializationError("level must be provided.")
+            writer.add_char(data._level)
+            if data._icon is None:
+                raise SerializationError("icon must be provided.")
+            writer.add_char(int(data._icon))
+            if data._class_id is None:
+                raise SerializationError("class_id must be provided.")
+            writer.add_char(data._class_id)
+            if data._guild_tag is None:
+                raise SerializationError("guild_tag must be provided.")
+            writer.add_string(data._guild_tag)
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "OnlinePlayer":
@@ -135,22 +120,22 @@ class OnlinePlayer:
         Returns:
             OnlinePlayer: The data to serialize.
         """
-        data: OnlinePlayer = OnlinePlayer()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
             reader.chunked_reading_mode = True
-            data._name = reader.get_string()
+            name = reader.get_string()
             reader.next_chunk()
-            data._title = reader.get_string()
+            title = reader.get_string()
             reader.next_chunk()
-            data._level = reader.get_char()
-            data._icon = CharacterIcon(reader.get_char())
-            data._class_id = reader.get_char()
-            data._guild_tag = reader.get_string()
+            level = reader.get_char()
+            icon = CharacterIcon(reader.get_char())
+            class_id = reader.get_char()
+            guild_tag = reader.get_string()
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = OnlinePlayer(name=name, title=title, level=level, icon=icon, class_id=class_id, guild_tag=guild_tag)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -17,11 +17,28 @@ class PaperdollAgreeServerPacket(Packet):
     Reply to equipping an item
     """
     _byte_size: int = 0
-    _change: AvatarChange = None # type: ignore [assignment]
-    _item_id: int = None # type: ignore [assignment]
-    _remaining_amount: int = None # type: ignore [assignment]
-    _sub_loc: int = None # type: ignore [assignment]
-    _stats: CharacterStatsEquipmentChange = None # type: ignore [assignment]
+    _change: AvatarChange
+    _item_id: int
+    _remaining_amount: int
+    _sub_loc: int
+    _stats: CharacterStatsEquipmentChange
+
+    def __init__(self, *, change: AvatarChange, item_id: int, remaining_amount: int, sub_loc: int, stats: CharacterStatsEquipmentChange):
+        """
+        Create a new instance of PaperdollAgreeServerPacket.
+
+        Args:
+            change (AvatarChange): 
+            item_id (int): (Value range is 0-64008.)
+            remaining_amount (int): (Value range is 0-16194276.)
+            sub_loc (int): (Value range is 0-252.)
+            stats (CharacterStatsEquipmentChange): 
+        """
+        self._change = change
+        self._item_id = item_id
+        self._remaining_amount = remaining_amount
+        self._sub_loc = sub_loc
+        self._stats = stats
 
     @property
     def byte_size(self) -> int:
@@ -37,66 +54,22 @@ class PaperdollAgreeServerPacket(Packet):
     def change(self) -> AvatarChange:
         return self._change
 
-    @change.setter
-    def change(self, change: AvatarChange) -> None:
-        self._change = change
-
     @property
     def item_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._item_id
 
-    @item_id.setter
-    def item_id(self, item_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._item_id = item_id
-
     @property
     def remaining_amount(self) -> int:
-        """
-        Note:
-          - Value range is 0-16194276.
-        """
         return self._remaining_amount
 
-    @remaining_amount.setter
-    def remaining_amount(self, remaining_amount: int) -> None:
-        """
-        Note:
-          - Value range is 0-16194276.
-        """
-        self._remaining_amount = remaining_amount
-
     @property
     def sub_loc(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._sub_loc
 
-    @sub_loc.setter
-    def sub_loc(self, sub_loc: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._sub_loc = sub_loc
-
     @property
     def stats(self) -> CharacterStatsEquipmentChange:
         return self._stats
 
-    @stats.setter
-    def stats(self, stats: CharacterStatsEquipmentChange) -> None:
-        self._stats = stats
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -135,21 +108,25 @@ class PaperdollAgreeServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PaperdollAgreeServerPacket): The data to serialize.
         """
-        if data._change is None:
-            raise SerializationError("change must be provided.")
-        AvatarChange.serialize(writer, data._change)
-        if data._item_id is None:
-            raise SerializationError("item_id must be provided.")
-        writer.add_short(data._item_id)
-        if data._remaining_amount is None:
-            raise SerializationError("remaining_amount must be provided.")
-        writer.add_three(data._remaining_amount)
-        if data._sub_loc is None:
-            raise SerializationError("sub_loc must be provided.")
-        writer.add_char(data._sub_loc)
-        if data._stats is None:
-            raise SerializationError("stats must be provided.")
-        CharacterStatsEquipmentChange.serialize(writer, data._stats)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._change is None:
+                raise SerializationError("change must be provided.")
+            AvatarChange.serialize(writer, data._change)
+            if data._item_id is None:
+                raise SerializationError("item_id must be provided.")
+            writer.add_short(data._item_id)
+            if data._remaining_amount is None:
+                raise SerializationError("remaining_amount must be provided.")
+            writer.add_three(data._remaining_amount)
+            if data._sub_loc is None:
+                raise SerializationError("sub_loc must be provided.")
+            writer.add_char(data._sub_loc)
+            if data._stats is None:
+                raise SerializationError("stats must be provided.")
+            CharacterStatsEquipmentChange.serialize(writer, data._stats)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PaperdollAgreeServerPacket":
@@ -162,17 +139,17 @@ class PaperdollAgreeServerPacket(Packet):
         Returns:
             PaperdollAgreeServerPacket: The data to serialize.
         """
-        data: PaperdollAgreeServerPacket = PaperdollAgreeServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._change = AvatarChange.deserialize(reader)
-            data._item_id = reader.get_short()
-            data._remaining_amount = reader.get_three()
-            data._sub_loc = reader.get_char()
-            data._stats = CharacterStatsEquipmentChange.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            change = AvatarChange.deserialize(reader)
+            item_id = reader.get_short()
+            remaining_amount = reader.get_three()
+            sub_loc = reader.get_char()
+            stats = CharacterStatsEquipmentChange.deserialize(reader)
+            result = PaperdollAgreeServerPacket(change=change, item_id=item_id, remaining_amount=remaining_amount, sub_loc=sub_loc, stats=stats)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,7 +15,16 @@ class PaperdollPingServerPacket(Packet):
     Failed to equip an item due to being the incorrect class
     """
     _byte_size: int = 0
-    _class_id: int = None # type: ignore [assignment]
+    _class_id: int
+
+    def __init__(self, *, class_id: int):
+        """
+        Create a new instance of PaperdollPingServerPacket.
+
+        Args:
+            class_id (int): The player's current class ID (not the item's required class ID) (Value range is 0-252.)
+        """
+        self._class_id = class_id
 
     @property
     def byte_size(self) -> int:
@@ -30,23 +39,10 @@ class PaperdollPingServerPacket(Packet):
     @property
     def class_id(self) -> int:
         """
-        The player's current class ID (not the item's required class ID)
-
-        Note:
-          - Value range is 0-252.
+        The player's current class ID (not the item's required class ID)
         """
         return self._class_id
 
-    @class_id.setter
-    def class_id(self, class_id: int) -> None:
-        """
-        The player's current class ID (not the item's required class ID)
-
-        Note:
-          - Value range is 0-252.
-        """
-        self._class_id = class_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -85,9 +81,13 @@ class PaperdollPingServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (PaperdollPingServerPacket): The data to serialize.
         """
-        if data._class_id is None:
-            raise SerializationError("class_id must be provided.")
-        writer.add_char(data._class_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._class_id is None:
+                raise SerializationError("class_id must be provided.")
+            writer.add_char(data._class_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "PaperdollPingServerPacket":
@@ -100,13 +100,13 @@ class PaperdollPingServerPacket(Packet):
         Returns:
             PaperdollPingServerPacket: The data to serialize.
         """
-        data: PaperdollPingServerPacket = PaperdollPingServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._class_id = reader.get_char()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            class_id = reader.get_char()
+            result = PaperdollPingServerPacket(class_id=class_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode