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

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

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 ArenaSpecServerPacket(Packet):
    """
    Arena kill message
    """
    _byte_size: int = 0
    _player_id: int
    _direction: Direction
    _kills_count: int
    _killer_name: str
    _victim_name: str



    def __init__(self, *, player_id: int, direction: Direction, kills_count: int, killer_name: str, victim_name: str):
        """
        Create a new instance of ArenaSpecServerPacket.

        Args:
            player_id: (Value range is 0-64008.)
            direction: 
            kills_count: (Value range is 0-4097152080.)
            killer_name: 
            victim_name: 
        """
        self._player_id = player_id
        self._direction = direction
        self._kills_count = kills_count
        self._killer_name = killer_name
        self._victim_name = victim_name


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

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

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

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

    @property
    def killer_name(self) -> str:
        """
        The `killer_name` field.
        """
        return self._killer_name

    @property
    def victim_name(self) -> str:
        """
        The `victim_name` field.
        """
        return self._victim_name



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

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




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

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




    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.
        """
        ArenaSpecServerPacket.serialize(writer, self)




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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (ArenaSpecServerPacket): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            writer.string_sanitization_mode = True
            if data._player_id is None:
                raise SerializationError("player_id must be provided.")
            writer.add_short(data._player_id)
            writer.add_byte(0xFF)
            if data._direction is None:
                raise SerializationError("direction must be provided.")
            writer.add_char(int(data._direction))
            writer.add_byte(0xFF)
            if data._kills_count is None:
                raise SerializationError("kills_count must be provided.")
            writer.add_int(data._kills_count)
            writer.add_byte(0xFF)
            if data._killer_name is None:
                raise SerializationError("killer_name must be provided.")
            writer.add_string(data._killer_name)
            writer.add_byte(0xFF)
            if data._victim_name is None:
                raise SerializationError("victim_name must be provided.")
            writer.add_string(data._victim_name)
            writer.string_sanitization_mode = False
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode




    @staticmethod
    def deserialize(reader: EoReader) -> "ArenaSpecServerPacket":
        """
        Deserializes an instance of `ArenaSpecServerPacket` 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
            reader.chunked_reading_mode = True
            player_id = reader.get_short()
            reader.next_chunk()
            direction = Direction(reader.get_char())
            reader.next_chunk()
            kills_count = reader.get_int()
            reader.next_chunk()
            killer_name = reader.get_string()
            reader.next_chunk()
            victim_name = reader.get_string()
            reader.chunked_reading_mode = False
            result = ArenaSpecServerPacket(player_id=player_id, direction=direction, kills_count=kills_count, killer_name=killer_name, victim_name=victim_name)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode


    def __repr__(self):
        return f"ArenaSpecServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, direction={repr(self._direction)}, kills_count={repr(self._kills_count)}, killer_name={repr(self._killer_name)}, victim_name={repr(self._victim_name)})"