Skip to content

npc_killed_data

NpcKilledData

Information about an NPC that has been killed

Source code in src/eolib/protocol/_generated/net/server/npc_killed_data.py
 12
 13
 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
class NpcKilledData:
    """
    Information about an NPC that has been killed
    """
    _byte_size: int = 0
    _killer_id: int
    _killer_direction: Direction
    _npc_index: int
    _drop_index: int
    _drop_id: int
    _drop_coords: Coords
    _drop_amount: int
    _damage: int

    def __init__(self, *, killer_id: int, killer_direction: Direction, npc_index: int, drop_index: int, drop_id: int, drop_coords: Coords, drop_amount: int, damage: int):
        """
        Create a new instance of NpcKilledData.

        Args:
            killer_id (int): (Value range is 0-64008.)
            killer_direction (Direction): 
            npc_index (int): (Value range is 0-64008.)
            drop_index (int): (Value range is 0-64008.)
            drop_id (int): (Value range is 0-64008.)
            drop_coords (Coords): 
            drop_amount (int): (Value range is 0-4097152080.)
            damage (int): (Value range is 0-16194276.)
        """
        self._killer_id = killer_id
        self._killer_direction = killer_direction
        self._npc_index = npc_index
        self._drop_index = drop_index
        self._drop_id = drop_id
        self._drop_coords = drop_coords
        self._drop_amount = drop_amount
        self._damage = damage

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

    @property
    def killer_direction(self) -> Direction:
        return self._killer_direction

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

    @property
    def drop_index(self) -> int:
        return self._drop_index

    @property
    def drop_id(self) -> int:
        return self._drop_id

    @property
    def drop_coords(self) -> Coords:
        return self._drop_coords

    @property
    def drop_amount(self) -> int:
        return self._drop_amount

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

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (NpcKilledData): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            if data._killer_id is None:
                raise SerializationError("killer_id must be provided.")
            writer.add_short(data._killer_id)
            if data._killer_direction is None:
                raise SerializationError("killer_direction must be provided.")
            writer.add_char(int(data._killer_direction))
            if data._npc_index is None:
                raise SerializationError("npc_index must be provided.")
            writer.add_short(data._npc_index)
            if data._drop_index is None:
                raise SerializationError("drop_index must be provided.")
            writer.add_short(data._drop_index)
            if data._drop_id is None:
                raise SerializationError("drop_id must be provided.")
            writer.add_short(data._drop_id)
            if data._drop_coords is None:
                raise SerializationError("drop_coords must be provided.")
            Coords.serialize(writer, data._drop_coords)
            if data._drop_amount is None:
                raise SerializationError("drop_amount must be provided.")
            writer.add_int(data._drop_amount)
            if data._damage is None:
                raise SerializationError("damage must be provided.")
            writer.add_three(data._damage)
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            NpcKilledData: The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            killer_id = reader.get_short()
            killer_direction = Direction(reader.get_char())
            npc_index = reader.get_short()
            drop_index = reader.get_short()
            drop_id = reader.get_short()
            drop_coords = Coords.deserialize(reader)
            drop_amount = reader.get_int()
            damage = reader.get_three()
            result = NpcKilledData(killer_id=killer_id, killer_direction=killer_direction, npc_index=npc_index, drop_index=drop_index, drop_id=drop_id, drop_coords=drop_coords, drop_amount=drop_amount, damage=damage)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"NpcKilledData(byte_size={repr(self._byte_size)}, killer_id={repr(self._killer_id)}, killer_direction={repr(self._killer_direction)}, npc_index={repr(self._npc_index)}, drop_index={repr(self._drop_index)}, drop_id={repr(self._drop_id)}, drop_coords={repr(self._drop_coords)}, drop_amount={repr(self._drop_amount)}, damage={repr(self._damage)})"

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.

killer_id: int property

killer_direction: Direction property

npc_index: int property

drop_index: int property

drop_id: int property

drop_coords: Coords property

drop_amount: int property

damage: int property

__init__(*, killer_id, killer_direction, npc_index, drop_index, drop_id, drop_coords, drop_amount, damage)

Create a new instance of NpcKilledData.

Parameters:

Name Type Description Default
killer_id int

(Value range is 0-64008.)

required
killer_direction Direction
required
npc_index int

(Value range is 0-64008.)

required
drop_index int

(Value range is 0-64008.)

required
drop_id int

(Value range is 0-64008.)

required
drop_coords Coords
required
drop_amount int

(Value range is 0-4097152080.)

required
damage int

(Value range is 0-16194276.)

required
Source code in src/eolib/protocol/_generated/net/server/npc_killed_data.py
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(self, *, killer_id: int, killer_direction: Direction, npc_index: int, drop_index: int, drop_id: int, drop_coords: Coords, drop_amount: int, damage: int):
    """
    Create a new instance of NpcKilledData.

    Args:
        killer_id (int): (Value range is 0-64008.)
        killer_direction (Direction): 
        npc_index (int): (Value range is 0-64008.)
        drop_index (int): (Value range is 0-64008.)
        drop_id (int): (Value range is 0-64008.)
        drop_coords (Coords): 
        drop_amount (int): (Value range is 0-4097152080.)
        damage (int): (Value range is 0-16194276.)
    """
    self._killer_id = killer_id
    self._killer_direction = killer_direction
    self._npc_index = npc_index
    self._drop_index = drop_index
    self._drop_id = drop_id
    self._drop_coords = drop_coords
    self._drop_amount = drop_amount
    self._damage = damage

serialize(writer, data) staticmethod

Serializes an instance of NpcKilledData to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

required
data NpcKilledData

The data to serialize.

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

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (NpcKilledData): The data to serialize.
    """
    old_string_sanitization_mode: bool = writer.string_sanitization_mode
    try:
        if data._killer_id is None:
            raise SerializationError("killer_id must be provided.")
        writer.add_short(data._killer_id)
        if data._killer_direction is None:
            raise SerializationError("killer_direction must be provided.")
        writer.add_char(int(data._killer_direction))
        if data._npc_index is None:
            raise SerializationError("npc_index must be provided.")
        writer.add_short(data._npc_index)
        if data._drop_index is None:
            raise SerializationError("drop_index must be provided.")
        writer.add_short(data._drop_index)
        if data._drop_id is None:
            raise SerializationError("drop_id must be provided.")
        writer.add_short(data._drop_id)
        if data._drop_coords is None:
            raise SerializationError("drop_coords must be provided.")
        Coords.serialize(writer, data._drop_coords)
        if data._drop_amount is None:
            raise SerializationError("drop_amount must be provided.")
        writer.add_int(data._drop_amount)
        if data._damage is None:
            raise SerializationError("damage must be provided.")
        writer.add_three(data._damage)
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

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

The data to serialize.

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

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

    Returns:
        NpcKilledData: The data to serialize.
    """
    old_chunked_reading_mode: bool = reader.chunked_reading_mode
    try:
        reader_start_position: int = reader.position
        killer_id = reader.get_short()
        killer_direction = Direction(reader.get_char())
        npc_index = reader.get_short()
        drop_index = reader.get_short()
        drop_id = reader.get_short()
        drop_coords = Coords.deserialize(reader)
        drop_amount = reader.get_int()
        damage = reader.get_three()
        result = NpcKilledData(killer_id=killer_id, killer_direction=killer_direction, npc_index=npc_index, drop_index=drop_index, drop_id=drop_id, drop_coords=drop_coords, drop_amount=drop_amount, damage=damage)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode