Skip to content

init_init_client_packet

InitInitClientPacket

Bases: Packet

Connection initialization request. This packet is unencrypted.

Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
class InitInitClientPacket(Packet):
    """
    Connection initialization request.
    This packet is unencrypted.
    """
    _byte_size: int = 0
    _challenge: int
    _version: Version
    _hdid_length: int
    _hdid: str

    def __init__(self, *, challenge: int, version: Version, hdid: str):
        """
        Create a new instance of InitInitClientPacket.

        Args:
            challenge (int): (Value range is 0-16194276.)
            version (Version): 
            hdid (str): (Length must be 252 or less.)
        """
        self._challenge = challenge
        self._version = version
        self._hdid = hdid
        self._hdid_length = len(self._hdid)

    @property
    def byte_size(self) -> int:
        """
        Returns the size of the data that this was deserialized from.

        Returns:
            int: The size of the data that this was deserialized from.
        """
        return self._byte_size

    @property
    def challenge(self) -> int:
        return self._challenge

    @property
    def version(self) -> Version:
        return self._version

    @property
    def hdid(self) -> str:
        return self._hdid

    @staticmethod
    def family() -> PacketFamily:
        """
        Returns the packet family associated with this packet.

        Returns:
            PacketFamily: The packet family associated with this packet.
        """
        return PacketFamily.Init

    @staticmethod
    def action() -> PacketAction:
        """
        Returns the packet action associated with this packet.

        Returns:
            PacketAction: The packet action associated with this packet.
        """
        return PacketAction.Init

    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.
        """
        InitInitClientPacket.serialize(writer, self)

    @staticmethod
    def serialize(writer: EoWriter, data: "InitInitClientPacket") -> None:
        """
        Serializes an instance of `InitInitClientPacket` to the provided `EoWriter`.

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (InitInitClientPacket): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            if data._challenge is None:
                raise SerializationError("challenge must be provided.")
            writer.add_three(data._challenge)
            if data._version is None:
                raise SerializationError("version must be provided.")
            Version.serialize(writer, data._version)
            writer.add_char(112)
            if data._hdid_length is None:
                raise SerializationError("hdid_length must be provided.")
            writer.add_char(data._hdid_length)
            if data._hdid is None:
                raise SerializationError("hdid must be provided.")
            if len(data._hdid) > 252:
                raise SerializationError(f"Expected length of hdid to be 252 or less, got {len(data._hdid)}.")
            writer.add_fixed_string(data._hdid, data._hdid_length, False)
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

    @staticmethod
    def deserialize(reader: EoReader) -> "InitInitClientPacket":
        """
        Deserializes an instance of `InitInitClientPacket` from the provided `EoReader`.

        Args:
            reader (EoReader): The writer that the data will be serialized to.

        Returns:
            InitInitClientPacket: The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            challenge = reader.get_three()
            version = Version.deserialize(reader)
            reader.get_char()
            hdid_length = reader.get_char()
            hdid = reader.get_fixed_string(hdid_length, False)
            result = InitInitClientPacket(challenge=challenge, version=version, hdid=hdid)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"InitInitClientPacket(byte_size={repr(self._byte_size)}, challenge={repr(self._challenge)}, version={repr(self._version)}, hdid={repr(self._hdid)})"

byte_size: int property

Returns the size of the data that this was deserialized from.

Returns:

Name Type Description
int int

The size of the data that this was deserialized from.

challenge: int property

version: Version property

hdid: str property

__init__(*, challenge, version, hdid)

Create a new instance of InitInitClientPacket.

Parameters:

Name Type Description Default
challenge int

(Value range is 0-16194276.)

 required
version Version
required
hdid str

(Length must be 252 or less.)

 required
Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
def __init__(self, *, challenge: int, version: Version, hdid: str):
    """
    Create a new instance of InitInitClientPacket.

    Args:
        challenge (int): (Value range is 0-16194276.)
        version (Version): 
        hdid (str): (Length must be 252 or less.)
    """
    self._challenge = challenge
    self._version = version
    self._hdid = hdid
    self._hdid_length = len(self._hdid)

family() staticmethod

Returns the packet family associated with this packet.

Returns:

Name Type Description
PacketFamily PacketFamily

The packet family associated with this packet.
Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
61
62
63
64
65
66
67
68
69
@staticmethod
def family() -> PacketFamily:
    """
    Returns the packet family associated with this packet.

    Returns:
        PacketFamily: The packet family associated with this packet.
    """
    return PacketFamily.Init

action() staticmethod

Returns the packet action associated with this packet.

Returns:

Name Type Description
PacketAction PacketAction

The packet action associated with this packet.
Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
71
72
73
74
75
76
77
78
79
@staticmethod
def action() -> PacketAction:
    """
    Returns the packet action associated with this packet.

    Returns:
        PacketAction: The packet action associated with this packet.
    """
    return PacketAction.Init

write(writer)

Serializes and writes this packet to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

the writer that this packet will be written to.

 required
Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
81
82
83
84
85
86
87
88
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.
    """
    InitInitClientPacket.serialize(writer, self)

serialize(writer, data) staticmethod

Serializes an instance of InitInitClientPacket to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data InitInitClientPacket

The data to serialize.

 required
Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
@staticmethod
def serialize(writer: EoWriter, data: "InitInitClientPacket") -> None:
    """
    Serializes an instance of `InitInitClientPacket` to the provided `EoWriter`.

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (InitInitClientPacket): The data to serialize.
    """
    old_string_sanitization_mode: bool = writer.string_sanitization_mode
    try:
        if data._challenge is None:
            raise SerializationError("challenge must be provided.")
        writer.add_three(data._challenge)
        if data._version is None:
            raise SerializationError("version must be provided.")
        Version.serialize(writer, data._version)
        writer.add_char(112)
        if data._hdid_length is None:
            raise SerializationError("hdid_length must be provided.")
        writer.add_char(data._hdid_length)
        if data._hdid is None:
            raise SerializationError("hdid must be provided.")
        if len(data._hdid) > 252:
            raise SerializationError(f"Expected length of hdid to be 252 or less, got {len(data._hdid)}.")
        writer.add_fixed_string(data._hdid, data._hdid_length, False)
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

Deserializes an instance of InitInitClientPacket from the provided EoReader.

Parameters:

Name Type Description Default
reader EoReader

The writer that the data will be serialized to.

 required

Returns:

Name Type Description
InitInitClientPacket InitInitClientPacket

The data to serialize.
Source code in src/eolib/protocol/_generated/net/client/init_init_client_packet.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@staticmethod
def deserialize(reader: EoReader) -> "InitInitClientPacket":
    """
    Deserializes an instance of `InitInitClientPacket` from the provided `EoReader`.

    Args:
        reader (EoReader): The writer that the data will be serialized to.

    Returns:
        InitInitClientPacket: The data to serialize.
    """
    old_chunked_reading_mode: bool = reader.chunked_reading_mode
    try:
        reader_start_position: int = reader.position
        challenge = reader.get_three()
        version = Version.deserialize(reader)
        reader.get_char()
        hdid_length = reader.get_char()
        hdid = reader.get_fixed_string(hdid_length, False)
        result = InitInitClientPacket(challenge=challenge, version=version, hdid=hdid)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode