Source code for eolib.protocol.net.client.guild_tell_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 GuildTellClientPacket(Packet):
"""
Requested member list of a guild
"""
_byte_size: int = 0
_session_id: int
_guild_identity: str
[docs]
def __init__(self, *, session_id: int, guild_identity: str):
"""
Create a new instance of GuildTellClientPacket.
Args:
session_id: (Value range is 0-4097152080.)
guild_identity:
"""
self._session_id = session_id
self._guild_identity = guild_identity
@property
def byte_size(self) -> int:
"""
The size of the data that this was deserialized from.
"""
return self._byte_size
@property
def session_id(self) -> int:
"""
The `session_id` field.
"""
return self._session_id
@property
def guild_identity(self) -> str:
"""
The `guild_identity` field.
"""
return self._guild_identity
[docs]
@staticmethod
def family() -> PacketFamily:
"""
Returns the packet family associated with this packet.
Returns:
The packet family associated with this packet.
"""
return PacketFamily.Guild
[docs]
@staticmethod
def action() -> PacketAction:
"""
Returns the packet action associated with this packet.
Returns:
The packet action associated with this packet.
"""
return PacketAction.Tell
[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.
"""
GuildTellClientPacket.serialize(writer, self)
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "GuildTellClientPacket") -> None:
"""
Serializes an instance of `GuildTellClientPacket` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (GuildTellClientPacket): The data to serialize.
"""
old_string_sanitization_mode: bool = writer.string_sanitization_mode
try:
if data._session_id is None:
raise SerializationError("session_id must be provided.")
writer.add_int(data._session_id)
if data._guild_identity is None:
raise SerializationError("guild_identity must be provided.")
writer.add_string(data._guild_identity)
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "GuildTellClientPacket":
"""
Deserializes an instance of `GuildTellClientPacket` 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
session_id = reader.get_int()
guild_identity = reader.get_string()
result = GuildTellClientPacket(session_id=session_id, guild_identity=guild_identity)
result._byte_size = reader.position - reader_start_position
return result
finally:
reader.chunked_reading_mode = old_chunked_reading_mode
def __repr__(self):
return f"GuildTellClientPacket(byte_size={repr(self._byte_size)}, session_id={repr(self._session_id)}, guild_identity={repr(self._guild_identity)})"