Source code for eolib.protocol.net.server.trade_open_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 ....serialization_error import SerializationError
from ....net.packet import Packet
from .....data.eo_writer import EoWriter
from .....data.eo_reader import EoReader
[docs]
class TradeOpenServerPacket(Packet):
"""
Trade window opens
"""
_byte_size: int = 0
_partner_player_id: int
_partner_player_name: str
_your_player_id: int
_your_player_name: str
[docs]
def __init__(self, *, partner_player_id: int, partner_player_name: str, your_player_id: int, your_player_name: str):
"""
Create a new instance of TradeOpenServerPacket.
Args:
partner_player_id: (Value range is 0-64008.)
partner_player_name:
your_player_id: (Value range is 0-64008.)
your_player_name:
"""
self._partner_player_id = partner_player_id
self._partner_player_name = partner_player_name
self._your_player_id = your_player_id
self._your_player_name = your_player_name
@property
def byte_size(self) -> int:
"""
The size of the data that this was deserialized from.
"""
return self._byte_size
@property
def partner_player_id(self) -> int:
"""
The `partner_player_id` field.
"""
return self._partner_player_id
@property
def partner_player_name(self) -> str:
"""
The `partner_player_name` field.
"""
return self._partner_player_name
@property
def your_player_id(self) -> int:
"""
The `your_player_id` field.
"""
return self._your_player_id
@property
def your_player_name(self) -> str:
"""
The `your_player_name` field.
"""
return self._your_player_name
[docs]
@staticmethod
def family() -> PacketFamily:
"""
Returns the packet family associated with this packet.
Returns:
The packet family associated with this packet.
"""
return PacketFamily.Trade
[docs]
@staticmethod
def action() -> PacketAction:
"""
Returns the packet action associated with this packet.
Returns:
The packet action associated with this packet.
"""
return PacketAction.Open
[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.
"""
TradeOpenServerPacket.serialize(writer, self)
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "TradeOpenServerPacket") -> None:
"""
Serializes an instance of `TradeOpenServerPacket` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (TradeOpenServerPacket): The data to serialize.
"""
old_string_sanitization_mode: bool = writer.string_sanitization_mode
try:
writer.string_sanitization_mode = True
if data._partner_player_id is None:
raise SerializationError("partner_player_id must be provided.")
writer.add_short(data._partner_player_id)
if data._partner_player_name is None:
raise SerializationError("partner_player_name must be provided.")
writer.add_string(data._partner_player_name)
writer.add_byte(0xFF)
if data._your_player_id is None:
raise SerializationError("your_player_id must be provided.")
writer.add_short(data._your_player_id)
if data._your_player_name is None:
raise SerializationError("your_player_name must be provided.")
writer.add_string(data._your_player_name)
writer.add_byte(0xFF)
writer.string_sanitization_mode = False
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "TradeOpenServerPacket":
"""
Deserializes an instance of `TradeOpenServerPacket` 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
partner_player_id = reader.get_short()
partner_player_name = reader.get_string()
reader.next_chunk()
your_player_id = reader.get_short()
your_player_name = reader.get_string()
reader.next_chunk()
reader.chunked_reading_mode = False
result = TradeOpenServerPacket(partner_player_id=partner_player_id, partner_player_name=partner_player_name, your_player_id=your_player_id, your_player_name=your_player_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"TradeOpenServerPacket(byte_size={repr(self._byte_size)}, partner_player_id={repr(self._partner_player_id)}, partner_player_name={repr(self._partner_player_name)}, your_player_id={repr(self._your_player_id)}, your_player_name={repr(self._your_player_name)})"