Source code for eolib.protocol.net.server.emote_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 ..packet_family import PacketFamily
from ..packet_action import PacketAction
from ...emote import Emote
from ....serialization_error import SerializationError
from ....net.packet import Packet
from .....data.eo_writer import EoWriter
from .....data.eo_reader import EoReader
[docs]
class EmotePlayerServerPacket(Packet):
"""
Nearby player doing an emote
"""
_byte_size: int = 0
_player_id: int
_emote: Emote
[docs]
def __init__(self, *, player_id: int, emote: Emote):
"""
Create a new instance of EmotePlayerServerPacket.
Args:
player_id: (Value range is 0-64008.)
emote:
"""
self._player_id = player_id
self._emote = emote
@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 emote(self) -> Emote:
"""
The `emote` field.
"""
return self._emote
[docs]
@staticmethod
def family() -> PacketFamily:
"""
Returns the packet family associated with this packet.
Returns:
The packet family associated with this packet.
"""
return PacketFamily.Emote
[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.
"""
EmotePlayerServerPacket.serialize(writer, self)
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "EmotePlayerServerPacket") -> None:
"""
Serializes an instance of `EmotePlayerServerPacket` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (EmotePlayerServerPacket): The data to serialize.
"""
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._emote is None:
raise SerializationError("emote must be provided.")
writer.add_char(int(data._emote))
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "EmotePlayerServerPacket":
"""
Deserializes an instance of `EmotePlayerServerPacket` 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
player_id = reader.get_short()
emote = Emote(reader.get_char())
result = EmotePlayerServerPacket(player_id=player_id, emote=emote)
result._byte_size = reader.position - reader_start_position
return result
finally:
reader.chunked_reading_mode = old_chunked_reading_mode
def __repr__(self):
return f"EmotePlayerServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, emote={repr(self._emote)})"