Source code for eolib.protocol.net.server.npc_player_server_packet
# Generated from the eo-protocol XML specification.
#
# This file should not be modified.
# Changes will be lost when code is regenerated.
from __future__ import annotations
from typing import cast
from typing import Optional
from collections.abc import Iterable
from .npc_update_position import NpcUpdatePosition
from .npc_update_chat import NpcUpdateChat
from .npc_update_attack import NpcUpdateAttack
from ..packet_family import PacketFamily
from ..packet_action import PacketAction
from ....serialization_error import SerializationError
from ....net.packet import Packet
from .....data.eo_writer import EoWriter
from .....data.eo_reader import EoReader
[docs]
class NpcPlayerServerPacket(Packet):
"""
Main NPC update message
"""
_byte_size: int = 0
_positions: tuple[NpcUpdatePosition, ...]
_attacks: tuple[NpcUpdateAttack, ...]
_chats: tuple[NpcUpdateChat, ...]
_hp: Optional[int]
_tp: Optional[int]
[docs]
def __init__(self, *, positions: Iterable[NpcUpdatePosition], attacks: Iterable[NpcUpdateAttack], chats: Iterable[NpcUpdateChat], hp: Optional[int] = None, tp: Optional[int] = None):
"""
Create a new instance of NpcPlayerServerPacket.
Args:
positions:
attacks:
chats:
hp: (Value range is 0-64008.)
tp: (Value range is 0-64008.)
"""
self._positions = tuple(positions)
self._attacks = tuple(attacks)
self._chats = tuple(chats)
self._hp = hp
self._tp = tp
@property
def byte_size(self) -> int:
"""
The size of the data that this was deserialized from.
"""
return self._byte_size
@property
def positions(self) -> tuple[NpcUpdatePosition, ...]:
"""
The `positions` field.
"""
return self._positions
@property
def attacks(self) -> tuple[NpcUpdateAttack, ...]:
"""
The `attacks` field.
"""
return self._attacks
@property
def chats(self) -> tuple[NpcUpdateChat, ...]:
"""
The `chats` field.
"""
return self._chats
@property
def hp(self) -> Optional[int]:
"""
The `hp` field.
"""
return self._hp
@property
def tp(self) -> Optional[int]:
"""
The `tp` field.
"""
return self._tp
[docs]
@staticmethod
def family() -> PacketFamily:
"""
Returns the packet family associated with this packet.
Returns:
The packet family associated with this packet.
"""
return PacketFamily.Npc
[docs]
@staticmethod
def action() -> PacketAction:
"""
Returns the packet action associated with this packet.
Returns:
The packet action associated with this packet.
"""
return PacketAction.Player
[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.
"""
NpcPlayerServerPacket.serialize(writer, self)
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "NpcPlayerServerPacket") -> None:
"""
Serializes an instance of `NpcPlayerServerPacket` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (NpcPlayerServerPacket): The data to serialize.
"""
old_string_sanitization_mode: bool = writer.string_sanitization_mode
try:
writer.string_sanitization_mode = True
if data._positions is None:
raise SerializationError("positions must be provided.")
for i in range(len(data._positions)):
NpcUpdatePosition.serialize(writer, data._positions[i])
writer.add_byte(0xFF)
if data._attacks is None:
raise SerializationError("attacks must be provided.")
for i in range(len(data._attacks)):
NpcUpdateAttack.serialize(writer, data._attacks[i])
writer.add_byte(0xFF)
if data._chats is None:
raise SerializationError("chats must be provided.")
for i in range(len(data._chats)):
NpcUpdateChat.serialize(writer, data._chats[i])
writer.add_byte(0xFF)
reached_missing_optional = data._hp is None
if not reached_missing_optional:
writer.add_short(cast(int, data._hp))
reached_missing_optional = reached_missing_optional or data._tp is None
if not reached_missing_optional:
writer.add_short(cast(int, data._tp))
writer.string_sanitization_mode = False
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "NpcPlayerServerPacket":
"""
Deserializes an instance of `NpcPlayerServerPacket` 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
positions_length = int(reader.remaining / 4)
positions = []
for i in range(positions_length):
positions.append(NpcUpdatePosition.deserialize(reader))
reader.next_chunk()
attacks_length = int(reader.remaining / 9)
attacks = []
for i in range(attacks_length):
attacks.append(NpcUpdateAttack.deserialize(reader))
reader.next_chunk()
chats = []
while reader.remaining > 0:
chats.append(NpcUpdateChat.deserialize(reader))
reader.next_chunk()
hp: Optional[int] = None
if reader.remaining > 0:
hp = reader.get_short()
tp: Optional[int] = None
if reader.remaining > 0:
tp = reader.get_short()
reader.chunked_reading_mode = False
result = NpcPlayerServerPacket(positions=positions, attacks=attacks, chats=chats, hp=hp, tp=tp)
result._byte_size = reader.position - reader_start_position
return result
finally:
reader.chunked_reading_mode = old_chunked_reading_mode
def __repr__(self):
return f"NpcPlayerServerPacket(byte_size={repr(self._byte_size)}, positions={repr(self._positions)}, attacks={repr(self._attacks)}, chats={repr(self._chats)}, hp={repr(self._hp)}, tp={repr(self._tp)})"