Source code for eolib.protocol.net.server.cast_reply_server_packet

# Generated from the eo-protocol XML specification.
#
# This file should not be modified.
# Changes will be lost when code is regenerated.

from typing import cast
from typing import Optional
from .npc_kill_steal_protection_state import NpcKillStealProtectionState
from ..packet_family import PacketFamily
from ..packet_action import PacketAction
from ...direction import Direction
from ....serialization_error import SerializationError
from ....net.packet import Packet
from .....data.eo_writer import EoWriter
from .....data.eo_reader import EoReader



class CastReplyServerPacket(Packet):
    """
    Nearby NPC hit by a spell from a player
    """
    _byte_size: int = 0
    _spell_id: int
    _caster_id: int
    _caster_direction: Direction
    _npc_index: int
    _damage: int
    _hp_percentage: int
    _caster_tp: Optional[int]
    _kill_steal_protection: Optional[NpcKillStealProtectionState]



    def __init__(self, *, spell_id: int, caster_id: int, caster_direction: Direction, npc_index: int, damage: int, hp_percentage: int, caster_tp: Optional[int] = None, kill_steal_protection: Optional[NpcKillStealProtectionState] = None):
        """
        Create a new instance of CastReplyServerPacket.

        Args:
            spell_id: (Value range is 0-64008.)
            caster_id: (Value range is 0-64008.)
            caster_direction: 
            npc_index: (Value range is 0-64008.)
            damage: (Value range is 0-16194276.)
            hp_percentage: (Value range is 0-64008.)
            caster_tp: This field should be sent to the attacker, but not nearby players (Value range is 0-64008.)
            kill_steal_protection: This field should be sent to the attacker, but not nearby players
        """
        self._spell_id = spell_id
        self._caster_id = caster_id
        self._caster_direction = caster_direction
        self._npc_index = npc_index
        self._damage = damage
        self._hp_percentage = hp_percentage
        self._caster_tp = caster_tp
        self._kill_steal_protection = kill_steal_protection


    @property
    def byte_size(self) -> int:
        """
        The size of the data that this was deserialized from.
        """
        return self._byte_size

    @property
    def spell_id(self) -> int:
        """
        The `spell_id` field.
        """
        return self._spell_id

    @property
    def caster_id(self) -> int:
        """
        The `caster_id` field.
        """
        return self._caster_id

    @property
    def caster_direction(self) -> Direction:
        """
        The `caster_direction` field.
        """
        return self._caster_direction

    @property
    def npc_index(self) -> int:
        """
        The `npc_index` field.
        """
        return self._npc_index

    @property
    def damage(self) -> int:
        """
        The `damage` field.
        """
        return self._damage

    @property
    def hp_percentage(self) -> int:
        """
        The `hp_percentage` field.
        """
        return self._hp_percentage

    @property
    def caster_tp(self) -> Optional[int]:
        """
        This field should be sent to the attacker, but not nearby players
        """
        return self._caster_tp

    @property
    def kill_steal_protection(self) -> Optional[NpcKillStealProtectionState]:
        """
        This field should be sent to the attacker, but not nearby players
        """
        return self._kill_steal_protection



    @staticmethod
    def family() -> PacketFamily:
        """
        Returns the packet family associated with this packet.

        Returns:
            The packet family associated with this packet.
        """
        return PacketFamily.Cast




    @staticmethod
    def action() -> PacketAction:
        """
        Returns the packet action associated with this packet.

        Returns:
            The packet action associated with this packet.
        """
        return PacketAction.Reply




    def write(self, writer):
        """
        Serializes and writes this packet to the provided EoWriter.

        Args:
            writer (EoWriter): the writer that this packet will be written to.
        """
        CastReplyServerPacket.serialize(writer, self)




    @staticmethod
    def serialize(writer: EoWriter, data: "CastReplyServerPacket") -> None:
        """
        Serializes an instance of `CastReplyServerPacket` to the provided `EoWriter`.

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (CastReplyServerPacket): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            if data._spell_id is None:
                raise SerializationError("spell_id must be provided.")
            writer.add_short(data._spell_id)
            if data._caster_id is None:
                raise SerializationError("caster_id must be provided.")
            writer.add_short(data._caster_id)
            if data._caster_direction is None:
                raise SerializationError("caster_direction must be provided.")
            writer.add_char(int(data._caster_direction))
            if data._npc_index is None:
                raise SerializationError("npc_index must be provided.")
            writer.add_short(data._npc_index)
            if data._damage is None:
                raise SerializationError("damage must be provided.")
            writer.add_three(data._damage)
            if data._hp_percentage is None:
                raise SerializationError("hp_percentage must be provided.")
            writer.add_short(data._hp_percentage)
            reached_missing_optional = data._caster_tp is None
            if not reached_missing_optional:
                writer.add_short(cast(int, data._caster_tp))
            reached_missing_optional = reached_missing_optional or data._kill_steal_protection is None
            if not reached_missing_optional:
                writer.add_char(int(cast(NpcKillStealProtectionState, data._kill_steal_protection)))
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode




    @staticmethod
    def deserialize(reader: EoReader) -> "CastReplyServerPacket":
        """
        Deserializes an instance of `CastReplyServerPacket` from the provided `EoReader`.

        Args:
            reader (EoReader): The writer that the data will be serialized to.

        Returns:
            The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            spell_id = reader.get_short()
            caster_id = reader.get_short()
            caster_direction = Direction(reader.get_char())
            npc_index = reader.get_short()
            damage = reader.get_three()
            hp_percentage = reader.get_short()
            caster_tp: Optional[int] = None
            if reader.remaining > 0:
                caster_tp = reader.get_short()
            kill_steal_protection: Optional[NpcKillStealProtectionState] = None
            if reader.remaining > 0:
                kill_steal_protection = NpcKillStealProtectionState(reader.get_char())
            result = CastReplyServerPacket(spell_id=spell_id, caster_id=caster_id, caster_direction=caster_direction, npc_index=npc_index, damage=damage, hp_percentage=hp_percentage, caster_tp=caster_tp, kill_steal_protection=kill_steal_protection)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode


    def __repr__(self):
        return f"CastReplyServerPacket(byte_size={repr(self._byte_size)}, spell_id={repr(self._spell_id)}, caster_id={repr(self._caster_id)}, caster_direction={repr(self._caster_direction)}, npc_index={repr(self._npc_index)}, damage={repr(self._damage)}, hp_percentage={repr(self._hp_percentage)}, caster_tp={repr(self._caster_tp)}, kill_steal_protection={repr(self._kill_steal_protection)})"