Skip to content

avatar_admin_server_packet

AvatarAdminServerPacket

Bases: Packet

Nearby player hit by a damage spell from a player

Source code in src/eolib/protocol/_generated/net/server/avatar_admin_server_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
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 AvatarAdminServerPacket(Packet):
    """
    Nearby player hit by a damage spell from a player
    """
    _byte_size: int = 0
    _caster_id: int
    _victim_id: int
    _damage: int
    _caster_direction: Direction
    _hp_percentage: int
    _victim_died: bool
    _spell_id: int

    def __init__(self, *, caster_id: int, victim_id: int, damage: int, caster_direction: Direction, hp_percentage: int, victim_died: bool, spell_id: int):
        """
        Create a new instance of AvatarAdminServerPacket.

        Args:
            caster_id (int): (Value range is 0-64008.)
            victim_id (int): (Value range is 0-64008.)
            damage (int): (Value range is 0-16194276.)
            caster_direction (Direction): 
            hp_percentage (int): (Value range is 0-252.)
            victim_died (bool): 
            spell_id (int): (Value range is 0-64008.)
        """
        self._caster_id = caster_id
        self._victim_id = victim_id
        self._damage = damage
        self._caster_direction = caster_direction
        self._hp_percentage = hp_percentage
        self._victim_died = victim_died
        self._spell_id = spell_id

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

    @property
    def victim_id(self) -> int:
        return self._victim_id

    @property
    def damage(self) -> int:
        return self._damage

    @property
    def caster_direction(self) -> Direction:
        return self._caster_direction

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

    @property
    def victim_died(self) -> bool:
        return self._victim_died

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

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

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

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

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

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

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (AvatarAdminServerPacket): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            if data._caster_id is None:
                raise SerializationError("caster_id must be provided.")
            writer.add_short(data._caster_id)
            if data._victim_id is None:
                raise SerializationError("victim_id must be provided.")
            writer.add_short(data._victim_id)
            if data._damage is None:
                raise SerializationError("damage must be provided.")
            writer.add_three(data._damage)
            if data._caster_direction is None:
                raise SerializationError("caster_direction must be provided.")
            writer.add_char(int(data._caster_direction))
            if data._hp_percentage is None:
                raise SerializationError("hp_percentage must be provided.")
            writer.add_char(data._hp_percentage)
            if data._victim_died is None:
                raise SerializationError("victim_died must be provided.")
            writer.add_char(1 if data._victim_died else 0)
            if data._spell_id is None:
                raise SerializationError("spell_id must be provided.")
            writer.add_short(data._spell_id)
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            AvatarAdminServerPacket: The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            caster_id = reader.get_short()
            victim_id = reader.get_short()
            damage = reader.get_three()
            caster_direction = Direction(reader.get_char())
            hp_percentage = reader.get_char()
            victim_died = reader.get_char() != 0
            spell_id = reader.get_short()
            result = AvatarAdminServerPacket(caster_id=caster_id, victim_id=victim_id, damage=damage, caster_direction=caster_direction, hp_percentage=hp_percentage, victim_died=victim_died, spell_id=spell_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"AvatarAdminServerPacket(byte_size={repr(self._byte_size)}, caster_id={repr(self._caster_id)}, victim_id={repr(self._victim_id)}, damage={repr(self._damage)}, caster_direction={repr(self._caster_direction)}, hp_percentage={repr(self._hp_percentage)}, victim_died={repr(self._victim_died)}, spell_id={repr(self._spell_id)})"

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.

caster_id: int property

victim_id: int property

damage: int property

caster_direction: Direction property

hp_percentage: int property

victim_died: bool property

spell_id: int property

__init__(*, caster_id, victim_id, damage, caster_direction, hp_percentage, victim_died, spell_id)

Create a new instance of AvatarAdminServerPacket.

Parameters:

Name Type Description Default
caster_id int

(Value range is 0-64008.)

 required
victim_id int

(Value range is 0-64008.)

 required
damage int

(Value range is 0-16194276.)

 required
caster_direction Direction
required
hp_percentage int

(Value range is 0-252.)

 required
victim_died bool
required
spell_id int

(Value range is 0-64008.)

 required
Source code in src/eolib/protocol/_generated/net/server/avatar_admin_server_packet.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(self, *, caster_id: int, victim_id: int, damage: int, caster_direction: Direction, hp_percentage: int, victim_died: bool, spell_id: int):
    """
    Create a new instance of AvatarAdminServerPacket.

    Args:
        caster_id (int): (Value range is 0-64008.)
        victim_id (int): (Value range is 0-64008.)
        damage (int): (Value range is 0-16194276.)
        caster_direction (Direction): 
        hp_percentage (int): (Value range is 0-252.)
        victim_died (bool): 
        spell_id (int): (Value range is 0-64008.)
    """
    self._caster_id = caster_id
    self._victim_id = victim_id
    self._damage = damage
    self._caster_direction = caster_direction
    self._hp_percentage = hp_percentage
    self._victim_died = victim_died
    self._spell_id = spell_id

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/avatar_admin_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.Avatar

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/avatar_admin_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.Admin

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

serialize(writer, data) staticmethod

Serializes an instance of AvatarAdminServerPacket to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data AvatarAdminServerPacket

The data to serialize.

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

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (AvatarAdminServerPacket): The data to serialize.
    """
    old_string_sanitization_mode: bool = writer.string_sanitization_mode
    try:
        if data._caster_id is None:
            raise SerializationError("caster_id must be provided.")
        writer.add_short(data._caster_id)
        if data._victim_id is None:
            raise SerializationError("victim_id must be provided.")
        writer.add_short(data._victim_id)
        if data._damage is None:
            raise SerializationError("damage must be provided.")
        writer.add_three(data._damage)
        if data._caster_direction is None:
            raise SerializationError("caster_direction must be provided.")
        writer.add_char(int(data._caster_direction))
        if data._hp_percentage is None:
            raise SerializationError("hp_percentage must be provided.")
        writer.add_char(data._hp_percentage)
        if data._victim_died is None:
            raise SerializationError("victim_died must be provided.")
        writer.add_char(1 if data._victim_died else 0)
        if data._spell_id is None:
            raise SerializationError("spell_id must be provided.")
        writer.add_short(data._spell_id)
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

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

The data to serialize.
Source code in src/eolib/protocol/_generated/net/server/avatar_admin_server_packet.py 
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) -> "AvatarAdminServerPacket":
    """
    Deserializes an instance of `AvatarAdminServerPacket` from the provided `EoReader`.

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

    Returns:
        AvatarAdminServerPacket: The data to serialize.
    """
    old_chunked_reading_mode: bool = reader.chunked_reading_mode
    try:
        reader_start_position: int = reader.position
        caster_id = reader.get_short()
        victim_id = reader.get_short()
        damage = reader.get_three()
        caster_direction = Direction(reader.get_char())
        hp_percentage = reader.get_char()
        victim_died = reader.get_char() != 0
        spell_id = reader.get_short()
        result = AvatarAdminServerPacket(caster_id=caster_id, victim_id=victim_id, damage=damage, caster_direction=caster_direction, hp_percentage=hp_percentage, victim_died=victim_died, spell_id=spell_id)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode