Skip to content

npc_reply_server_packet

NpcReplyServerPacket

Bases: Packet

Nearby NPC hit by a player

Source code in src/eolib/protocol/_generated/net/server/npc_reply_server_packet.py 
 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
class NpcReplyServerPacket(Packet):
    """
    Nearby NPC hit by a player
    """
    _byte_size: int = 0
    _player_id: int
    _player_direction: Direction
    _npc_index: int
    _damage: int
    _hp_percentage: int
    _kill_steal_protection: Optional[NpcKillStealProtectionState]

    def __init__(self, *, player_id: int, player_direction: Direction, npc_index: int, damage: int, hp_percentage: int, kill_steal_protection: Optional[NpcKillStealProtectionState] = None):
        """
        Create a new instance of NpcReplyServerPacket.

        Args:
            player_id (int): (Value range is 0-64008.)
            player_direction (Direction): 
            npc_index (int): (Value range is 0-64008.)
            damage (int): (Value range is 0-16194276.)
            hp_percentage (int): (Value range is 0-64008.)
            kill_steal_protection (Optional[NpcKillStealProtectionState]): This field should be sent to the attacker, but not nearby players
        """
        self._player_id = player_id
        self._player_direction = player_direction
        self._npc_index = npc_index
        self._damage = damage
        self._hp_percentage = hp_percentage
        self._kill_steal_protection = kill_steal_protection

    @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 player_direction(self) -> Direction:
        return self._player_direction

    @property
    def npc_index(self) -> int:
        return self._npc_index

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

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

    @property
    def kill_steal_protection(self) -> Optional[NpcKillStealProtectionState]:
        """
        This field should be sent to the attacker, but not nearby players
        """
        return self._kill_steal_protection

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

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

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

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

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

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (NpcReplyServerPacket): 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._player_direction is None:
                raise SerializationError("player_direction must be provided.")
            writer.add_char(int(data._player_direction))
            if data._npc_index is None:
                raise SerializationError("npc_index must be provided.")
            writer.add_short(data._npc_index)
            if data._damage is None:
                raise SerializationError("damage must be provided.")
            writer.add_three(data._damage)
            if data._hp_percentage is None:
                raise SerializationError("hp_percentage must be provided.")
            writer.add_short(data._hp_percentage)
            reached_missing_optional = data._kill_steal_protection is None
            if not reached_missing_optional:
                writer.add_char(int(cast(NpcKillStealProtectionState, data._kill_steal_protection)))
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            NpcReplyServerPacket: 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()
            player_direction = Direction(reader.get_char())
            npc_index = reader.get_short()
            damage = reader.get_three()
            hp_percentage = reader.get_short()
            kill_steal_protection: Optional[NpcKillStealProtectionState] = None
            if reader.remaining > 0:
                kill_steal_protection = NpcKillStealProtectionState(reader.get_char())
            result = NpcReplyServerPacket(player_id=player_id, player_direction=player_direction, npc_index=npc_index, damage=damage, hp_percentage=hp_percentage, kill_steal_protection=kill_steal_protection)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"NpcReplyServerPacket(byte_size={repr(self._byte_size)}, player_id={repr(self._player_id)}, player_direction={repr(self._player_direction)}, npc_index={repr(self._npc_index)}, damage={repr(self._damage)}, hp_percentage={repr(self._hp_percentage)}, kill_steal_protection={repr(self._kill_steal_protection)})"

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

player_direction: Direction property

npc_index: int property

damage: int property

hp_percentage: int property

kill_steal_protection: Optional[NpcKillStealProtectionState] property

This field should be sent to the attacker, but not nearby players

__init__(*, player_id, player_direction, npc_index, damage, hp_percentage, kill_steal_protection=None)

Create a new instance of NpcReplyServerPacket.

Parameters:

Name Type Description Default
player_id int

(Value range is 0-64008.)

 required
player_direction Direction
required
npc_index int

(Value range is 0-64008.)

 required
damage int

(Value range is 0-16194276.)

 required
hp_percentage int

(Value range is 0-64008.)

 required
kill_steal_protection Optional[NpcKillStealProtectionState]

This field should be sent to the attacker, but not nearby players

 None
Source code in src/eolib/protocol/_generated/net/server/npc_reply_server_packet.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(self, *, player_id: int, player_direction: Direction, npc_index: int, damage: int, hp_percentage: int, kill_steal_protection: Optional[NpcKillStealProtectionState] = None):
    """
    Create a new instance of NpcReplyServerPacket.

    Args:
        player_id (int): (Value range is 0-64008.)
        player_direction (Direction): 
        npc_index (int): (Value range is 0-64008.)
        damage (int): (Value range is 0-16194276.)
        hp_percentage (int): (Value range is 0-64008.)
        kill_steal_protection (Optional[NpcKillStealProtectionState]): This field should be sent to the attacker, but not nearby players
    """
    self._player_id = player_id
    self._player_direction = player_direction
    self._npc_index = npc_index
    self._damage = damage
    self._hp_percentage = hp_percentage
    self._kill_steal_protection = kill_steal_protection

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

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

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

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

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/npc_reply_server_packet.py 
105
106
107
108
109
110
111
112
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.
    """
    NpcReplyServerPacket.serialize(writer, self)

serialize(writer, data) staticmethod

Serializes an instance of NpcReplyServerPacket to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data NpcReplyServerPacket

The data to serialize.

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

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (NpcReplyServerPacket): 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._player_direction is None:
            raise SerializationError("player_direction must be provided.")
        writer.add_char(int(data._player_direction))
        if data._npc_index is None:
            raise SerializationError("npc_index must be provided.")
        writer.add_short(data._npc_index)
        if data._damage is None:
            raise SerializationError("damage must be provided.")
        writer.add_three(data._damage)
        if data._hp_percentage is None:
            raise SerializationError("hp_percentage must be provided.")
        writer.add_short(data._hp_percentage)
        reached_missing_optional = data._kill_steal_protection is None
        if not reached_missing_optional:
            writer.add_char(int(cast(NpcKillStealProtectionState, data._kill_steal_protection)))
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

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

The data to serialize.
Source code in src/eolib/protocol/_generated/net/server/npc_reply_server_packet.py 
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
@staticmethod
def deserialize(reader: EoReader) -> "NpcReplyServerPacket":
    """
    Deserializes an instance of `NpcReplyServerPacket` from the provided `EoReader`.

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

    Returns:
        NpcReplyServerPacket: 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()
        player_direction = Direction(reader.get_char())
        npc_index = reader.get_short()
        damage = reader.get_three()
        hp_percentage = reader.get_short()
        kill_steal_protection: Optional[NpcKillStealProtectionState] = None
        if reader.remaining > 0:
            kill_steal_protection = NpcKillStealProtectionState(reader.get_char())
        result = NpcReplyServerPacket(player_id=player_id, player_direction=player_direction, npc_index=npc_index, damage=damage, hp_percentage=hp_percentage, kill_steal_protection=kill_steal_protection)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode