Source code for eolib.protocol.net.client.bank_add_client_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 BankAddClientPacket(Packet):
"""
Depositing gold
"""
_byte_size: int = 0
_amount: int
_session_id: int
[docs]
def __init__(self, *, amount: int, session_id: int):
"""
Create a new instance of BankAddClientPacket.
Args:
amount: (Value range is 0-4097152080.)
session_id: (Value range is 0-16194276.)
"""
self._amount = amount
self._session_id = session_id
@property
def byte_size(self) -> int:
"""
The size of the data that this was deserialized from.
"""
return self._byte_size
@property
def amount(self) -> int:
"""
The `amount` field.
"""
return self._amount
@property
def session_id(self) -> int:
"""
The `session_id` field.
"""
return self._session_id
[docs]
@staticmethod
def family() -> PacketFamily:
"""
Returns the packet family associated with this packet.
Returns:
The packet family associated with this packet.
"""
return PacketFamily.Bank
[docs]
@staticmethod
def action() -> PacketAction:
"""
Returns the packet action associated with this packet.
Returns:
The packet action associated with this packet.
"""
return PacketAction.Add
[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.
"""
BankAddClientPacket.serialize(writer, self)
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "BankAddClientPacket") -> None:
"""
Serializes an instance of `BankAddClientPacket` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (BankAddClientPacket): The data to serialize.
"""
old_string_sanitization_mode: bool = writer.string_sanitization_mode
try:
if data._amount is None:
raise SerializationError("amount must be provided.")
writer.add_int(data._amount)
if data._session_id is None:
raise SerializationError("session_id must be provided.")
writer.add_three(data._session_id)
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "BankAddClientPacket":
"""
Deserializes an instance of `BankAddClientPacket` 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
amount = reader.get_int()
session_id = reader.get_three()
result = BankAddClientPacket(amount=amount, session_id=session_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"BankAddClientPacket(byte_size={repr(self._byte_size)}, amount={repr(self._amount)}, session_id={repr(self._session_id)})"