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

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

@@ -18,29 +18,76 @@ from .....data.eo_reader import EoReader
 class CharacterMapInfo:
     """
     Information about a nearby character.
-    The official client skips these if they're under 42 bytes in length.
+    The official client skips these if they're under 42 bytes in length.
     """
     _byte_size: int = 0
-    _name: str = None # type: ignore [assignment]
-    _player_id: int = None # type: ignore [assignment]
-    _map_id: int = None # type: ignore [assignment]
-    _coords: BigCoords = None # type: ignore [assignment]
-    _direction: Direction = None # type: ignore [assignment]
-    _class_id: int = None # type: ignore [assignment]
-    _guild_tag: str = None # type: ignore [assignment]
-    _level: 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]
-    _max_hp: int = None # type: ignore [assignment]
-    _hp: int = None # type: ignore [assignment]
-    _max_tp: int = None # type: ignore [assignment]
-    _tp: int = None # type: ignore [assignment]
-    _equipment: EquipmentMapInfo = None # type: ignore [assignment]
-    _sit_state: SitState = None # type: ignore [assignment]
-    _invisible: bool = None # type: ignore [assignment]
-    _warp_effect: Optional[WarpEffect] = None # type: ignore [assignment]
+    _name: str
+    _player_id: int
+    _map_id: int
+    _coords: BigCoords
+    _direction: Direction
+    _class_id: int
+    _guild_tag: str
+    _level: int
+    _gender: Gender
+    _hair_style: int
+    _hair_color: int
+    _skin: int
+    _max_hp: int
+    _hp: int
+    _max_tp: int
+    _tp: int
+    _equipment: EquipmentMapInfo
+    _sit_state: SitState
+    _invisible: bool
+    _warp_effect: Optional[WarpEffect]
+
+    def __init__(self, *, name: str, player_id: int, map_id: int, coords: BigCoords, direction: Direction, class_id: int, guild_tag: str, level: int, gender: Gender, hair_style: int, hair_color: int, skin: int, max_hp: int, hp: int, max_tp: int, tp: int, equipment: EquipmentMapInfo, sit_state: SitState, invisible: bool, warp_effect: Optional[WarpEffect] = None):
+        """
+        Create a new instance of CharacterMapInfo.
+
+        Args:
+            name (str): 
+            player_id (int): (Value range is 0-64008.)
+            map_id (int): (Value range is 0-64008.)
+            coords (BigCoords): 
+            direction (Direction): 
+            class_id (int): (Value range is 0-252.)
+            guild_tag (str): (Length must be `3`.)
+            level (int): (Value range is 0-252.)
+            gender (Gender): 
+            hair_style (int): (Value range is 0-252.)
+            hair_color (int): (Value range is 0-252.)
+            skin (int): (Value range is 0-252.)
+            max_hp (int): (Value range is 0-64008.)
+            hp (int): (Value range is 0-64008.)
+            max_tp (int): (Value range is 0-64008.)
+            tp (int): (Value range is 0-64008.)
+            equipment (EquipmentMapInfo): 
+            sit_state (SitState): 
+            invisible (bool): 
+            warp_effect (Optional[WarpEffect]): 
+        """
+        self._name = name
+        self._player_id = player_id
+        self._map_id = map_id
+        self._coords = coords
+        self._direction = direction
+        self._class_id = class_id
+        self._guild_tag = guild_tag
+        self._level = level
+        self._gender = gender
+        self._hair_style = hair_style
+        self._hair_color = hair_color
+        self._skin = skin
+        self._max_hp = max_hp
+        self._hp = hp
+        self._max_tp = max_tp
+        self._tp = tp
+        self._equipment = equipment
+        self._sit_state = sit_state
+        self._invisible = invisible
+        self._warp_effect = warp_effect
 
     @property
     def byte_size(self) -> int:
@@ -56,258 +103,82 @@ class CharacterMapInfo:
     def name(self) -> str:
         return self._name
 
-    @name.setter
-    def name(self, name: str) -> None:
-        self._name = name
-
     @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
-
     @property
     def map_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._map_id
 
-    @map_id.setter
-    def map_id(self, map_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._map_id = map_id
-
     @property
     def coords(self) -> BigCoords:
         return self._coords
 
-    @coords.setter
-    def coords(self, coords: BigCoords) -> None:
-        self._coords = coords
-
     @property
     def direction(self) -> Direction:
         return self._direction
 
-    @direction.setter
-    def direction(self, direction: Direction) -> None:
-        self._direction = direction
-
     @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:
-        """
-        Note:
-          - Length must be `3`.
-        """
         return self._guild_tag
 
-    @guild_tag.setter
-    def guild_tag(self, guild_tag: str) -> None:
-        """
-        Note:
-          - Length must be `3`.
-        """
-        self._guild_tag = guild_tag
-
     @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 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-252.
-        """
         return self._hair_style
 
-    @hair_style.setter
-    def hair_style(self, hair_style: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._hair_style = hair_style
-
     @property
     def hair_color(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._hair_color
 
-    @hair_color.setter
-    def hair_color(self, hair_color: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._hair_color = hair_color
-
     @property
     def skin(self) -> int:
-        """
-        Note:
-          - Value range is 0-252.
-        """
         return self._skin
 
-    @skin.setter
-    def skin(self, skin: int) -> None:
-        """
-        Note:
-          - Value range is 0-252.
-        """
-        self._skin = skin
-
     @property
     def max_hp(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._max_hp
 
-    @max_hp.setter
-    def max_hp(self, max_hp: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._max_hp = max_hp
-
     @property
     def hp(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._hp
 
-    @hp.setter
-    def hp(self, hp: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._hp = hp
-
     @property
     def max_tp(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._max_tp
 
-    @max_tp.setter
-    def max_tp(self, max_tp: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._max_tp = max_tp
-
     @property
     def tp(self) -> int:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
         return self._tp
 
-    @tp.setter
-    def tp(self, tp: int) -> None:
-        """
-        Note:
-          - Value range is 0-64008.
-        """
-        self._tp = tp
-
     @property
     def equipment(self) -> EquipmentMapInfo:
         return self._equipment
 
-    @equipment.setter
-    def equipment(self, equipment: EquipmentMapInfo) -> None:
-        self._equipment = equipment
-
     @property
     def sit_state(self) -> SitState:
         return self._sit_state
 
-    @sit_state.setter
-    def sit_state(self, sit_state: SitState) -> None:
-        self._sit_state = sit_state
-
     @property
     def invisible(self) -> bool:
         return self._invisible
 
-    @invisible.setter
-    def invisible(self, invisible: bool) -> None:
-        self._invisible = invisible
-
     @property
     def warp_effect(self) -> Optional[WarpEffect]:
         return self._warp_effect
 
-    @warp_effect.setter
-    def warp_effect(self, warp_effect: Optional[WarpEffect]) -> None:
-        self._warp_effect = warp_effect
-
     @staticmethod
     def serialize(writer: EoWriter, data: "CharacterMapInfo") -> None:
         """
@@ -317,69 +188,75 @@ class CharacterMapInfo:
             writer (EoWriter): The writer that the data will be serialized to.
             data (CharacterMapInfo): 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._player_id is None:
-            raise SerializationError("player_id must be provided.")
-        writer.add_short(data._player_id)
-        if data._map_id is None:
-            raise SerializationError("map_id must be provided.")
-        writer.add_short(data._map_id)
-        if data._coords is None:
-            raise SerializationError("coords must be provided.")
-        BigCoords.serialize(writer, data._coords)
-        if data._direction is None:
-            raise SerializationError("direction must be provided.")
-        writer.add_char(int(data._direction))
-        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.")
-        if len(data._guild_tag) != 3:
-            raise SerializationError(f"Expected length of guild_tag to be exactly 3, got {len(data._guild_tag)}.")
-        writer.add_fixed_string(data._guild_tag, 3, False)
-        if data._level is None:
-            raise SerializationError("level must be provided.")
-        writer.add_char(data._level)
-        if data._gender is None:
-            raise SerializationError("gender must be provided.")
-        writer.add_char(int(data._gender))
-        if data._hair_style is None:
-            raise SerializationError("hair_style must be provided.")
-        writer.add_char(data._hair_style)
-        if data._hair_color is None:
-            raise SerializationError("hair_color must be provided.")
-        writer.add_char(data._hair_color)
-        if data._skin is None:
-            raise SerializationError("skin must be provided.")
-        writer.add_char(data._skin)
-        if data._max_hp is None:
-            raise SerializationError("max_hp must be provided.")
-        writer.add_short(data._max_hp)
-        if data._hp is None:
-            raise SerializationError("hp must be provided.")
-        writer.add_short(data._hp)
-        if data._max_tp is None:
-            raise SerializationError("max_tp must be provided.")
-        writer.add_short(data._max_tp)
-        if data._tp is None:
-            raise SerializationError("tp must be provided.")
-        writer.add_short(data._tp)
-        if data._equipment is None:
-            raise SerializationError("equipment must be provided.")
-        EquipmentMapInfo.serialize(writer, data._equipment)
-        if data._sit_state is None:
-            raise SerializationError("sit_state must be provided.")
-        writer.add_char(int(data._sit_state))
-        if data._invisible is None:
-            raise SerializationError("invisible must be provided.")
-        writer.add_char(1 if data._invisible else 0)
-        reached_missing_optional = data._warp_effect is None
-        if not reached_missing_optional:
-            writer.add_char(int(cast(WarpEffect, data._warp_effect)))
+        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._player_id is None:
+                raise SerializationError("player_id must be provided.")
+            writer.add_short(data._player_id)
+            if data._map_id is None:
+                raise SerializationError("map_id must be provided.")
+            writer.add_short(data._map_id)
+            if data._coords is None:
+                raise SerializationError("coords must be provided.")
+            BigCoords.serialize(writer, data._coords)
+            if data._direction is None:
+                raise SerializationError("direction must be provided.")
+            writer.add_char(int(data._direction))
+            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.")
+            if len(data._guild_tag) != 3:
+                raise SerializationError(f"Expected length of guild_tag to be exactly 3, got {len(data._guild_tag)}.")
+            writer.add_fixed_string(data._guild_tag, 3, False)
+            if data._level is None:
+                raise SerializationError("level must be provided.")
+            writer.add_char(data._level)
+            if data._gender is None:
+                raise SerializationError("gender must be provided.")
+            writer.add_char(int(data._gender))
+            if data._hair_style is None:
+                raise SerializationError("hair_style must be provided.")
+            writer.add_char(data._hair_style)
+            if data._hair_color is None:
+                raise SerializationError("hair_color must be provided.")
+            writer.add_char(data._hair_color)
+            if data._skin is None:
+                raise SerializationError("skin must be provided.")
+            writer.add_char(data._skin)
+            if data._max_hp is None:
+                raise SerializationError("max_hp must be provided.")
+            writer.add_short(data._max_hp)
+            if data._hp is None:
+                raise SerializationError("hp must be provided.")
+            writer.add_short(data._hp)
+            if data._max_tp is None:
+                raise SerializationError("max_tp must be provided.")
+            writer.add_short(data._max_tp)
+            if data._tp is None:
+                raise SerializationError("tp must be provided.")
+            writer.add_short(data._tp)
+            if data._equipment is None:
+                raise SerializationError("equipment must be provided.")
+            EquipmentMapInfo.serialize(writer, data._equipment)
+            if data._sit_state is None:
+                raise SerializationError("sit_state must be provided.")
+            writer.add_char(int(data._sit_state))
+            if data._invisible is None:
+                raise SerializationError("invisible must be provided.")
+            writer.add_char(1 if data._invisible else 0)
+            reached_missing_optional = data._warp_effect is None
+            if not reached_missing_optional:
+                writer.add_char(int(cast(WarpEffect, data._warp_effect)))
+            writer.string_sanitization_mode = False
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CharacterMapInfo":
@@ -392,36 +269,37 @@ class CharacterMapInfo:
         Returns:
             CharacterMapInfo: The data to serialize.
         """
-        data: CharacterMapInfo = CharacterMapInfo()
         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._player_id = reader.get_short()
-            data._map_id = reader.get_short()
-            data._coords = BigCoords.deserialize(reader)
-            data._direction = Direction(reader.get_char())
-            data._class_id = reader.get_char()
-            data._guild_tag = reader.get_fixed_string(3, False)
-            data._level = reader.get_char()
-            data._gender = Gender(reader.get_char())
-            data._hair_style = reader.get_char()
-            data._hair_color = reader.get_char()
-            data._skin = reader.get_char()
-            data._max_hp = reader.get_short()
-            data._hp = reader.get_short()
-            data._max_tp = reader.get_short()
-            data._tp = reader.get_short()
-            data._equipment = EquipmentMapInfo.deserialize(reader)
-            data._sit_state = SitState(reader.get_char())
-            data._invisible = reader.get_char() != 0
+            player_id = reader.get_short()
+            map_id = reader.get_short()
+            coords = BigCoords.deserialize(reader)
+            direction = Direction(reader.get_char())
+            class_id = reader.get_char()
+            guild_tag = reader.get_fixed_string(3, False)
+            level = reader.get_char()
+            gender = Gender(reader.get_char())
+            hair_style = reader.get_char()
+            hair_color = reader.get_char()
+            skin = reader.get_char()
+            max_hp = reader.get_short()
+            hp = reader.get_short()
+            max_tp = reader.get_short()
+            tp = reader.get_short()
+            equipment = EquipmentMapInfo.deserialize(reader)
+            sit_state = SitState(reader.get_char())
+            invisible = reader.get_char() != 0
+            warp_effect: Optional[WarpEffect] = None
             if reader.remaining > 0:
-                data._warp_effect = WarpEffect(reader.get_char())
+                warp_effect = WarpEffect(reader.get_char())
             reader.chunked_reading_mode = False
-            data._byte_size = reader.position - reader_start_position
-            return data
+            result = CharacterMapInfo(name=name, player_id=player_id, map_id=map_id, coords=coords, direction=direction, class_id=class_id, guild_tag=guild_tag, level=level, gender=gender, hair_style=hair_style, hair_color=hair_color, skin=skin, max_hp=max_hp, hp=hp, max_tp=max_tp, tp=tp, equipment=equipment, sit_state=sit_state, invisible=invisible, warp_effect=warp_effect)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -15,8 +15,19 @@ class CharacterPlayerServerPacket(Packet):
     Reply to client request to delete a character from the account (Character_Take)
     """
     _byte_size: int = 0
-    _session_id: int = None # type: ignore [assignment]
-    _character_id: int = None # type: ignore [assignment]
+    _session_id: int
+    _character_id: int
+
+    def __init__(self, *, session_id: int, character_id: int):
+        """
+        Create a new instance of CharacterPlayerServerPacket.
+
+        Args:
+            session_id (int): (Value range is 0-64008.)
+            character_id (int): (Value range is 0-4097152080.)
+        """
+        self._session_id = session_id
+        self._character_id = character_id
 
     @property
     def byte_size(self) -> int:
@@ -30,36 +41,12 @@ class CharacterPlayerServerPacket(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 character_id(self) -> int:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
         return self._character_id
 
-    @character_id.setter
-    def character_id(self, character_id: int) -> None:
-        """
-        Note:
-          - Value range is 0-4097152080.
-        """
-        self._character_id = character_id
-
     @staticmethod
     def family() -> PacketFamily:
         """
@@ -98,12 +85,16 @@ class CharacterPlayerServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (CharacterPlayerServerPacket): 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._character_id is None:
-            raise SerializationError("character_id must be provided.")
-        writer.add_int(data._character_id)
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._session_id is None:
+                raise SerializationError("session_id must be provided.")
+            writer.add_short(data._session_id)
+            if data._character_id is None:
+                raise SerializationError("character_id must be provided.")
+            writer.add_int(data._character_id)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "CharacterPlayerServerPacket":
@@ -116,14 +107,14 @@ class CharacterPlayerServerPacket(Packet):
         Returns:
             CharacterPlayerServerPacket: The data to serialize.
         """
-        data: CharacterPlayerServerPacket = CharacterPlayerServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._session_id = reader.get_short()
-            data._character_id = reader.get_int()
-            data._byte_size = reader.position - reader_start_position
-            return data
+            session_id = reader.get_short()
+            character_id = reader.get_int()
+            result = CharacterPlayerServerPacket(session_id=session_id, character_id=character_id)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode