Skip to content

spell_target_self_server_packet

SpellTargetSelfServerPacket

Bases: Packet

Nearby player self-casted a spell

Source code in src/eolib/protocol/_generated/net/server/spell_target_self_server_packet.py
 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
class SpellTargetSelfServerPacket(Packet):
    """
    Nearby player self-casted a spell
    """
    _byte_size: int = 0
    _player_id: int
    _spell_id: int
    _spell_heal_hp: int
    _hp_percentage: int
    _hp: Optional[int]
    _tp: Optional[int]

    def __init__(self, *, player_id: int, spell_id: int, spell_heal_hp: int, hp_percentage: int, hp: Optional[int] = None, tp: Optional[int] = None):
        """
        Create a new instance of SpellTargetSelfServerPacket.

        Args:
            player_id (int): (Value range is 0-64008.)
            spell_id (int): (Value range is 0-64008.)
            spell_heal_hp (int): (Value range is 0-4097152080.)
            hp_percentage (int): (Value range is 0-252.)
            hp (Optional[int]): The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)
            tp (Optional[int]): The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)
        """
        self._player_id = player_id
        self._spell_id = spell_id
        self._spell_heal_hp = spell_heal_hp
        self._hp_percentage = hp_percentage
        self._hp = hp
        self._tp = tp

    @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 player_id(self) -> int:
        return self._player_id

    @property
    def spell_id(self) -> int:
        return self._spell_id

    @property
    def spell_heal_hp(self) -> int:
        return self._spell_heal_hp

    @property
    def hp_percentage(self) -> int:
        return self._hp_percentage

    @property
    def hp(self) -> Optional[int]:
        """
        The official client reads this if the packet is larger than 12 bytes
        """
        return self._hp

    @property
    def tp(self) -> Optional[int]:
        """
        The official client reads this if the packet is larger than 12 bytes
        """
        return self._tp

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

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

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

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

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

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (SpellTargetSelfServerPacket): 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._spell_id is None:
                raise SerializationError("spell_id must be provided.")
            writer.add_short(data._spell_id)
            if data._spell_heal_hp is None:
                raise SerializationError("spell_heal_hp must be provided.")
            writer.add_int(data._spell_heal_hp)
            if data._hp_percentage is None:
                raise SerializationError("hp_percentage must be provided.")
            writer.add_char(data._hp_percentage)
            reached_missing_optional = data._hp is None
            if not reached_missing_optional:
                writer.add_short(cast(int, data._hp))
            reached_missing_optional = reached_missing_optional or data._tp is None
            if not reached_missing_optional:
                writer.add_short(cast(int, data._tp))
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            SpellTargetSelfServerPacket: 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()
            spell_id = reader.get_short()
            spell_heal_hp = reader.get_int()
            hp_percentage = reader.get_char()
            hp: Optional[int] = None
            if reader.remaining > 0:
                hp = reader.get_short()
            tp: Optional[int] = None
            if reader.remaining > 0:
                tp = reader.get_short()
            result = SpellTargetSelfServerPacket(player_id=player_id, spell_id=spell_id, spell_heal_hp=spell_heal_hp, hp_percentage=hp_percentage, hp=hp, tp=tp)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"SpellTargetSelfServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, spell_id={repr(self._spell_id)}, spell_heal_hp={repr(self._spell_heal_hp)}, hp_percentage={repr(self._hp_percentage)}, hp={repr(self._hp)}, tp={repr(self._tp)})"

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.

player_id: int property

spell_id: int property

spell_heal_hp: int property

hp_percentage: int property

hp: Optional[int] property

The official client reads this if the packet is larger than 12 bytes

tp: Optional[int] property

The official client reads this if the packet is larger than 12 bytes

__init__(*, player_id, spell_id, spell_heal_hp, hp_percentage, hp=None, tp=None)

Create a new instance of SpellTargetSelfServerPacket.

Parameters:

Name Type Description Default
player_id int

(Value range is 0-64008.)

required
spell_id int

(Value range is 0-64008.)

required
spell_heal_hp int

(Value range is 0-4097152080.)

required
hp_percentage int

(Value range is 0-252.)

required
hp Optional[int]

The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)

None
tp Optional[int]

The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)

None
Source code in src/eolib/protocol/_generated/net/server/spell_target_self_server_packet.py
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def __init__(self, *, player_id: int, spell_id: int, spell_heal_hp: int, hp_percentage: int, hp: Optional[int] = None, tp: Optional[int] = None):
    """
    Create a new instance of SpellTargetSelfServerPacket.

    Args:
        player_id (int): (Value range is 0-64008.)
        spell_id (int): (Value range is 0-64008.)
        spell_heal_hp (int): (Value range is 0-4097152080.)
        hp_percentage (int): (Value range is 0-252.)
        hp (Optional[int]): The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)
        tp (Optional[int]): The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)
    """
    self._player_id = player_id
    self._spell_id = spell_id
    self._spell_heal_hp = spell_heal_hp
    self._hp_percentage = hp_percentage
    self._hp = hp
    self._tp = tp

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/server/spell_target_self_server_packet.py
86
87
88
89
90
91
92
93
94
@staticmethod
def family() -> PacketFamily:
    """
    Returns the packet family associated with this packet.

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

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/server/spell_target_self_server_packet.py
 96
 97
 98
 99
100
101
102
103
104
@staticmethod
def action() -> PacketAction:
    """
    Returns the packet action associated with this packet.

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

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/server/spell_target_self_server_packet.py
106
107
108
109
110
111
112
113
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.
    """
    SpellTargetSelfServerPacket.serialize(writer, self)

serialize(writer, data) staticmethod

Serializes an instance of SpellTargetSelfServerPacket to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

required
data SpellTargetSelfServerPacket

The data to serialize.

required
Source code in src/eolib/protocol/_generated/net/server/spell_target_self_server_packet.py
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
@staticmethod
def serialize(writer: EoWriter, data: "SpellTargetSelfServerPacket") -> None:
    """
    Serializes an instance of `SpellTargetSelfServerPacket` to the provided `EoWriter`.

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (SpellTargetSelfServerPacket): 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._spell_id is None:
            raise SerializationError("spell_id must be provided.")
        writer.add_short(data._spell_id)
        if data._spell_heal_hp is None:
            raise SerializationError("spell_heal_hp must be provided.")
        writer.add_int(data._spell_heal_hp)
        if data._hp_percentage is None:
            raise SerializationError("hp_percentage must be provided.")
        writer.add_char(data._hp_percentage)
        reached_missing_optional = data._hp is None
        if not reached_missing_optional:
            writer.add_short(cast(int, data._hp))
        reached_missing_optional = reached_missing_optional or data._tp is None
        if not reached_missing_optional:
            writer.add_short(cast(int, data._tp))
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

Deserializes an instance of SpellTargetSelfServerPacket 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
SpellTargetSelfServerPacket SpellTargetSelfServerPacket

The data to serialize.

Source code in src/eolib/protocol/_generated/net/server/spell_target_self_server_packet.py
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
@staticmethod
def deserialize(reader: EoReader) -> "SpellTargetSelfServerPacket":
    """
    Deserializes an instance of `SpellTargetSelfServerPacket` from the provided `EoReader`.

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

    Returns:
        SpellTargetSelfServerPacket: 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()
        spell_id = reader.get_short()
        spell_heal_hp = reader.get_int()
        hp_percentage = reader.get_char()
        hp: Optional[int] = None
        if reader.remaining > 0:
            hp = reader.get_short()
        tp: Optional[int] = None
        if reader.remaining > 0:
            tp = reader.get_short()
        result = SpellTargetSelfServerPacket(player_id=player_id, spell_id=spell_id, spell_heal_hp=spell_heal_hp, hp_percentage=hp_percentage, hp=hp, tp=tp)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode