Source code for eolib.protocol.net.server.avatar_admin_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
[docs]
class AvatarAdminServerPacket(Packet):
"""
Nearby player hit by a damage spell from a player
"""
_byte_size: int = 0
_caster_id: int
_victim_id: int
_damage: int
_caster_direction: Direction
_hp_percentage: int
_victim_died: bool
_spell_id: int
[docs]
def __init__(self, *, caster_id: int, victim_id: int, damage: int, caster_direction: Direction, hp_percentage: int, victim_died: bool, spell_id: int):
"""
Create a new instance of AvatarAdminServerPacket.
Args:
caster_id: (Value range is 0-64008.)
victim_id: (Value range is 0-64008.)
damage: (Value range is 0-16194276.)
caster_direction:
hp_percentage: (Value range is 0-252.)
victim_died:
spell_id: (Value range is 0-64008.)
"""
self._caster_id = caster_id
self._victim_id = victim_id
self._damage = damage
self._caster_direction = caster_direction
self._hp_percentage = hp_percentage
self._victim_died = victim_died
self._spell_id = spell_id
@property
def byte_size(self) -> int:
"""
The size of the data that this was deserialized from.
"""
return self._byte_size
@property
def caster_id(self) -> int:
"""
The `caster_id` field.
"""
return self._caster_id
@property
def victim_id(self) -> int:
"""
The `victim_id` field.
"""
return self._victim_id
@property
def damage(self) -> int:
"""
The `damage` field.
"""
return self._damage
@property
def caster_direction(self) -> Direction:
"""
The `caster_direction` field.
"""
return self._caster_direction
@property
def hp_percentage(self) -> int:
"""
The `hp_percentage` field.
"""
return self._hp_percentage
@property
def victim_died(self) -> bool:
"""
The `victim_died` field.
"""
return self._victim_died
@property
def spell_id(self) -> int:
"""
The `spell_id` field.
"""
return self._spell_id
[docs]
@staticmethod
def family() -> PacketFamily:
"""
Returns the packet family associated with this packet.
Returns:
The packet family associated with this packet.
"""
return PacketFamily.Avatar
[docs]
@staticmethod
def action() -> PacketAction:
"""
Returns the packet action associated with this packet.
Returns:
The packet action associated with this packet.
"""
return PacketAction.Admin
[docs]
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.
"""
AvatarAdminServerPacket.serialize(writer, self)
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "AvatarAdminServerPacket") -> None:
"""
Serializes an instance of `AvatarAdminServerPacket` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (AvatarAdminServerPacket): The data to serialize.
"""
old_string_sanitization_mode: bool = writer.string_sanitization_mode
try:
if data._caster_id is None:
raise SerializationError("caster_id must be provided.")
writer.add_short(data._caster_id)
if data._victim_id is None:
raise SerializationError("victim_id must be provided.")
writer.add_short(data._victim_id)
if data._damage is None:
raise SerializationError("damage must be provided.")
writer.add_three(data._damage)
if data._caster_direction is None:
raise SerializationError("caster_direction must be provided.")
writer.add_char(int(data._caster_direction))
if data._hp_percentage is None:
raise SerializationError("hp_percentage must be provided.")
writer.add_char(data._hp_percentage)
if data._victim_died is None:
raise SerializationError("victim_died must be provided.")
writer.add_char(1 if data._victim_died else 0)
if data._spell_id is None:
raise SerializationError("spell_id must be provided.")
writer.add_short(data._spell_id)
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "AvatarAdminServerPacket":
"""
Deserializes an instance of `AvatarAdminServerPacket` 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
caster_id = reader.get_short()
victim_id = reader.get_short()
damage = reader.get_three()
caster_direction = Direction(reader.get_char())
hp_percentage = reader.get_char()
victim_died = reader.get_char() != 0
spell_id = reader.get_short()
result = AvatarAdminServerPacket(caster_id=caster_id, victim_id=victim_id, damage=damage, caster_direction=caster_direction, hp_percentage=hp_percentage, victim_died=victim_died, spell_id=spell_id)
result._byte_size = reader.position - reader_start_position
return result
finally:
reader.chunked_reading_mode = old_chunked_reading_mode
def __repr__(self):
return f"AvatarAdminServerPacket(byte_size={repr(self._byte_size)}, caster_id={repr(self._caster_id)}, victim_id={repr(self._victim_id)}, damage={repr(self._damage)}, caster_direction={repr(self._caster_direction)}, hp_percentage={repr(self._hp_percentage)}, victim_died={repr(self._victim_died)}, spell_id={repr(self._spell_id)})"