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

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

@@ -12,13 +12,28 @@ from .....data.eo_reader import EoReader
 
 class AvatarChange:
     """
-    Information about a nearby player's appearance changing
+    Information about a nearby player's appearance changing
     """
     _byte_size: int = 0
-    _player_id: int = None # type: ignore [assignment]
-    _change_type: AvatarChangeType = None # type: ignore [assignment]
-    _sound: bool = None # type: ignore [assignment]
-    _change_type_data: 'AvatarChange.ChangeTypeData' = None
+    _player_id: int
+    _change_type: AvatarChangeType
+    _sound: bool
+    _change_type_data: 'AvatarChange.ChangeTypeData'
+
+    def __init__(self, *, player_id: int, change_type: AvatarChangeType, sound: bool, change_type_data: 'AvatarChange.ChangeTypeData' = None):
+        """
+        Create a new instance of AvatarChange.
+
+        Args:
+            player_id (int): (Value range is 0-64008.)
+            change_type (AvatarChangeType): 
+            sound (bool): 
+            change_type_data (AvatarChange.ChangeTypeData): Data associated with the `change_type` field.
+        """
+        self._player_id = player_id
+        self._change_type = change_type
+        self._sound = sound
+        self._change_type_data = change_type_data
 
     @property
     def byte_size(self) -> int:
@@ -32,47 +47,23 @@ class AvatarChange:
 
     @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 change_type(self) -> AvatarChangeType:
         return self._change_type
 
-    @change_type.setter
-    def change_type(self, change_type: AvatarChangeType) -> None:
-        self._change_type = change_type
-
     @property
     def sound(self) -> bool:
         return self._sound
 
-    @sound.setter
-    def sound(self, sound: bool) -> None:
-        self._sound = sound
-
     @property
     def change_type_data(self) -> 'AvatarChange.ChangeTypeData':
         """
-        AvatarChange.ChangeTypeData: Gets or sets the data associated with the `change_type` field.
+        AvatarChange.ChangeTypeData: Data associated with the `change_type` field.
         """
         return self._change_type_data
 
-    @change_type_data.setter
-    def change_type_data(self, change_type_data: 'AvatarChange.ChangeTypeData') -> None:
-        self._change_type_data = change_type_data
-
     @staticmethod
     def serialize(writer: EoWriter, data: "AvatarChange") -> None:
         """
@@ -82,27 +73,31 @@ class AvatarChange:
             writer (EoWriter): The writer that the data will be serialized to.
             data (AvatarChange): The data to serialize.
         """
-        if data._player_id is None:
-            raise SerializationError("player_id must be provided.")
-        writer.add_short(data._player_id)
-        if data._change_type is None:
-            raise SerializationError("change_type must be provided.")
-        writer.add_char(int(data._change_type))
-        if data._sound is None:
-            raise SerializationError("sound must be provided.")
-        writer.add_char(1 if data._sound else 0)
-        if data._change_type == AvatarChangeType.Equipment:
-            if not isinstance(data._change_type_data, AvatarChange.ChangeTypeDataEquipment):
-                raise SerializationError("Expected change_type_data to be type AvatarChange.ChangeTypeDataEquipment for change_type " + AvatarChangeType(data._change_type).name + ".")
-            AvatarChange.ChangeTypeDataEquipment.serialize(writer, data._change_type_data)
-        elif data._change_type == AvatarChangeType.Hair:
-            if not isinstance(data._change_type_data, AvatarChange.ChangeTypeDataHair):
-                raise SerializationError("Expected change_type_data to be type AvatarChange.ChangeTypeDataHair for change_type " + AvatarChangeType(data._change_type).name + ".")
-            AvatarChange.ChangeTypeDataHair.serialize(writer, data._change_type_data)
-        elif data._change_type == AvatarChangeType.HairColor:
-            if not isinstance(data._change_type_data, AvatarChange.ChangeTypeDataHairColor):
-                raise SerializationError("Expected change_type_data to be type AvatarChange.ChangeTypeDataHairColor for change_type " + AvatarChangeType(data._change_type).name + ".")
-            AvatarChange.ChangeTypeDataHairColor.serialize(writer, data._change_type_data)
+        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)
+            if data._change_type is None:
+                raise SerializationError("change_type must be provided.")
+            writer.add_char(int(data._change_type))
+            if data._sound is None:
+                raise SerializationError("sound must be provided.")
+            writer.add_char(1 if data._sound else 0)
+            if data._change_type == AvatarChangeType.Equipment:
+                if not isinstance(data._change_type_data, AvatarChange.ChangeTypeDataEquipment):
+                    raise SerializationError("Expected change_type_data to be type AvatarChange.ChangeTypeDataEquipment for change_type " + AvatarChangeType(data._change_type).name + ".")
+                AvatarChange.ChangeTypeDataEquipment.serialize(writer, data._change_type_data)
+            elif data._change_type == AvatarChangeType.Hair:
+                if not isinstance(data._change_type_data, AvatarChange.ChangeTypeDataHair):
+                    raise SerializationError("Expected change_type_data to be type AvatarChange.ChangeTypeDataHair for change_type " + AvatarChangeType(data._change_type).name + ".")
+                AvatarChange.ChangeTypeDataHair.serialize(writer, data._change_type_data)
+            elif data._change_type == AvatarChangeType.HairColor:
+                if not isinstance(data._change_type_data, AvatarChange.ChangeTypeDataHairColor):
+                    raise SerializationError("Expected change_type_data to be type AvatarChange.ChangeTypeDataHairColor for change_type " + AvatarChangeType(data._change_type).name + ".")
+                AvatarChange.ChangeTypeDataHairColor.serialize(writer, data._change_type_data)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "AvatarChange":
@@ -115,21 +110,22 @@ class AvatarChange:
         Returns:
             AvatarChange: The data to serialize.
         """
-        data: AvatarChange = AvatarChange()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._player_id = reader.get_short()
-            data._change_type = AvatarChangeType(reader.get_char())
-            data._sound = reader.get_char() != 0
-            if data._change_type == AvatarChangeType.Equipment:
-                data._change_type_data = AvatarChange.ChangeTypeDataEquipment.deserialize(reader)
-            elif data._change_type == AvatarChangeType.Hair:
-                data._change_type_data = AvatarChange.ChangeTypeDataHair.deserialize(reader)
-            elif data._change_type == AvatarChangeType.HairColor:
-                data._change_type_data = AvatarChange.ChangeTypeDataHairColor.deserialize(reader)
-            data._byte_size = reader.position - reader_start_position
-            return data
+            player_id = reader.get_short()
+            change_type = AvatarChangeType(reader.get_char())
+            sound = reader.get_char() != 0
+            change_type_data: AvatarChange.ChangeTypeData = None
+            if change_type == AvatarChangeType.Equipment:
+                change_type_data = AvatarChange.ChangeTypeDataEquipment.deserialize(reader)
+            elif change_type == AvatarChangeType.Hair:
+                change_type_data = AvatarChange.ChangeTypeDataHair.deserialize(reader)
+            elif change_type == AvatarChangeType.HairColor:
+                change_type_data = AvatarChange.ChangeTypeDataHairColor.deserialize(reader)
+            result = AvatarChange(player_id=player_id, change_type=change_type, sound=sound, change_type_data=change_type_data)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode
 
@@ -137,17 +133,25 @@ class AvatarChange:
         return f"AvatarChange(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, change_type={repr(self._change_type)}, sound={repr(self._sound)}, change_type_data={repr(self._change_type_data)})"
 
     ChangeTypeData = Union['AvatarChange.ChangeTypeDataEquipment', 'AvatarChange.ChangeTypeDataHair', 'AvatarChange.ChangeTypeDataHairColor', None]
-    ChangeTypeData.__doc__ = \
-        """
-        Data associated with different values of the `change_type` field.
-        """
+    """
+    Data associated with different values of the `change_type` field.
+    """
 
     class ChangeTypeDataEquipment:
         """
         Data associated with change_type value AvatarChangeType.Equipment
         """
         _byte_size: int = 0
-        _equipment: EquipmentChange = None # type: ignore [assignment]
+        _equipment: EquipmentChange
+
+        def __init__(self, *, equipment: EquipmentChange):
+            """
+            Create a new instance of AvatarChange.ChangeTypeDataEquipment.
+
+            Args:
+                equipment (EquipmentChange): 
+            """
+            self._equipment = equipment
 
         @property
         def byte_size(self) -> int:
@@ -163,10 +167,6 @@ class AvatarChange:
         def equipment(self) -> EquipmentChange:
             return self._equipment
 
-        @equipment.setter
-        def equipment(self, equipment: EquipmentChange) -> None:
-            self._equipment = equipment
-
         @staticmethod
         def serialize(writer: EoWriter, data: "AvatarChange.ChangeTypeDataEquipment") -> None:
             """
@@ -176,9 +176,13 @@ class AvatarChange:
                 writer (EoWriter): The writer that the data will be serialized to.
                 data (AvatarChange.ChangeTypeDataEquipment): The data to serialize.
             """
-            if data._equipment is None:
-                raise SerializationError("equipment must be provided.")
-            EquipmentChange.serialize(writer, data._equipment)
+            old_string_sanitization_mode: bool = writer.string_sanitization_mode
+            try:
+                if data._equipment is None:
+                    raise SerializationError("equipment must be provided.")
+                EquipmentChange.serialize(writer, data._equipment)
+            finally:
+                writer.string_sanitization_mode = old_string_sanitization_mode
 
         @staticmethod
         def deserialize(reader: EoReader) -> "AvatarChange.ChangeTypeDataEquipment":
@@ -191,13 +195,13 @@ class AvatarChange:
             Returns:
                 AvatarChange.ChangeTypeDataEquipment: The data to serialize.
             """
-            data: AvatarChange.ChangeTypeDataEquipment = AvatarChange.ChangeTypeDataEquipment()
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
-                data._equipment = EquipmentChange.deserialize(reader)
-                data._byte_size = reader.position - reader_start_position
-                return data
+                equipment = EquipmentChange.deserialize(reader)
+                result = AvatarChange.ChangeTypeDataEquipment(equipment=equipment)
+                result._byte_size = reader.position - reader_start_position
+                return result
             finally:
                 reader.chunked_reading_mode = old_chunked_reading_mode
 
@@ -209,8 +213,19 @@ class AvatarChange:
         Data associated with change_type value AvatarChangeType.Hair
         """
         _byte_size: int = 0
-        _hair_style: int = None # type: ignore [assignment]
-        _hair_color: int = None # type: ignore [assignment]
+        _hair_style: int
+        _hair_color: int
+
+        def __init__(self, *, hair_style: int, hair_color: int):
+            """
+            Create a new instance of AvatarChange.ChangeTypeDataHair.
+
+            Args:
+                hair_style (int): (Value range is 0-252.)
+                hair_color (int): (Value range is 0-252.)
+            """
+            self._hair_style = hair_style
+            self._hair_color = hair_color
 
         @property
         def byte_size(self) -> int:
@@ -224,36 +239,12 @@ class AvatarChange:
 
         @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
-
         @staticmethod
         def serialize(writer: EoWriter, data: "AvatarChange.ChangeTypeDataHair") -> None:
             """
@@ -263,12 +254,16 @@ class AvatarChange:
                 writer (EoWriter): The writer that the data will be serialized to.
                 data (AvatarChange.ChangeTypeDataHair): The data to serialize.
             """
-            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)
+            old_string_sanitization_mode: bool = writer.string_sanitization_mode
+            try:
+                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)
+            finally:
+                writer.string_sanitization_mode = old_string_sanitization_mode
 
         @staticmethod
         def deserialize(reader: EoReader) -> "AvatarChange.ChangeTypeDataHair":
@@ -281,14 +276,14 @@ class AvatarChange:
             Returns:
                 AvatarChange.ChangeTypeDataHair: The data to serialize.
             """
-            data: AvatarChange.ChangeTypeDataHair = AvatarChange.ChangeTypeDataHair()
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
-                data._hair_style = reader.get_char()
-                data._hair_color = reader.get_char()
-                data._byte_size = reader.position - reader_start_position
-                return data
+                hair_style = reader.get_char()
+                hair_color = reader.get_char()
+                result = AvatarChange.ChangeTypeDataHair(hair_style=hair_style, hair_color=hair_color)
+                result._byte_size = reader.position - reader_start_position
+                return result
             finally:
                 reader.chunked_reading_mode = old_chunked_reading_mode
 
@@ -300,7 +295,16 @@ class AvatarChange:
         Data associated with change_type value AvatarChangeType.HairColor
         """
         _byte_size: int = 0
-        _hair_color: int = None # type: ignore [assignment]
+        _hair_color: int
+
+        def __init__(self, *, hair_color: int):
+            """
+            Create a new instance of AvatarChange.ChangeTypeDataHairColor.
+
+            Args:
+                hair_color (int): (Value range is 0-252.)
+            """
+            self._hair_color = hair_color
 
         @property
         def byte_size(self) -> int:
@@ -314,20 +318,8 @@ class AvatarChange:
 
         @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
-
         @staticmethod
         def serialize(writer: EoWriter, data: "AvatarChange.ChangeTypeDataHairColor") -> None:
             """
@@ -337,9 +329,13 @@ class AvatarChange:
                 writer (EoWriter): The writer that the data will be serialized to.
                 data (AvatarChange.ChangeTypeDataHairColor): The data to serialize.
             """
-            if data._hair_color is None:
-                raise SerializationError("hair_color must be provided.")
-            writer.add_char(data._hair_color)
+            old_string_sanitization_mode: bool = writer.string_sanitization_mode
+            try:
+                if data._hair_color is None:
+                    raise SerializationError("hair_color must be provided.")
+                writer.add_char(data._hair_color)
+            finally:
+                writer.string_sanitization_mode = old_string_sanitization_mode
 
         @staticmethod
         def deserialize(reader: EoReader) -> "AvatarChange.ChangeTypeDataHairColor":
@@ -352,13 +348,13 @@ class AvatarChange:
             Returns:
                 AvatarChange.ChangeTypeDataHairColor: The data to serialize.
             """
-            data: AvatarChange.ChangeTypeDataHairColor = AvatarChange.ChangeTypeDataHairColor()
             old_chunked_reading_mode: bool = reader.chunked_reading_mode
             try:
                 reader_start_position: int = reader.position
-                data._hair_color = reader.get_char()
-                data._byte_size = reader.position - reader_start_position
-                return data
+                hair_color = reader.get_char()
+                result = AvatarChange.ChangeTypeDataHairColor(hair_color=hair_color)
+                result._byte_size = reader.position - reader_start_position
+                return result
             finally:
                 reader.chunked_reading_mode = old_chunked_reading_mode
 

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

@@ -8,7 +8,7 @@ from ....protocol_enum_meta import ProtocolEnumMeta
 
 class AvatarChangeType(IntEnum, metaclass=ProtocolEnumMeta):
     """
-    How a player's appearance is changing
+    How a player's appearance is changing
     """
     Equipment = 1
     Hair = 2

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

@@ -18,8 +18,19 @@ class AvatarRemoveServerPacket(Packet):
     Nearby player has disappeared from view
     """
     _byte_size: int = 0
-    _player_id: int = None # type: ignore [assignment]
-    _warp_effect: Optional[WarpEffect] = None # type: ignore [assignment]
+    _player_id: int
+    _warp_effect: Optional[WarpEffect]
+
+    def __init__(self, *, player_id: int, warp_effect: Optional[WarpEffect] = None):
+        """
+        Create a new instance of AvatarRemoveServerPacket.
+
+        Args:
+            player_id (int): (Value range is 0-64008.)
+            warp_effect (Optional[WarpEffect]): 
+        """
+        self._player_id = player_id
+        self._warp_effect = warp_effect
 
     @property
     def byte_size(self) -> int:
@@ -33,28 +44,12 @@ class AvatarRemoveServerPacket(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
-
     @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 family() -> PacketFamily:
         """
@@ -93,12 +88,16 @@ class AvatarRemoveServerPacket(Packet):
             writer (EoWriter): The writer that the data will be serialized to.
             data (AvatarRemoveServerPacket): The data to serialize.
         """
-        if data._player_id is None:
-            raise SerializationError("player_id must be provided.")
-        writer.add_short(data._player_id)
-        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:
+            if data._player_id is None:
+                raise SerializationError("player_id must be provided.")
+            writer.add_short(data._player_id)
+            reached_missing_optional = data._warp_effect is None
+            if not reached_missing_optional:
+                writer.add_char(int(cast(WarpEffect, data._warp_effect)))
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
 
     @staticmethod
     def deserialize(reader: EoReader) -> "AvatarRemoveServerPacket":
@@ -111,15 +110,16 @@ class AvatarRemoveServerPacket(Packet):
         Returns:
             AvatarRemoveServerPacket: The data to serialize.
         """
-        data: AvatarRemoveServerPacket = AvatarRemoveServerPacket()
         old_chunked_reading_mode: bool = reader.chunked_reading_mode
         try:
             reader_start_position: int = reader.position
-            data._player_id = reader.get_short()
+            player_id = reader.get_short()
+            warp_effect: Optional[WarpEffect] = None
             if reader.remaining > 0:
-                data._warp_effect = WarpEffect(reader.get_char())
-            data._byte_size = reader.position - reader_start_position
-            return data
+                warp_effect = WarpEffect(reader.get_char())
+            result = AvatarRemoveServerPacket(player_id=player_id, warp_effect=warp_effect)
+            result._byte_size = reader.position - reader_start_position
+            return result
         finally:
             reader.chunked_reading_mode = old_chunked_reading_mode