eolib.protocol.net.server

EO network server packet data structures.

class AccountReply[source]

Bases: IntEnum

Reply code sent with ACCOUNT_REPLY packet

Exists = 1
NotApproved = 2
Created = 3
ChangeFailed = 5
Changed = 6
RequestDenied = 7
class AccountReplyServerPacket[source]

Bases: Packet

Reply to client Account-family packets

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of AccountReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: AccountReply

Sometimes an AccountReply code, sometimes a session ID for account creation

property reply_code_data: ReplyCodeDataExists | ReplyCodeDataNotApproved | ReplyCodeDataCreated | ReplyCodeDataChangeFailed | ReplyCodeDataChanged | ReplyCodeDataRequestDenied | ReplyCodeDataDefault | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AccountReplyServerPacket[source]

Deserializes an instance of AccountReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of AccountReplyServerPacket.ReplyCodeDataExists | AccountReplyServerPacket.ReplyCodeDataNotApproved | AccountReplyServerPacket.ReplyCodeDataCreated | AccountReplyServerPacket.ReplyCodeDataChangeFailed | AccountReplyServerPacket.ReplyCodeDataChanged | AccountReplyServerPacket.ReplyCodeDataRequestDenied | AccountReplyServerPacket.ReplyCodeDataDefault | None

class ReplyCodeDataExists[source]

Bases: object

Data associated with reply_code value AccountReply.Exists

__init__()[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataExists.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataExists to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataExists[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataExists from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataNotApproved[source]

Bases: object

Data associated with reply_code value AccountReply.NotApproved

__init__()[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataNotApproved.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataNotApproved to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataNotApproved[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataNotApproved from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataCreated[source]

Bases: object

Data associated with reply_code value AccountReply.Created

__init__()[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataCreated.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataCreated to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataCreated[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataCreated from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataChangeFailed[source]

Bases: object

Data associated with reply_code value AccountReply.ChangeFailed

__init__()[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataChangeFailed.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataChangeFailed to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataChangeFailed[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataChangeFailed from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataChanged[source]

Bases: object

Data associated with reply_code value AccountReply.Changed

__init__()[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataChanged.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataChanged to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataChanged[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataChanged from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataRequestDenied[source]

Bases: object

Data associated with reply_code value AccountReply.RequestDenied

__init__()[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataRequestDenied.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataRequestDenied to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataRequestDenied[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataRequestDenied from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataDefault[source]

Bases: object

Default data associated with reply_code

In this case (reply_code > 9), reply_code is a session ID for account creation

__init__(*, sequence_start)[source]

Create a new instance of AccountReplyServerPacket.ReplyCodeDataDefault.

Parameters:

sequence_start (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property sequence_start: int

The sequence_start field.

static serialize(writer, data) None[source]

Serializes an instance of AccountReplyServerPacket.ReplyCodeDataDefault to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataDefault[source]

Deserializes an instance of AccountReplyServerPacket.ReplyCodeDataDefault from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AdminInteractAgreeServerPacket[source]

Bases: Packet

Nearby player appearing (admin un-hide)

__init__(*, player_id)[source]

Create a new instance of AdminInteractAgreeServerPacket.

Parameters:

player_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AdminInteractAgreeServerPacket[source]

Deserializes an instance of AdminInteractAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AdminInteractListServerPacket[source]

Bases: Packet

Admin character inventory popup

__init__(*, name, usage, gold_bank, inventory, bank)[source]

Create a new instance of AdminInteractListServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property usage: int

The usage field.

property gold_bank: int

The gold_bank field.

property inventory: tuple[Item, ...]

The inventory field.

property bank: tuple[ThreeItem, ...]

The bank field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractListServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AdminInteractListServerPacket[source]

Deserializes an instance of AdminInteractListServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AdminInteractRemoveServerPacket[source]

Bases: Packet

Nearby player disappearing (admin hide)

__init__(*, player_id)[source]

Create a new instance of AdminInteractRemoveServerPacket.

Parameters:

player_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AdminInteractRemoveServerPacket[source]

Deserializes an instance of AdminInteractRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AdminInteractReplyServerPacket[source]

Bases: Packet

Incoming admin message

__init__(*, message_type, message_type_data=None)[source]

Create a new instance of AdminInteractReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property message_type: AdminMessageType

The message_type field.

property message_type_data: MessageTypeDataMessage | MessageTypeDataReport | None

Data associated with the message_type field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AdminInteractReplyServerPacket[source]

Deserializes an instance of AdminInteractReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

MessageTypeData

Data associated with different values of the message_type field.

alias of AdminInteractReplyServerPacket.MessageTypeDataMessage | AdminInteractReplyServerPacket.MessageTypeDataReport | None

class MessageTypeDataMessage[source]

Bases: object

Data associated with message_type value AdminMessageType.Message

__init__(*, player_name, message)[source]

Create a new instance of AdminInteractReplyServerPacket.MessageTypeDataMessage.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractReplyServerPacket.MessageTypeDataMessage to the provided EoWriter.

Parameters:
static deserialize(reader) MessageTypeDataMessage[source]

Deserializes an instance of AdminInteractReplyServerPacket.MessageTypeDataMessage from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MessageTypeDataReport[source]

Bases: object

Data associated with message_type value AdminMessageType.Report

__init__(*, player_name, message, reportee_name)[source]

Create a new instance of AdminInteractReplyServerPacket.MessageTypeDataReport.

Parameters:
  • player_name (str)

  • message (str)

  • reportee_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

property reportee_name: str

The reportee_name field.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractReplyServerPacket.MessageTypeDataReport to the provided EoWriter.

Parameters:
static deserialize(reader) MessageTypeDataReport[source]

Deserializes an instance of AdminInteractReplyServerPacket.MessageTypeDataReport from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AdminInteractTellServerPacket[source]

Bases: Packet

Admin character info lookup

__init__(*, name, usage, gold_bank, exp, level, map_id, map_coords, stats, weight)[source]

Create a new instance of AdminInteractTellServerPacket.

Parameters:
  • name (str)

  • usage (int) – (Value range is 0-4097152080.)

  • gold_bank (int) – (Value range is 0-4097152080.)

  • exp (int) – (Value range is 0-4097152080.)

  • level (int) – (Value range is 0-252.)

  • map_id (int) – (Value range is 0-64008.)

  • map_coords (BigCoords)

  • stats (CharacterStatsInfoLookup)

  • weight (Weight)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property usage: int

The usage field.

property gold_bank: int

The gold_bank field.

property exp: int

The exp field.

property level: int

The level field.

property map_id: int

The map_id field.

property map_coords: BigCoords

The map_coords field.

property stats: CharacterStatsInfoLookup

The stats field.

property weight: Weight

The weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AdminInteractTellServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AdminInteractTellServerPacket[source]

Deserializes an instance of AdminInteractTellServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AdminMessageType[source]

Bases: IntEnum

Type of message sent to admins via the Help menu

Message = 1
Report = 2
class ArenaAcceptServerPacket[source]

Bases: Packet

Arena win message

__init__(*, winner_name, kills_count, killer_name, victim_name)[source]

Create a new instance of ArenaAcceptServerPacket.

Parameters:
  • winner_name (str)

  • kills_count (int) – (Value range is 0-4097152080.)

  • killer_name (str)

  • victim_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property winner_name: str

The winner_name field.

property kills_count: int

The kills_count field.

property killer_name: str

The killer_name field.

property victim_name: str

The victim_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ArenaAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ArenaAcceptServerPacket[source]

Deserializes an instance of ArenaAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ArenaDropServerPacket[source]

Bases: Packet

“Arena is blocked” message

__init__()[source]

Create a new instance of ArenaDropServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ArenaDropServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ArenaDropServerPacket[source]

Deserializes an instance of ArenaDropServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ArenaSpecServerPacket[source]

Bases: Packet

Arena kill message

__init__(*, player_id, direction, kills_count, killer_name, victim_name)[source]

Create a new instance of ArenaSpecServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • direction (Direction)

  • kills_count (int) – (Value range is 0-4097152080.)

  • killer_name (str)

  • victim_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property direction: Direction

The direction field.

property kills_count: int

The kills_count field.

property killer_name: str

The killer_name field.

property victim_name: str

The victim_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ArenaSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ArenaSpecServerPacket[source]

Deserializes an instance of ArenaSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ArenaUseServerPacket[source]

Bases: Packet

Arena start message

__init__(*, players_count)[source]

Create a new instance of ArenaUseServerPacket.

Parameters:

players_count (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property players_count: int

The players_count field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ArenaUseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ArenaUseServerPacket[source]

Deserializes an instance of ArenaUseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AttackErrorServerPacket[source]

Bases: Packet

Show flood protection message (vestigial)

__init__()[source]

Create a new instance of AttackErrorServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AttackErrorServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AttackErrorServerPacket[source]

Deserializes an instance of AttackErrorServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AttackPlayerServerPacket[source]

Bases: Packet

Nearby player attacking

__init__(*, player_id, direction)[source]

Create a new instance of AttackPlayerServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • direction (Direction)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AttackPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AttackPlayerServerPacket[source]

Deserializes an instance of AttackPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AvatarAdminServerPacket[source]

Bases: Packet

Nearby player hit by a damage spell from a player

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

Create a new instance of AvatarAdminServerPacket.

Parameters:
  • 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.)

property byte_size: int

The size of the data that this was deserialized from.

property caster_id: int

The caster_id field.

property victim_id: int

The victim_id field.

property damage: int

The damage field.

property caster_direction: Direction

The caster_direction field.

property hp_percentage: int

The hp_percentage field.

property victim_died: bool

The victim_died field.

property spell_id: int

The spell_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AvatarAdminServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AvatarAdminServerPacket[source]

Deserializes an instance of AvatarAdminServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AvatarAgreeServerPacket[source]

Bases: Packet

Nearby player changed appearance

__init__(*, change)[source]

Create a new instance of AvatarAgreeServerPacket.

Parameters:

change (AvatarChange)

property byte_size: int

The size of the data that this was deserialized from.

property change: AvatarChange

The change field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AvatarAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AvatarAgreeServerPacket[source]

Deserializes an instance of AvatarAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AvatarChange[source]

Bases: object

Information about a nearby player’s appearance changing

__init__(*, player_id, change_type, sound, change_type_data=None)[source]

Create a new instance of AvatarChange.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property change_type: AvatarChangeType

The change_type field.

property sound: bool

The sound field.

property change_type_data: ChangeTypeDataEquipment | ChangeTypeDataHair | ChangeTypeDataHairColor | None

Data associated with the change_type field.

static serialize(writer, data) None[source]

Serializes an instance of AvatarChange to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (AvatarChange) – The data to serialize.

static deserialize(reader) AvatarChange[source]

Deserializes an instance of AvatarChange from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ChangeTypeData

Data associated with different values of the change_type field.

alias of AvatarChange.ChangeTypeDataEquipment | AvatarChange.ChangeTypeDataHair | AvatarChange.ChangeTypeDataHairColor | None

class ChangeTypeDataEquipment[source]

Bases: object

Data associated with change_type value AvatarChangeType.Equipment

__init__(*, equipment)[source]

Create a new instance of AvatarChange.ChangeTypeDataEquipment.

Parameters:

equipment (EquipmentChange)

property byte_size: int

The size of the data that this was deserialized from.

property equipment: EquipmentChange

The equipment field.

static serialize(writer, data) None[source]

Serializes an instance of AvatarChange.ChangeTypeDataEquipment to the provided EoWriter.

Parameters:
static deserialize(reader) ChangeTypeDataEquipment[source]

Deserializes an instance of AvatarChange.ChangeTypeDataEquipment from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChangeTypeDataHair[source]

Bases: object

Data associated with change_type value AvatarChangeType.Hair

__init__(*, hair_style, hair_color)[source]

Create a new instance of AvatarChange.ChangeTypeDataHair.

Parameters:
  • hair_style (int) – (Value range is 0-252.)

  • hair_color (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property hair_style: int

The hair_style field.

property hair_color: int

The hair_color field.

static serialize(writer, data) None[source]

Serializes an instance of AvatarChange.ChangeTypeDataHair to the provided EoWriter.

Parameters:
static deserialize(reader) ChangeTypeDataHair[source]

Deserializes an instance of AvatarChange.ChangeTypeDataHair from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChangeTypeDataHairColor[source]

Bases: object

Data associated with change_type value AvatarChangeType.HairColor

__init__(*, hair_color)[source]

Create a new instance of AvatarChange.ChangeTypeDataHairColor.

Parameters:

hair_color (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property hair_color: int

The hair_color field.

static serialize(writer, data) None[source]

Serializes an instance of AvatarChange.ChangeTypeDataHairColor to the provided EoWriter.

Parameters:
static deserialize(reader) ChangeTypeDataHairColor[source]

Deserializes an instance of AvatarChange.ChangeTypeDataHairColor from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AvatarChangeType[source]

Bases: IntEnum

How a player’s appearance is changing

Equipment = 1
Hair = 2
HairColor = 3
class AvatarRemoveServerPacket[source]

Bases: Packet

Nearby player has disappeared from view

__init__(*, player_id, warp_effect=None)[source]

Create a new instance of AvatarRemoveServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • warp_effect (WarpEffect | None, default: None)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property warp_effect: WarpEffect | None

The warp_effect field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AvatarRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AvatarRemoveServerPacket[source]

Deserializes an instance of AvatarRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class AvatarReplyServerPacket[source]

Bases: Packet

Nearby player hit by another player

__init__(*, player_id, victim_id, damage, direction, hp_percentage, dead)[source]

Create a new instance of AvatarReplyServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • victim_id (int) – (Value range is 0-64008.)

  • damage (int) – (Value range is 0-16194276.)

  • direction (Direction)

  • hp_percentage (int) – (Value range is 0-252.)

  • dead (bool)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property victim_id: int

The victim_id field.

property damage: int

The damage field.

property direction: Direction

The direction field.

property hp_percentage: int

The hp_percentage field.

property dead: bool

The dead field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of AvatarReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) AvatarReplyServerPacket[source]

Deserializes an instance of AvatarReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BankOpenServerPacket[source]

Bases: Packet

Open banker NPC interface

__init__(*, gold_bank, session_id, locker_upgrades)[source]

Create a new instance of BankOpenServerPacket.

Parameters:
  • gold_bank (int) – (Value range is 0-4097152080.)

  • session_id (int) – (Value range is 0-16194276.)

  • locker_upgrades (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_bank: int

The gold_bank field.

property session_id: int

The session_id field.

property locker_upgrades: int

The locker_upgrades field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BankOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BankOpenServerPacket[source]

Deserializes an instance of BankOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BankReplyServerPacket[source]

Bases: Packet

Update gold counts after deposit/withdraw

__init__(*, gold_inventory, gold_bank)[source]

Create a new instance of BankReplyServerPacket.

Parameters:
  • gold_inventory (int) – (Value range is 0-4097152080.)

  • gold_bank (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_inventory: int

The gold_inventory field.

property gold_bank: int

The gold_bank field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BankReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BankReplyServerPacket[source]

Deserializes an instance of BankReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BarberAgreeServerPacket[source]

Bases: Packet

Purchasing a new hair style

__init__(*, gold_amount, change)[source]

Create a new instance of BarberAgreeServerPacket.

Parameters:
  • gold_amount (int) – (Value range is 0-4097152080.)

  • change (AvatarChange)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

property change: AvatarChange

The change field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BarberAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BarberAgreeServerPacket[source]

Deserializes an instance of BarberAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BarberOpenServerPacket[source]

Bases: Packet

Response from talking to a barber NPC

__init__(*, session_id)[source]

Create a new instance of BarberOpenServerPacket.

Parameters:

session_id (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BarberOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BarberOpenServerPacket[source]

Deserializes an instance of BarberOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BigCoords[source]

Bases: object

Map coordinates with 2-byte values

__init__(*, x, y)[source]

Create a new instance of BigCoords.

Parameters:
  • x (int) – (Value range is 0-64008.)

  • y (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property x: int

The x field.

property y: int

The y field.

static serialize(writer, data) None[source]

Serializes an instance of BigCoords to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (BigCoords) – The data to serialize.

static deserialize(reader) BigCoords[source]

Deserializes an instance of BigCoords from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BoardOpenServerPacket[source]

Bases: Packet

Reply to opening a town board

__init__(*, board_id, posts)[source]

Create a new instance of BoardOpenServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property board_id: int

The board_id field.

property posts: tuple[BoardPostListing, ...]

The posts field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BoardOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BoardOpenServerPacket[source]

Deserializes an instance of BoardOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BoardPlayerServerPacket[source]

Bases: Packet

Reply to reading a post on a town board

__init__(*, post_id, post_body)[source]

Create a new instance of BoardPlayerServerPacket.

Parameters:
  • post_id (int) – (Value range is 0-64008.)

  • post_body (str)

property byte_size: int

The size of the data that this was deserialized from.

property post_id: int

The post_id field.

property post_body: str

The post_body field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BoardPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BoardPlayerServerPacket[source]

Deserializes an instance of BoardPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BoardPostListing[source]

Bases: object

An entry in the list of town board posts

__init__(*, post_id, author, subject)[source]

Create a new instance of BoardPostListing.

Parameters:
  • post_id (int) – (Value range is 0-64008.)

  • author (str)

  • subject (str)

property byte_size: int

The size of the data that this was deserialized from.

property post_id: int

The post_id field.

property author: str

The author field.

property subject: str

The subject field.

static serialize(writer, data) None[source]

Serializes an instance of BoardPostListing to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (BoardPostListing) – The data to serialize.

static deserialize(reader) BoardPostListing[source]

Deserializes an instance of BoardPostListing from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BookReplyServerPacket[source]

Bases: Packet

Reply to requesting a book

__init__(*, details, icon, quest_names)[source]

Create a new instance of BookReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property details: CharacterDetails

The details field.

property icon: CharacterIcon

The icon field.

property quest_names: tuple[str, ...]

The quest_names field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of BookReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) BookReplyServerPacket[source]

Deserializes an instance of BookReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CastAcceptServerPacket[source]

Bases: Packet

Nearby NPC killed by player spell and killer leveled up

__init__(*, spell_id, npc_killed_data, caster_tp=None, experience=None, level_up=None)[source]

Create a new instance of CastAcceptServerPacket.

Parameters:
  • spell_id (int) – (Value range is 0-64008.)

  • npc_killed_data (NpcKilledData)

  • caster_tp (int | None, default: None) – This field should be sent to the killer, but not nearby players (Value range is 0-64008.)

  • experience (int | None, default: None) – This field should be sent to the killer, but not nearby players (Value range is 0-4097152080.)

  • level_up (LevelUpStats | None, default: None) – This field should be sent to the killer if they leveled up, but not nearby players

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

property npc_killed_data: NpcKilledData

The npc_killed_data field.

property caster_tp: int | None

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

property experience: int | None

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

property level_up: LevelUpStats | None

This field should be sent to the killer if they leveled up, but not nearby players

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CastAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CastAcceptServerPacket[source]

Deserializes an instance of CastAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CastReplyServerPacket[source]

Bases: Packet

Nearby NPC hit by a spell from a player

__init__(*, spell_id, caster_id, caster_direction, npc_index, damage, hp_percentage, caster_tp=None, kill_steal_protection=None)[source]

Create a new instance of CastReplyServerPacket.

Parameters:
  • spell_id (int) – (Value range is 0-64008.)

  • caster_id (int) – (Value range is 0-64008.)

  • caster_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.)

  • caster_tp (int | None, default: None) – This field should be sent to the attacker, but not nearby players (Value range is 0-64008.)

  • kill_steal_protection (NpcKillStealProtectionState | None, default: None) – This field should be sent to the attacker, but not nearby players

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

property caster_id: int

The caster_id field.

property caster_direction: Direction

The caster_direction field.

property npc_index: int

The npc_index field.

property damage: int

The damage field.

property hp_percentage: int

The hp_percentage field.

property caster_tp: int | None

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

property kill_steal_protection: NpcKillStealProtectionState | None

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

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CastReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CastReplyServerPacket[source]

Deserializes an instance of CastReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CastSpecServerPacket[source]

Bases: Packet

Nearby NPC killed by player spell

__init__(*, spell_id, npc_killed_data, caster_tp=None, experience=None)[source]

Create a new instance of CastSpecServerPacket.

Parameters:
  • spell_id (int) – (Value range is 0-64008.)

  • npc_killed_data (NpcKilledData)

  • caster_tp (int | None, default: None) – This field should be sent to the killer, but not nearby players (Value range is 0-64008.)

  • experience (int | None, default: None) – This field should be sent to the killer, but not nearby players (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

property npc_killed_data: NpcKilledData

The npc_killed_data field.

property caster_tp: int | None

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

property experience: int | None

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

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CastSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CastSpecServerPacket[source]

Deserializes an instance of CastSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChairCloseServerPacket[source]

Bases: Packet

Your character standing up from a chair

__init__(*, player_id, coords)[source]

Create a new instance of ChairCloseServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • coords (Coords)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChairCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChairCloseServerPacket[source]

Deserializes an instance of ChairCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChairPlayerServerPacket[source]

Bases: Packet

Nearby player sitting on a chair

__init__(*, player_id, coords, direction)[source]

Create a new instance of ChairPlayerServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChairPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChairPlayerServerPacket[source]

Deserializes an instance of ChairPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChairRemoveServerPacket[source]

Bases: Packet

Nearby player standing up from a chair

__init__(*, player_id, coords)[source]

Create a new instance of ChairRemoveServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • coords (Coords)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChairRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChairRemoveServerPacket[source]

Deserializes an instance of ChairRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChairReplyServerPacket[source]

Bases: Packet

Your character sitting on a chair

__init__(*, player_id, coords, direction)[source]

Create a new instance of ChairReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChairReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChairReplyServerPacket[source]

Deserializes an instance of ChairReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterBaseStats[source]

Bases: object

The 6 base character stats

__init__(*, str, intl, wis, agi, con, cha)[source]

Create a new instance of CharacterBaseStats.

Parameters:
  • str (int) – (Value range is 0-64008.)

  • intl (int) – (Value range is 0-64008.)

  • wis (int) – (Value range is 0-64008.)

  • agi (int) – (Value range is 0-64008.)

  • con (int) – (Value range is 0-64008.)

  • cha (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property str: int

The str field.

property intl: int

The intl field.

property wis: int

The wis field.

property agi: int

The agi field.

property con: int

The con field.

property cha: int

The cha field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterBaseStats to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterBaseStats[source]

Deserializes an instance of CharacterBaseStats from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterBaseStatsWelcome[source]

Bases: object

The 6 base character stats. Sent upon selecting a character and entering the game.

__init__(*, str, wis, intl, agi, con, cha)[source]

Create a new instance of CharacterBaseStatsWelcome.

Parameters:
  • str (int) – (Value range is 0-64008.)

  • wis (int) – (Value range is 0-64008.)

  • intl (int) – (Value range is 0-64008.)

  • agi (int) – (Value range is 0-64008.)

  • con (int) – (Value range is 0-64008.)

  • cha (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property str: int

The str field.

property wis: int

The wis field.

property intl: int

The intl field.

property agi: int

The agi field.

property con: int

The con field.

property cha: int

The cha field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterBaseStatsWelcome to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterBaseStatsWelcome[source]

Deserializes an instance of CharacterBaseStatsWelcome from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterDetails[source]

Bases: object

Information displayed on the paperdoll and book

__init__(*, name, home, partner, title, guild, guild_rank, player_id, class_id, gender, admin)[source]

Create a new instance of CharacterDetails.

Parameters:
  • name (str)

  • home (str)

  • partner (str)

  • title (str)

  • guild (str)

  • guild_rank (str)

  • player_id (int) – (Value range is 0-64008.)

  • class_id (int) – (Value range is 0-252.)

  • gender (Gender)

  • admin (AdminLevel)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property home: str

The home field.

property partner: str

The partner field.

property title: str

The title field.

property guild: str

The guild field.

property guild_rank: str

The guild_rank field.

property player_id: int

The player_id field.

property class_id: int

The class_id field.

property gender: Gender

The gender field.

property admin: AdminLevel

The admin field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterDetails to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (CharacterDetails) – The data to serialize.

static deserialize(reader) CharacterDetails[source]

Deserializes an instance of CharacterDetails from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterElementalStats[source]

Bases: object

The 6 elemental character stats

__init__(*, light, dark, fire, water, earth, wind)[source]

Create a new instance of CharacterElementalStats.

Parameters:
  • light (int) – (Value range is 0-64008.)

  • dark (int) – (Value range is 0-64008.)

  • fire (int) – (Value range is 0-64008.)

  • water (int) – (Value range is 0-64008.)

  • earth (int) – (Value range is 0-64008.)

  • wind (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property light: int

The light field.

property dark: int

The dark field.

property fire: int

The fire field.

property water: int

The water field.

property earth: int

The earth field.

property wind: int

The wind field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterElementalStats to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterElementalStats[source]

Deserializes an instance of CharacterElementalStats from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterIcon[source]

Bases: IntEnum

Icon displayed in paperdolls, books, and the online list

Player = 1
Gm = 4
Hgm = 5
Party = 6
GmParty = 9
HgmParty = 10
class CharacterMapInfo[source]

Bases: object

Information about a nearby character. The official client skips these if they’re under 42 bytes in length.

__init__(*, name, player_id, map_id, coords, direction, class_id, guild_tag, level, gender, hair_style, hair_color, skin, max_hp, hp, max_tp, tp, equipment, sit_state, invisible, warp_effect=None)[source]

Create a new instance of CharacterMapInfo.

Parameters:
  • name (str)

  • player_id (int) – (Value range is 0-64008.)

  • map_id (int) – (Value range is 0-64008.)

  • coords (BigCoords)

  • direction (Direction)

  • class_id (int) – (Value range is 0-252.)

  • guild_tag (str) – (Length must be 3.)

  • level (int) – (Value range is 0-252.)

  • gender (Gender)

  • hair_style (int) – (Value range is 0-252.)

  • hair_color (int) – (Value range is 0-252.)

  • skin (int) – (Value range is 0-252.)

  • max_hp (int) – (Value range is 0-64008.)

  • hp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

  • equipment (EquipmentMapInfo)

  • sit_state (SitState)

  • invisible (bool)

  • warp_effect (WarpEffect | None, default: None)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property player_id: int

The player_id field.

property map_id: int

The map_id field.

property coords: BigCoords

The coords field.

property direction: Direction

The direction field.

property class_id: int

The class_id field.

property guild_tag: str

The guild_tag field.

property level: int

The level field.

property gender: Gender

The gender field.

property hair_style: int

The hair_style field.

property hair_color: int

The hair_color field.

property skin: int

The skin field.

property max_hp: int

The max_hp field.

property hp: int

The hp field.

property max_tp: int

The max_tp field.

property tp: int

The tp field.

property equipment: EquipmentMapInfo

The equipment field.

property sit_state: SitState

The sit_state field.

property invisible: bool

The invisible field.

property warp_effect: WarpEffect | None

The warp_effect field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterMapInfo to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (CharacterMapInfo) – The data to serialize.

static deserialize(reader) CharacterMapInfo[source]

Deserializes an instance of CharacterMapInfo from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterPlayerServerPacket[source]

Bases: Packet

Reply to client request to delete a character from the account (Character_Take)

__init__(*, session_id, character_id)[source]

Create a new instance of CharacterPlayerServerPacket.

Parameters:
  • session_id (int) – (Value range is 0-64008.)

  • character_id (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

property character_id: int

The character_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CharacterPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterPlayerServerPacket[source]

Deserializes an instance of CharacterPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterReply[source]

Bases: IntEnum

Reply code sent with CHARACTER_REPLY packet

Exists = 1
Full = 2

Only sent in reply to Character_Create packets. Displays the same message as CharacterReply.Full3 in the official client.

Full3 = 3

Only sent in reply to Character_Request packets. Displays the same message as CharacterReply.Full in the official client.

NotApproved = 4
Ok = 5
Deleted = 6
class CharacterReplyServerPacket[source]

Bases: Packet

Reply to client Character-family packets

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of CharacterReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: CharacterReply

Sometimes a CharacterReply code, sometimes a session ID for character creation

property reply_code_data: ReplyCodeDataExists | ReplyCodeDataFull | ReplyCodeDataFull3 | ReplyCodeDataNotApproved | ReplyCodeDataOk | ReplyCodeDataDeleted | ReplyCodeDataDefault | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterReplyServerPacket[source]

Deserializes an instance of CharacterReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of CharacterReplyServerPacket.ReplyCodeDataExists | CharacterReplyServerPacket.ReplyCodeDataFull | CharacterReplyServerPacket.ReplyCodeDataFull3 | CharacterReplyServerPacket.ReplyCodeDataNotApproved | CharacterReplyServerPacket.ReplyCodeDataOk | CharacterReplyServerPacket.ReplyCodeDataDeleted | CharacterReplyServerPacket.ReplyCodeDataDefault | None

class ReplyCodeDataExists[source]

Bases: object

Data associated with reply_code value CharacterReply.Exists

__init__()[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataExists.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataExists to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataExists[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataExists from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFull[source]

Bases: object

Data associated with reply_code value CharacterReply.Full

__init__()[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataFull.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataFull to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFull[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataFull from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFull3[source]

Bases: object

Data associated with reply_code value CharacterReply.Full3

__init__()[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataFull3.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataFull3 to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFull3[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataFull3 from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataNotApproved[source]

Bases: object

Data associated with reply_code value CharacterReply.NotApproved

__init__()[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataNotApproved.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataNotApproved to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataNotApproved[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataNotApproved from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataOk[source]

Bases: object

Data associated with reply_code value CharacterReply.Ok

__init__(*, characters)[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataOk.

Parameters:

characters (Iterable[CharacterSelectionListEntry]) – (Length must be 252 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property characters: tuple[CharacterSelectionListEntry, ...]

The characters field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataOk to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ReplyCodeDataOk) – The data to serialize.

static deserialize(reader) ReplyCodeDataOk[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataOk from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataDeleted[source]

Bases: object

Data associated with reply_code value CharacterReply.Deleted

__init__(*, characters)[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataDeleted.

Parameters:

characters (Iterable[CharacterSelectionListEntry]) – (Length must be 252 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property characters: tuple[CharacterSelectionListEntry, ...]

The characters field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataDeleted to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataDeleted[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataDeleted from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataDefault[source]

Bases: object

Default data associated with reply_code

In this case (reply_code > 9), reply_code is a session ID for character creation

__init__()[source]

Create a new instance of CharacterReplyServerPacket.ReplyCodeDataDefault.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of CharacterReplyServerPacket.ReplyCodeDataDefault to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataDefault[source]

Deserializes an instance of CharacterReplyServerPacket.ReplyCodeDataDefault from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterSecondaryStats[source]

Bases: object

The 5 secondary character stats

__init__(*, min_damage, max_damage, accuracy, evade, armor)[source]

Create a new instance of CharacterSecondaryStats.

Parameters:
  • min_damage (int) – (Value range is 0-64008.)

  • max_damage (int) – (Value range is 0-64008.)

  • accuracy (int) – (Value range is 0-64008.)

  • evade (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property min_damage: int

The min_damage field.

property max_damage: int

The max_damage field.

property accuracy: int

The accuracy field.

property evade: int

The evade field.

property armor: int

The armor field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterSecondaryStats to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterSecondaryStats[source]

Deserializes an instance of CharacterSecondaryStats from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterSecondaryStatsInfoLookup[source]

Bases: object

The 5 secondary character stats. Sent with character info lookups.

__init__(*, max_damage, min_damage, accuracy, evade, armor)[source]

Create a new instance of CharacterSecondaryStatsInfoLookup.

Parameters:
  • max_damage (int) – (Value range is 0-64008.)

  • min_damage (int) – (Value range is 0-64008.)

  • accuracy (int) – (Value range is 0-64008.)

  • evade (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property max_damage: int

The max_damage field.

property min_damage: int

The min_damage field.

property accuracy: int

The accuracy field.

property evade: int

The evade field.

property armor: int

The armor field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterSecondaryStatsInfoLookup to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterSecondaryStatsInfoLookup[source]

Deserializes an instance of CharacterSecondaryStatsInfoLookup from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterSelectionListEntry[source]

Bases: object

Character selection screen character

__init__(*, name, id, level, gender, hair_style, hair_color, skin, admin, equipment)[source]

Create a new instance of CharacterSelectionListEntry.

Parameters:
  • name (str)

  • id (int) – (Value range is 0-4097152080.)

  • level (int) – (Value range is 0-252.)

  • gender (Gender)

  • hair_style (int) – (Value range is 0-252.)

  • hair_color (int) – (Value range is 0-252.)

  • skin (int) – (Value range is 0-252.)

  • admin (AdminLevel)

  • equipment (EquipmentCharacterSelect)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property id: int

The id field.

property level: int

The level field.

property gender: Gender

The gender field.

property hair_style: int

The hair_style field.

property hair_color: int

The hair_color field.

property skin: int

The skin field.

property admin: AdminLevel

The admin field.

property equipment: EquipmentCharacterSelect

The equipment field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterSelectionListEntry to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterSelectionListEntry[source]

Deserializes an instance of CharacterSelectionListEntry from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterStatsEquipmentChange[source]

Bases: object

Character stats data. Sent when an item is equipped or unequipped.

__init__(*, max_hp, max_tp, base_stats, secondary_stats)[source]

Create a new instance of CharacterStatsEquipmentChange.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property max_hp: int

The max_hp field.

property max_tp: int

The max_tp field.

property base_stats: CharacterBaseStats

The base_stats field.

property secondary_stats: CharacterSecondaryStats

The secondary_stats field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterStatsEquipmentChange to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterStatsEquipmentChange[source]

Deserializes an instance of CharacterStatsEquipmentChange from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterStatsInfoLookup[source]

Bases: object

Character stats data. Sent with character info lookups.

__init__(*, hp, max_hp, tp, max_tp, base_stats, secondary_stats, elemental_stats)[source]

Create a new instance of CharacterStatsInfoLookup.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property hp: int

The hp field.

property max_hp: int

The max_hp field.

property tp: int

The tp field.

property max_tp: int

The max_tp field.

property base_stats: CharacterBaseStats

The base_stats field.

property secondary_stats: CharacterSecondaryStatsInfoLookup

The secondary_stats field.

property elemental_stats: CharacterElementalStats

The elemental_stats field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterStatsInfoLookup to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterStatsInfoLookup[source]

Deserializes an instance of CharacterStatsInfoLookup from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterStatsReset[source]

Bases: object

Character stats data. Sent when resetting stats and skills at a skill master NPC.

__init__(*, stat_points, skill_points, hp, max_hp, tp, max_tp, max_sp, base, secondary)[source]

Create a new instance of CharacterStatsReset.

Parameters:
  • stat_points (int) – (Value range is 0-64008.)

  • skill_points (int) – (Value range is 0-64008.)

  • hp (int) – (Value range is 0-64008.)

  • max_hp (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

  • max_sp (int) – (Value range is 0-64008.)

  • base (CharacterBaseStats)

  • secondary (CharacterSecondaryStats)

property byte_size: int

The size of the data that this was deserialized from.

property stat_points: int

The stat_points field.

property skill_points: int

The skill_points field.

property hp: int

The hp field.

property max_hp: int

The max_hp field.

property tp: int

The tp field.

property max_tp: int

The max_tp field.

property max_sp: int

The max_sp field.

property base: CharacterBaseStats

The base field.

property secondary: CharacterSecondaryStats

The secondary field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterStatsReset to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterStatsReset[source]

Deserializes an instance of CharacterStatsReset from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterStatsUpdate[source]

Bases: object

Character stats data. Sent when stats are updated.

__init__(*, base_stats, max_hp, max_tp, max_sp, max_weight, secondary_stats)[source]

Create a new instance of CharacterStatsUpdate.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property base_stats: CharacterBaseStats

The base_stats field.

property max_hp: int

The max_hp field.

property max_tp: int

The max_tp field.

property max_sp: int

The max_sp field.

property max_weight: int

The max_weight field.

property secondary_stats: CharacterSecondaryStats

The secondary_stats field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterStatsUpdate to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterStatsUpdate[source]

Deserializes an instance of CharacterStatsUpdate from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CharacterStatsWelcome[source]

Bases: object

Character stats data. Sent upon selecting a character and entering the game.

__init__(*, hp, max_hp, tp, max_tp, max_sp, stat_points, skill_points, karma, secondary, base)[source]

Create a new instance of CharacterStatsWelcome.

Parameters:
  • hp (int) – (Value range is 0-64008.)

  • max_hp (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

  • max_sp (int) – (Value range is 0-64008.)

  • stat_points (int) – (Value range is 0-64008.)

  • skill_points (int) – (Value range is 0-64008.)

  • karma (int) – (Value range is 0-64008.)

  • secondary (CharacterSecondaryStats)

  • base (CharacterBaseStatsWelcome)

property byte_size: int

The size of the data that this was deserialized from.

property hp: int

The hp field.

property max_hp: int

The max_hp field.

property tp: int

The tp field.

property max_tp: int

The max_tp field.

property max_sp: int

The max_sp field.

property stat_points: int

The stat_points field.

property skill_points: int

The skill_points field.

property karma: int

The karma field.

property secondary: CharacterSecondaryStats

The secondary field.

property base: CharacterBaseStatsWelcome

The base field.

static serialize(writer, data) None[source]

Serializes an instance of CharacterStatsWelcome to the provided EoWriter.

Parameters:
static deserialize(reader) CharacterStatsWelcome[source]

Deserializes an instance of CharacterStatsWelcome from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChestAgreeServerPacket[source]

Bases: Packet

Chest contents updating

__init__(*, items)[source]

Create a new instance of ChestAgreeServerPacket.

Parameters:

items (Iterable[ThreeItem])

property byte_size: int

The size of the data that this was deserialized from.

property items: tuple[ThreeItem, ...]

The items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChestAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChestAgreeServerPacket[source]

Deserializes an instance of ChestAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChestCloseServerPacket[source]

Bases: Packet

Reply to trying to interact with a locked or “broken” chest. The official client assumes a broken chest if the packet is under 2 bytes in length.

__init__(*, key=None)[source]

Create a new instance of ChestCloseServerPacket.

Parameters:

key (int | None, default: None) – Sent if the player is trying to interact with a locked chest (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property key: int | None

Sent if the player is trying to interact with a locked chest

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChestCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChestCloseServerPacket[source]

Deserializes an instance of ChestCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChestGetServerPacket[source]

Bases: Packet

Reply to removing an item from a chest

__init__(*, taken_item, weight, items)[source]

Create a new instance of ChestGetServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property taken_item: ThreeItem

The taken_item field.

property weight: Weight

The weight field.

property items: tuple[ThreeItem, ...]

The items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChestGetServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChestGetServerPacket[source]

Deserializes an instance of ChestGetServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChestOpenServerPacket[source]

Bases: Packet

Reply to opening a chest

__init__(*, coords, items)[source]

Create a new instance of ChestOpenServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property coords: Coords

The coords field.

property items: tuple[ThreeItem, ...]

The items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChestOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChestOpenServerPacket[source]

Deserializes an instance of ChestOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChestReplyServerPacket[source]

Bases: Packet

Reply to placing an item in to a chest

__init__(*, added_item_id, remaining_amount, weight, items)[source]

Create a new instance of ChestReplyServerPacket.

Parameters:
  • added_item_id (int) – (Value range is 0-64008.)

  • remaining_amount (int) – (Value range is 0-4097152080.)

  • weight (Weight)

  • items (Iterable[ThreeItem])

property byte_size: int

The size of the data that this was deserialized from.

property added_item_id: int

The added_item_id field.

property remaining_amount: int

The remaining_amount field.

property weight: Weight

The weight field.

property items: tuple[ThreeItem, ...]

The items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChestReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChestReplyServerPacket[source]

Deserializes an instance of ChestReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ChestSpecServerPacket[source]

Bases: Packet

Reply to trying to add an item to a full chest

__init__()[source]

Create a new instance of ChestSpecServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ChestSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ChestSpecServerPacket[source]

Deserializes an instance of ChestSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CitizenAcceptServerPacket[source]

Bases: Packet

Sleeping at an inn

__init__(*, gold_amount)[source]

Create a new instance of CitizenAcceptServerPacket.

Parameters:

gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CitizenAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CitizenAcceptServerPacket[source]

Deserializes an instance of CitizenAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CitizenOpenServerPacket[source]

Bases: Packet

Response from talking to a citizenship NPC

__init__(*, behavior_id, current_home_id, session_id, questions)[source]

Create a new instance of CitizenOpenServerPacket.

Parameters:
  • behavior_id (int) – (Value range is 0-16194276.)

  • current_home_id (int) – (Value range is 0-252.)

  • session_id (int) – (Value range is 0-64008.)

  • questions (Iterable[str]) – (Length must be 3.)

property byte_size: int

The size of the data that this was deserialized from.

property behavior_id: int

The behavior_id field.

property current_home_id: int

The current_home_id field.

property session_id: int

The session_id field.

property questions: tuple[str, ...]

The questions field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CitizenOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CitizenOpenServerPacket[source]

Deserializes an instance of CitizenOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CitizenRemoveServerPacket[source]

Bases: Packet

Response to giving up citizenship of a town

__init__(*, reply_code)[source]

Create a new instance of CitizenRemoveServerPacket.

Parameters:

reply_code (InnUnsubscribeReply)

property byte_size: int

The size of the data that this was deserialized from.

property reply_code: InnUnsubscribeReply

The reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CitizenRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CitizenRemoveServerPacket[source]

Deserializes an instance of CitizenRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CitizenReplyServerPacket[source]

Bases: Packet

Response to subscribing to a town

__init__(*, questions_wrong)[source]

Create a new instance of CitizenReplyServerPacket.

Parameters:

questions_wrong (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property questions_wrong: int

The questions_wrong field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CitizenReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CitizenReplyServerPacket[source]

Deserializes an instance of CitizenReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class CitizenRequestServerPacket[source]

Bases: Packet

Reply to requesting sleeping at an inn

__init__(*, cost)[source]

Create a new instance of CitizenRequestServerPacket.

Parameters:

cost (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property cost: int

The cost field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of CitizenRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) CitizenRequestServerPacket[source]

Deserializes an instance of CitizenRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ConnectionPlayerServerPacket[source]

Bases: Packet

Ping request

__init__(*, seq1, seq2)[source]

Create a new instance of ConnectionPlayerServerPacket.

Parameters:
  • seq1 (int) – (Value range is 0-64008.)

  • seq2 (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property seq1: int

The seq1 field.

property seq2: int

The seq2 field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ConnectionPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ConnectionPlayerServerPacket[source]

Deserializes an instance of ConnectionPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class DialogEntry[source]

Bases: object

An entry in a quest dialog

__init__(*, entry_type, entry_type_data=None, line)[source]

Create a new instance of DialogEntry.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property entry_type: DialogEntryType

The entry_type field.

property entry_type_data: EntryTypeDataLink | None

Data associated with the entry_type field.

property line: str

The line field.

static serialize(writer, data) None[source]

Serializes an instance of DialogEntry to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (DialogEntry) – The data to serialize.

static deserialize(reader) DialogEntry[source]

Deserializes an instance of DialogEntry from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

EntryTypeData

Data associated with different values of the entry_type field.

alias of DialogEntry.EntryTypeDataLink | None

Bases: object

Data associated with entry_type value DialogEntryType.Link

__init__(*, link_id)[source]

Create a new instance of DialogEntry.EntryTypeDataLink.

Parameters:

link_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

The link_id field.

static serialize(writer, data) None[source]

Serializes an instance of DialogEntry.EntryTypeDataLink to the provided EoWriter.

Parameters:
static deserialize(reader) EntryTypeDataLink[source]

Deserializes an instance of DialogEntry.EntryTypeDataLink from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class DialogEntryType[source]

Bases: IntEnum

The type of an entry in a quest dialog

Text = 1
class DialogQuestEntry[source]

Bases: object

An entry in the quest switcher

__init__(*, quest_id, quest_name)[source]

Create a new instance of DialogQuestEntry.

Parameters:
  • quest_id (int) – (Value range is 0-64008.)

  • quest_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property quest_id: int

The quest_id field.

property quest_name: str

The quest_name field.

static serialize(writer, data) None[source]

Serializes an instance of DialogQuestEntry to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (DialogQuestEntry) – The data to serialize.

static deserialize(reader) DialogQuestEntry[source]

Deserializes an instance of DialogQuestEntry from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class DoorCloseServerPacket[source]

Bases: Packet

Reply to trying to open a locked door

__init__(*, key)[source]

Create a new instance of DoorCloseServerPacket.

Parameters:

key (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property key: int

The key field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of DoorCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) DoorCloseServerPacket[source]

Deserializes an instance of DoorCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class DoorOpenServerPacket[source]

Bases: Packet

Nearby door opening

__init__(*, coords)[source]

Create a new instance of DoorOpenServerPacket.

Parameters:

coords (Coords) – The official server erroneously encodes the Y coordinate as a short. The official client reads each coordinate as a char.

property byte_size: int

The size of the data that this was deserialized from.

property coords: Coords

The official server erroneously encodes the Y coordinate as a short. The official client reads each coordinate as a char.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of DoorOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) DoorOpenServerPacket[source]

Deserializes an instance of DoorOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectAdminServerPacket[source]

Bases: Packet

Nearby character taking spike damage

__init__(*, player_id, hp_percentage, died, damage)[source]

Create a new instance of EffectAdminServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • hp_percentage (int) – (Value range is 0-252.)

  • died (bool)

  • damage (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property hp_percentage: int

The hp_percentage field.

property died: bool

The died field.

property damage: int

The damage field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectAdminServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectAdminServerPacket[source]

Deserializes an instance of EffectAdminServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectAgreeServerPacket[source]

Bases: Packet

Effects playing on nearby tiles

__init__(*, effects)[source]

Create a new instance of EffectAgreeServerPacket.

Parameters:

effects (Iterable[TileEffect])

property byte_size: int

The size of the data that this was deserialized from.

property effects: tuple[TileEffect, ...]

The effects field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectAgreeServerPacket[source]

Deserializes an instance of EffectAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectPlayerServerPacket[source]

Bases: Packet

Effects playing on nearby players

__init__(*, effects)[source]

Create a new instance of EffectPlayerServerPacket.

Parameters:

effects (Iterable[PlayerEffect])

property byte_size: int

The size of the data that this was deserialized from.

property effects: tuple[PlayerEffect, ...]

The effects field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectPlayerServerPacket[source]

Deserializes an instance of EffectPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectReportServerPacket[source]

Bases: Packet

Map spike timer

__init__()[source]

Create a new instance of EffectReportServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectReportServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectReportServerPacket[source]

Deserializes an instance of EffectReportServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectSpecServerPacket[source]

Bases: Packet

Taking spike or tp drain damage

__init__(*, map_damage_type, map_damage_type_data=None)[source]

Create a new instance of EffectSpecServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property map_damage_type: MapDamageType

The map_damage_type field.

property map_damage_type_data: MapDamageTypeDataTpDrain | MapDamageTypeDataSpikes | None

Data associated with the map_damage_type field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectSpecServerPacket[source]

Deserializes an instance of EffectSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

MapDamageTypeData

Data associated with different values of the map_damage_type field.

alias of EffectSpecServerPacket.MapDamageTypeDataTpDrain | EffectSpecServerPacket.MapDamageTypeDataSpikes | None

class MapDamageTypeDataTpDrain[source]

Bases: object

Data associated with map_damage_type value MapDamageType.TpDrain

__init__(*, tp_damage, tp, max_tp)[source]

Create a new instance of EffectSpecServerPacket.MapDamageTypeDataTpDrain.

Parameters:
  • tp_damage (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property tp_damage: int

The tp_damage field.

property tp: int

The tp field.

property max_tp: int

The max_tp field.

static serialize(writer, data) None[source]

Serializes an instance of EffectSpecServerPacket.MapDamageTypeDataTpDrain to the provided EoWriter.

Parameters:
static deserialize(reader) MapDamageTypeDataTpDrain[source]

Deserializes an instance of EffectSpecServerPacket.MapDamageTypeDataTpDrain from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MapDamageTypeDataSpikes[source]

Bases: object

Data associated with map_damage_type value MapDamageType.Spikes

__init__(*, hp_damage, hp, max_hp)[source]

Create a new instance of EffectSpecServerPacket.MapDamageTypeDataSpikes.

Parameters:
  • hp_damage (int) – (Value range is 0-64008.)

  • hp (int) – (Value range is 0-64008.)

  • max_hp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property hp_damage: int

The hp_damage field.

property hp: int

The hp field.

property max_hp: int

The max_hp field.

static serialize(writer, data) None[source]

Serializes an instance of EffectSpecServerPacket.MapDamageTypeDataSpikes to the provided EoWriter.

Parameters:
static deserialize(reader) MapDamageTypeDataSpikes[source]

Deserializes an instance of EffectSpecServerPacket.MapDamageTypeDataSpikes from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectTargetOtherServerPacket[source]

Bases: Packet

Map drain damage

__init__(*, damage, hp, max_hp, others)[source]

Create a new instance of EffectTargetOtherServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property damage: int

The damage field.

property hp: int

The hp field.

property max_hp: int

The max_hp field.

property others: tuple[MapDrainDamageOther, ...]

The others field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectTargetOtherServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectTargetOtherServerPacket[source]

Deserializes an instance of EffectTargetOtherServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EffectUseServerPacket[source]

Bases: Packet

Map effect

__init__(*, effect, effect_data=None)[source]

Create a new instance of EffectUseServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property effect: MapEffect

The effect field.

property effect_data: EffectDataQuake | None

Data associated with the effect field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EffectUseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EffectUseServerPacket[source]

Deserializes an instance of EffectUseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

EffectData

Data associated with different values of the effect field.

alias of EffectUseServerPacket.EffectDataQuake | None

class EffectDataQuake[source]

Bases: object

Data associated with effect value MapEffect.Quake

__init__(*, quake_strength)[source]

Create a new instance of EffectUseServerPacket.EffectDataQuake.

Parameters:

quake_strength (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property quake_strength: int

The quake_strength field.

static serialize(writer, data) None[source]

Serializes an instance of EffectUseServerPacket.EffectDataQuake to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (EffectDataQuake) – The data to serialize.

static deserialize(reader) EffectDataQuake[source]

Deserializes an instance of EffectUseServerPacket.EffectDataQuake from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EmotePlayerServerPacket[source]

Bases: Packet

Nearby player doing an emote

__init__(*, player_id, emote)[source]

Create a new instance of EmotePlayerServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • emote (Emote)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property emote: Emote

The emote field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of EmotePlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) EmotePlayerServerPacket[source]

Deserializes an instance of EmotePlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EquipmentChange[source]

Bases: object

Player equipment data. Sent when a player’s visible equipment changes. Note that these values are graphic IDs.

__init__(*, boots, armor, hat, weapon, shield)[source]

Create a new instance of EquipmentChange.

Parameters:
  • boots (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

  • hat (int) – (Value range is 0-64008.)

  • weapon (int) – (Value range is 0-64008.)

  • shield (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property boots: int

The boots field.

property armor: int

The armor field.

property hat: int

The hat field.

property weapon: int

The weapon field.

property shield: int

The shield field.

static serialize(writer, data) None[source]

Serializes an instance of EquipmentChange to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (EquipmentChange) – The data to serialize.

static deserialize(reader) EquipmentChange[source]

Deserializes an instance of EquipmentChange from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EquipmentCharacterSelect[source]

Bases: object

Player equipment data. Sent with a character in the character selection list. Note that these values are graphic IDs.

__init__(*, boots, armor, hat, shield, weapon)[source]

Create a new instance of EquipmentCharacterSelect.

Parameters:
  • boots (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

  • hat (int) – (Value range is 0-64008.)

  • shield (int) – (Value range is 0-64008.)

  • weapon (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property boots: int

The boots field.

property armor: int

The armor field.

property hat: int

The hat field.

property shield: int

The shield field.

property weapon: int

The weapon field.

static serialize(writer, data) None[source]

Serializes an instance of EquipmentCharacterSelect to the provided EoWriter.

Parameters:
static deserialize(reader) EquipmentCharacterSelect[source]

Deserializes an instance of EquipmentCharacterSelect from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EquipmentMapInfo[source]

Bases: object

Player equipment data. Sent with map information about a nearby character. Note that these values are graphic IDs.

__init__(*, boots, armor, hat, shield, weapon)[source]

Create a new instance of EquipmentMapInfo.

Parameters:
  • boots (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

  • hat (int) – (Value range is 0-64008.)

  • shield (int) – (Value range is 0-64008.)

  • weapon (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property boots: int

The boots field.

property armor: int

The armor field.

property hat: int

The hat field.

property shield: int

The shield field.

property weapon: int

The weapon field.

static serialize(writer, data) None[source]

Serializes an instance of EquipmentMapInfo to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (EquipmentMapInfo) – The data to serialize.

static deserialize(reader) EquipmentMapInfo[source]

Deserializes an instance of EquipmentMapInfo from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EquipmentPaperdoll[source]

Bases: object

Player equipment data. Sent with information about a player’s paperdoll. Note that these values are item IDs.

__init__(*, boots, accessory, gloves, belt, armor, necklace, hat, shield, weapon, ring, armlet, bracer)[source]

Create a new instance of EquipmentPaperdoll.

Parameters:
  • boots (int) – (Value range is 0-64008.)

  • accessory (int) – (Value range is 0-64008.)

  • gloves (int) – (Value range is 0-64008.)

  • belt (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

  • necklace (int) – (Value range is 0-64008.)

  • hat (int) – (Value range is 0-64008.)

  • shield (int) – (Value range is 0-64008.)

  • weapon (int) – (Value range is 0-64008.)

  • ring (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • armlet (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • bracer (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property boots: int

The boots field.

property accessory: int

The accessory field.

property gloves: int

The gloves field.

property belt: int

The belt field.

property armor: int

The armor field.

property necklace: int

The necklace field.

property hat: int

The hat field.

property shield: int

The shield field.

property weapon: int

The weapon field.

property ring: tuple[int, ...]

The ring field.

property armlet: tuple[int, ...]

The armlet field.

property bracer: tuple[int, ...]

The bracer field.

static serialize(writer, data) None[source]

Serializes an instance of EquipmentPaperdoll to the provided EoWriter.

Parameters:
static deserialize(reader) EquipmentPaperdoll[source]

Deserializes an instance of EquipmentPaperdoll from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class EquipmentWelcome[source]

Bases: object

Player equipment data. Sent upon selecting a character and entering the game. Note that these values are item IDs.

__init__(*, boots, gloves, accessory, armor, belt, necklace, hat, shield, weapon, ring, armlet, bracer)[source]

Create a new instance of EquipmentWelcome.

Parameters:
  • boots (int) – (Value range is 0-64008.)

  • gloves (int) – (Value range is 0-64008.)

  • accessory (int) – (Value range is 0-64008.)

  • armor (int) – (Value range is 0-64008.)

  • belt (int) – (Value range is 0-64008.)

  • necklace (int) – (Value range is 0-64008.)

  • hat (int) – (Value range is 0-64008.)

  • shield (int) – (Value range is 0-64008.)

  • weapon (int) – (Value range is 0-64008.)

  • ring (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • armlet (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • bracer (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property boots: int

The boots field.

property gloves: int

The gloves field.

property accessory: int

The accessory field.

property armor: int

The armor field.

property belt: int

The belt field.

property necklace: int

The necklace field.

property hat: int

The hat field.

property shield: int

The shield field.

property weapon: int

The weapon field.

property ring: tuple[int, ...]

The ring field.

property armlet: tuple[int, ...]

The armlet field.

property bracer: tuple[int, ...]

The bracer field.

static serialize(writer, data) None[source]

Serializes an instance of EquipmentWelcome to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (EquipmentWelcome) – The data to serialize.

static deserialize(reader) EquipmentWelcome[source]

Deserializes an instance of EquipmentWelcome from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class FacePlayerServerPacket[source]

Bases: Packet

Nearby player facing a direction

__init__(*, player_id, direction)[source]

Create a new instance of FacePlayerServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • direction (Direction)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of FacePlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) FacePlayerServerPacket[source]

Deserializes an instance of FacePlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GlobalBackfillMessage[source]

Bases: object

A backfilled global chat message

__init__(*, player_name, message)[source]

Create a new instance of GlobalBackfillMessage.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static serialize(writer, data) None[source]

Serializes an instance of GlobalBackfillMessage to the provided EoWriter.

Parameters:
static deserialize(reader) GlobalBackfillMessage[source]

Deserializes an instance of GlobalBackfillMessage from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GroupHealTargetPlayer[source]

Bases: object

Nearby player hit by a group heal spell

__init__(*, player_id, hp_percentage, hp)[source]

Create a new instance of GroupHealTargetPlayer.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • hp_percentage (int) – (Value range is 0-252.)

  • hp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property hp_percentage: int

The hp_percentage field.

property hp: int

The hp field.

static serialize(writer, data) None[source]

Serializes an instance of GroupHealTargetPlayer to the provided EoWriter.

Parameters:
static deserialize(reader) GroupHealTargetPlayer[source]

Deserializes an instance of GroupHealTargetPlayer from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildAcceptServerPacket[source]

Bases: Packet

Update guild rank

__init__(*, rank)[source]

Create a new instance of GuildAcceptServerPacket.

Parameters:

rank (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property rank: int

The rank field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildAcceptServerPacket[source]

Deserializes an instance of GuildAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildAgreeServerPacket[source]

Bases: Packet

Joined guild info

__init__(*, recruiter_id, guild_tag, guild_name, rank_name)[source]

Create a new instance of GuildAgreeServerPacket.

Parameters:
  • recruiter_id (int) – (Value range is 0-64008.)

  • guild_tag (str)

  • guild_name (str)

  • rank_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property recruiter_id: int

The recruiter_id field.

property guild_tag: str

The guild_tag field.

property guild_name: str

The guild_name field.

property rank_name: str

The rank_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildAgreeServerPacket[source]

Deserializes an instance of GuildAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildBuyServerPacket[source]

Bases: Packet

Deposit guild bank reply

__init__(*, gold_amount)[source]

Create a new instance of GuildBuyServerPacket.

Parameters:

gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildBuyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildBuyServerPacket[source]

Deserializes an instance of GuildBuyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildCreateServerPacket[source]

Bases: Packet

Guild created

__init__(*, leader_player_id, guild_tag, guild_name, rank_name, gold_amount)[source]

Create a new instance of GuildCreateServerPacket.

Parameters:
  • leader_player_id (int) – (Value range is 0-64008.)

  • guild_tag (str)

  • guild_name (str)

  • rank_name (str)

  • gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property leader_player_id: int

The leader_player_id field.

property guild_tag: str

The guild_tag field.

property guild_name: str

The guild_name field.

property rank_name: str

The rank_name field.

property gold_amount: int

The gold_amount field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildCreateServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildCreateServerPacket[source]

Deserializes an instance of GuildCreateServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildKickServerPacket[source]

Bases: Packet

Left the guild

__init__()[source]

Create a new instance of GuildKickServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildKickServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildKickServerPacket[source]

Deserializes an instance of GuildKickServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildMember[source]

Bases: object

Information about a guild member

__init__(*, rank, name, rank_name)[source]

Create a new instance of GuildMember.

Parameters:
  • rank (int) – (Value range is 0-252.)

  • name (str)

  • rank_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property rank: int

The rank field.

property name: str

The name field.

property rank_name: str

The rank_name field.

static serialize(writer, data) None[source]

Serializes an instance of GuildMember to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (GuildMember) – The data to serialize.

static deserialize(reader) GuildMember[source]

Deserializes an instance of GuildMember from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildOpenServerPacket[source]

Bases: Packet

Talk to guild master NPC reply

__init__(*, session_id)[source]

Create a new instance of GuildOpenServerPacket.

Parameters:

session_id (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildOpenServerPacket[source]

Deserializes an instance of GuildOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildRankServerPacket[source]

Bases: Packet

Get guild rank list reply

__init__(*, ranks)[source]

Create a new instance of GuildRankServerPacket.

Parameters:

ranks (Iterable[str]) – (Length must be 9.)

property byte_size: int

The size of the data that this was deserialized from.

property ranks: tuple[str, ...]

The ranks field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildRankServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildRankServerPacket[source]

Deserializes an instance of GuildRankServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildReply[source]

Bases: IntEnum

Reply code sent with GUILD_REPLY packet

Busy = 1
NotApproved = 2
AlreadyMember = 3
NoCandidates = 4
Exists = 5
CreateBegin = 6
CreateAddConfirm = 7
CreateAdd = 8
RecruiterOffline = 9
RecruiterNotHere = 10
RecruiterWrongGuild = 11
NotRecruiter = 12
JoinRequest = 13
NotPresent = 14
AccountLow = 15
Accepted = 16
NotFound = 17
Updated = 18
RanksUpdated = 19
RemoveLeader = 20
RemoveNotMember = 21
Removed = 22
RankingLeader = 23
RankingNotMember = 24
class GuildReplyServerPacket[source]

Bases: Packet

Generic guild reply messages

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of GuildReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: GuildReply

The reply_code field.

property reply_code_data: ReplyCodeDataCreateAdd | ReplyCodeDataCreateAddConfirm | ReplyCodeDataJoinRequest | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildReplyServerPacket[source]

Deserializes an instance of GuildReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of GuildReplyServerPacket.ReplyCodeDataCreateAdd | GuildReplyServerPacket.ReplyCodeDataCreateAddConfirm | GuildReplyServerPacket.ReplyCodeDataJoinRequest | None

class ReplyCodeDataCreateAdd[source]

Bases: object

Data associated with reply_code value GuildReply.CreateAdd

__init__(*, name)[source]

Create a new instance of GuildReplyServerPacket.ReplyCodeDataCreateAdd.

Parameters:

name (str)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

static serialize(writer, data) None[source]

Serializes an instance of GuildReplyServerPacket.ReplyCodeDataCreateAdd to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataCreateAdd[source]

Deserializes an instance of GuildReplyServerPacket.ReplyCodeDataCreateAdd from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataCreateAddConfirm[source]

Bases: object

Data associated with reply_code value GuildReply.CreateAddConfirm

__init__(*, name)[source]

Create a new instance of GuildReplyServerPacket.ReplyCodeDataCreateAddConfirm.

Parameters:

name (str)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

static serialize(writer, data) None[source]

Serializes an instance of GuildReplyServerPacket.ReplyCodeDataCreateAddConfirm to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataCreateAddConfirm[source]

Deserializes an instance of GuildReplyServerPacket.ReplyCodeDataCreateAddConfirm from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataJoinRequest[source]

Bases: object

Data associated with reply_code value GuildReply.JoinRequest

__init__(*, player_id, name)[source]

Create a new instance of GuildReplyServerPacket.ReplyCodeDataJoinRequest.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • name (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property name: str

The name field.

static serialize(writer, data) None[source]

Serializes an instance of GuildReplyServerPacket.ReplyCodeDataJoinRequest to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataJoinRequest[source]

Deserializes an instance of GuildReplyServerPacket.ReplyCodeDataJoinRequest from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildReportServerPacket[source]

Bases: Packet

Get guild info reply

__init__(*, name, tag, create_date, description, wealth, ranks, staff)[source]

Create a new instance of GuildReportServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property tag: str

The tag field.

property create_date: str

The create_date field.

property description: str

The description field.

property wealth: str

The wealth field.

property ranks: tuple[str, ...]

The ranks field.

property staff: tuple[GuildStaff, ...]

The staff field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildReportServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildReportServerPacket[source]

Deserializes an instance of GuildReportServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildRequestServerPacket[source]

Bases: Packet

Guild create request

__init__(*, player_id, guild_identity)[source]

Create a new instance of GuildRequestServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • guild_identity (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property guild_identity: str

The guild_identity field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildRequestServerPacket[source]

Deserializes an instance of GuildRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildSellServerPacket[source]

Bases: Packet

Get guild bank reply

__init__(*, gold_amount)[source]

Create a new instance of GuildSellServerPacket.

Parameters:

gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildSellServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildSellServerPacket[source]

Deserializes an instance of GuildSellServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildStaff[source]

Bases: object

Information about a guild staff member (recruiter or leader)

__init__(*, rank, name)[source]

Create a new instance of GuildStaff.

Parameters:
  • rank (int) – (Value range is 0-252.)

  • name (str)

property byte_size: int

The size of the data that this was deserialized from.

property rank: int

The rank field.

property name: str

The name field.

static serialize(writer, data) None[source]

Serializes an instance of GuildStaff to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (GuildStaff) – The data to serialize.

static deserialize(reader) GuildStaff[source]

Deserializes an instance of GuildStaff from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildTakeServerPacket[source]

Bases: Packet

Get guild description reply

__init__(*, description)[source]

Create a new instance of GuildTakeServerPacket.

Parameters:

description (str)

property byte_size: int

The size of the data that this was deserialized from.

property description: str

The description field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildTakeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildTakeServerPacket[source]

Deserializes an instance of GuildTakeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class GuildTellServerPacket[source]

Bases: Packet

Get guild member list reply

__init__(*, members)[source]

Create a new instance of GuildTellServerPacket.

Parameters:

members (Iterable[GuildMember]) – (Length must be 64008 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property members: tuple[GuildMember, ...]

The members field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of GuildTellServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) GuildTellServerPacket[source]

Deserializes an instance of GuildTellServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class InitBanType[source]

Bases: IntEnum

Ban type sent with INIT_INIT packet. The official client treats a value >= 2 as Permanent. Otherwise, it’s Temporary.

Temporary = 1
Permanent = 2
class InitInitServerPacket[source]

Bases: Packet

Reply to connection initialization and requests for unencrypted data. This packet is unencrypted.

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of InitInitServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: InitReply

The reply_code field.

property reply_code_data: ReplyCodeDataOutOfDate | ReplyCodeDataOk | ReplyCodeDataBanned | ReplyCodeDataWarpMap | ReplyCodeDataFileEmf | ReplyCodeDataFileEif | ReplyCodeDataFileEnf | ReplyCodeDataFileEsf | ReplyCodeDataFileEcf | ReplyCodeDataMapMutation | ReplyCodeDataPlayersList | ReplyCodeDataPlayersListFriends | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) InitInitServerPacket[source]

Deserializes an instance of InitInitServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of InitInitServerPacket.ReplyCodeDataOutOfDate | InitInitServerPacket.ReplyCodeDataOk | InitInitServerPacket.ReplyCodeDataBanned | InitInitServerPacket.ReplyCodeDataWarpMap | InitInitServerPacket.ReplyCodeDataFileEmf | InitInitServerPacket.ReplyCodeDataFileEif | InitInitServerPacket.ReplyCodeDataFileEnf | InitInitServerPacket.ReplyCodeDataFileEsf | InitInitServerPacket.ReplyCodeDataFileEcf | InitInitServerPacket.ReplyCodeDataMapMutation | InitInitServerPacket.ReplyCodeDataPlayersList | InitInitServerPacket.ReplyCodeDataPlayersListFriends | None

class ReplyCodeDataOutOfDate[source]

Bases: object

Data associated with reply_code value InitReply.OutOfDate

__init__(*, version)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataOutOfDate.

Parameters:

version (Version)

property byte_size: int

The size of the data that this was deserialized from.

property version: Version

The version field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataOutOfDate to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataOutOfDate[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataOutOfDate from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataOk[source]

Bases: object

Data associated with reply_code value InitReply.Ok

__init__(*, seq1, seq2, server_encryption_multiple, client_encryption_multiple, player_id, challenge_response)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataOk.

Parameters:
  • seq1 (int) – (Value range is 0-255.)

  • seq2 (int) – (Value range is 0-255.)

  • server_encryption_multiple (int) – (Value range is 0-255.)

  • client_encryption_multiple (int) – (Value range is 0-255.)

  • player_id (int) – (Value range is 0-64008.)

  • challenge_response (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property seq1: int

The seq1 field.

property seq2: int

The seq2 field.

property server_encryption_multiple: int

The server_encryption_multiple field.

property client_encryption_multiple: int

The client_encryption_multiple field.

property player_id: int

The player_id field.

property challenge_response: int

The challenge_response field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataOk to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ReplyCodeDataOk) – The data to serialize.

static deserialize(reader) ReplyCodeDataOk[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataOk from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataBanned[source]

Bases: object

Data associated with reply_code value InitReply.Banned

__init__(*, ban_type, ban_type_data=None)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataBanned.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property ban_type: InitBanType

The ban_type field.

property ban_type_data: BanTypeData0 | BanTypeDataTemporary | None

Data associated with the ban_type field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataBanned to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataBanned[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataBanned from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

BanTypeData

Data associated with different values of the ban_type field.

alias of InitInitServerPacket.ReplyCodeDataBanned.BanTypeData0 | InitInitServerPacket.ReplyCodeDataBanned.BanTypeDataTemporary | None

class BanTypeData0[source]

Bases: object

Data associated with ban_type value 0

The official client treats any value below 2 as a temporary ban. The official server sends 1, but some game server implementations erroneously send 0.

__init__(*, minutes_remaining)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataBanned.BanTypeData0.

Parameters:

minutes_remaining (int) – (Value range is 0-255.)

property byte_size: int

The size of the data that this was deserialized from.

property minutes_remaining: int

The minutes_remaining field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataBanned.BanTypeData0 to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (BanTypeData0) – The data to serialize.

static deserialize(reader) BanTypeData0[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataBanned.BanTypeData0 from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class BanTypeDataTemporary[source]

Bases: object

Data associated with ban_type value InitBanType.Temporary

__init__(*, minutes_remaining)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataBanned.BanTypeDataTemporary.

Parameters:

minutes_remaining (int) – (Value range is 0-255.)

property byte_size: int

The size of the data that this was deserialized from.

property minutes_remaining: int

The minutes_remaining field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataBanned.BanTypeDataTemporary to the provided EoWriter.

Parameters:
static deserialize(reader) BanTypeDataTemporary[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataBanned.BanTypeDataTemporary from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataWarpMap[source]

Bases: object

Data associated with reply_code value InitReply.WarpMap

__init__(*, map_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataWarpMap.

Parameters:

map_file (MapFile)

property byte_size: int

The size of the data that this was deserialized from.

property map_file: MapFile

The map_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataWarpMap to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataWarpMap[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataWarpMap from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFileEmf[source]

Bases: object

Data associated with reply_code value InitReply.FileEmf

__init__(*, map_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataFileEmf.

Parameters:

map_file (MapFile)

property byte_size: int

The size of the data that this was deserialized from.

property map_file: MapFile

The map_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataFileEmf to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFileEmf[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataFileEmf from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFileEif[source]

Bases: object

Data associated with reply_code value InitReply.FileEif

__init__(*, pub_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataFileEif.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataFileEif to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFileEif[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataFileEif from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFileEnf[source]

Bases: object

Data associated with reply_code value InitReply.FileEnf

__init__(*, pub_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataFileEnf.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataFileEnf to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFileEnf[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataFileEnf from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFileEsf[source]

Bases: object

Data associated with reply_code value InitReply.FileEsf

__init__(*, pub_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataFileEsf.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataFileEsf to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFileEsf[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataFileEsf from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataFileEcf[source]

Bases: object

Data associated with reply_code value InitReply.FileEcf

__init__(*, pub_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataFileEcf.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataFileEcf to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataFileEcf[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataFileEcf from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataMapMutation[source]

Bases: object

Data associated with reply_code value InitReply.MapMutation

__init__(*, map_file)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataMapMutation.

Parameters:

map_file (MapFile)

property byte_size: int

The size of the data that this was deserialized from.

property map_file: MapFile

The map_file field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataMapMutation to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataMapMutation[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataMapMutation from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataPlayersList[source]

Bases: object

Data associated with reply_code value InitReply.PlayersList

__init__(*, players_list)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataPlayersList.

Parameters:

players_list (PlayersList)

property byte_size: int

The size of the data that this was deserialized from.

property players_list: PlayersList

The players_list field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataPlayersList to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataPlayersList[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataPlayersList from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataPlayersListFriends[source]

Bases: object

Data associated with reply_code value InitReply.PlayersListFriends

__init__(*, players_list)[source]

Create a new instance of InitInitServerPacket.ReplyCodeDataPlayersListFriends.

Parameters:

players_list (PlayersListFriends)

property byte_size: int

The size of the data that this was deserialized from.

property players_list: PlayersListFriends

The players_list field.

static serialize(writer, data) None[source]

Serializes an instance of InitInitServerPacket.ReplyCodeDataPlayersListFriends to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataPlayersListFriends[source]

Deserializes an instance of InitInitServerPacket.ReplyCodeDataPlayersListFriends from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class InitReply[source]

Bases: IntEnum

Reply code sent with INIT_INIT packet

OutOfDate = 1
Ok = 2
Banned = 3

The official client won’t display a message until the connection from the server is closed

WarpMap = 4
FileEmf = 5
FileEif = 6
FileEnf = 7
FileEsf = 8
PlayersList = 9
MapMutation = 10
PlayersListFriends = 11
FileEcf = 12
class InnUnsubscribeReply[source]

Bases: IntEnum

Reply code sent with CITIZEN_REMOVE packet. Indicates the result of trying to give up citizenship to a town.

NotCitizen = 0
Unsubscribed = 1
class ItemAcceptServerPacket[source]

Bases: Packet

Nearby player leveled up from quest

__init__(*, player_id)[source]

Create a new instance of ItemAcceptServerPacket.

Parameters:

player_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemAcceptServerPacket[source]

Deserializes an instance of ItemAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemAddServerPacket[source]

Bases: Packet

Item appeared on the ground

__init__(*, item_id, item_index, item_amount, coords)[source]

Create a new instance of ItemAddServerPacket.

Parameters:
  • item_id (int) – (Value range is 0-64008.)

  • item_index (int) – (Value range is 0-64008.)

  • item_amount (int) – (Value range is 0-16194276.)

  • coords (Coords)

property byte_size: int

The size of the data that this was deserialized from.

property item_id: int

The item_id field.

property item_index: int

The item_index field.

property item_amount: int

The item_amount field.

property coords: Coords

The coords field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemAddServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemAddServerPacket[source]

Deserializes an instance of ItemAddServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemAgreeServerPacket[source]

Bases: Packet

Reply to using an item that you don’t have

__init__(*, item_id)[source]

Create a new instance of ItemAgreeServerPacket.

Parameters:

item_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property item_id: int

The item_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemAgreeServerPacket[source]

Deserializes an instance of ItemAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemDropServerPacket[source]

Bases: Packet

Reply to dropping items on the ground

__init__(*, dropped_item, remaining_amount, item_index, coords, weight)[source]

Create a new instance of ItemDropServerPacket.

Parameters:
  • dropped_item (ThreeItem)

  • remaining_amount (int) – (Value range is 0-4097152080.)

  • item_index (int) – (Value range is 0-64008.)

  • coords (Coords)

  • weight (Weight)

property byte_size: int

The size of the data that this was deserialized from.

property dropped_item: ThreeItem

The dropped_item field.

property remaining_amount: int

The remaining_amount field.

property item_index: int

The item_index field.

property coords: Coords

The coords field.

property weight: Weight

The weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemDropServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemDropServerPacket[source]

Deserializes an instance of ItemDropServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemGetServerPacket[source]

Bases: Packet

Reply to taking items from the ground

__init__(*, taken_item_index, taken_item, weight)[source]

Create a new instance of ItemGetServerPacket.

Parameters:
  • taken_item_index (int) – (Value range is 0-64008.)

  • taken_item (ThreeItem)

  • weight (Weight)

property byte_size: int

The size of the data that this was deserialized from.

property taken_item_index: int

The taken_item_index field.

property taken_item: ThreeItem

The taken_item field.

property weight: Weight

The weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemGetServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemGetServerPacket[source]

Deserializes an instance of ItemGetServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemJunkServerPacket[source]

Bases: Packet

Reply to junking items

__init__(*, junked_item, remaining_amount, weight)[source]

Create a new instance of ItemJunkServerPacket.

Parameters:
  • junked_item (ThreeItem)

  • remaining_amount (int) – (Value range is 0-4097152080.)

  • weight (Weight)

property byte_size: int

The size of the data that this was deserialized from.

property junked_item: ThreeItem

The junked_item field.

property remaining_amount: int

The remaining_amount field.

property weight: Weight

The weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemJunkServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemJunkServerPacket[source]

Deserializes an instance of ItemJunkServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemKickServerPacket[source]

Bases: Packet

Lose item (from quest)

__init__(*, item, current_weight)[source]

Create a new instance of ItemKickServerPacket.

Parameters:
  • item (Item)

  • current_weight (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property item: Item

The item field.

property current_weight: int

The current_weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemKickServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemKickServerPacket[source]

Deserializes an instance of ItemKickServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemMapInfo[source]

Bases: object

Information about a nearby item on the ground

__init__(*, uid, id, coords, amount)[source]

Create a new instance of ItemMapInfo.

Parameters:
  • uid (int) – (Value range is 0-64008.)

  • id (int) – (Value range is 0-64008.)

  • coords (Coords)

  • amount (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property uid: int

The uid field.

property id: int

The id field.

property coords: Coords

The coords field.

property amount: int

The amount field.

static serialize(writer, data) None[source]

Serializes an instance of ItemMapInfo to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ItemMapInfo) – The data to serialize.

static deserialize(reader) ItemMapInfo[source]

Deserializes an instance of ItemMapInfo from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemObtainServerPacket[source]

Bases: Packet

Receive item (from quest)

__init__(*, item, current_weight)[source]

Create a new instance of ItemObtainServerPacket.

Parameters:
  • item (ThreeItem)

  • current_weight (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property item: ThreeItem

The item field.

property current_weight: int

The current_weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemObtainServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemObtainServerPacket[source]

Deserializes an instance of ItemObtainServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemRemoveServerPacket[source]

Bases: Packet

Item disappeared from the ground

__init__(*, item_index)[source]

Create a new instance of ItemRemoveServerPacket.

Parameters:

item_index (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property item_index: int

The item_index field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemRemoveServerPacket[source]

Deserializes an instance of ItemRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemReplyServerPacket[source]

Bases: Packet

Reply to using an item

__init__(*, item_type, used_item, weight, item_type_data=None)[source]

Create a new instance of ItemReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property item_type: ItemType

The item_type field.

property used_item: Item

The used_item field.

property weight: Weight

The weight field.

property item_type_data: ItemTypeDataHeal | ItemTypeDataHairDye | ItemTypeDataEffectPotion | ItemTypeDataCureCurse | ItemTypeDataExpReward | None

Data associated with the item_type field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemReplyServerPacket[source]

Deserializes an instance of ItemReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ItemTypeData

Data associated with different values of the item_type field.

alias of ItemReplyServerPacket.ItemTypeDataHeal | ItemReplyServerPacket.ItemTypeDataHairDye | ItemReplyServerPacket.ItemTypeDataEffectPotion | ItemReplyServerPacket.ItemTypeDataCureCurse | ItemReplyServerPacket.ItemTypeDataExpReward | None

class ItemTypeDataHeal[source]

Bases: object

Data associated with item_type value ItemType.Heal

__init__(*, hp_gain, hp, tp)[source]

Create a new instance of ItemReplyServerPacket.ItemTypeDataHeal.

Parameters:
  • hp_gain (int) – (Value range is 0-4097152080.)

  • hp (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property hp_gain: int

The hp_gain field.

property hp: int

The hp field.

property tp: int

The tp field.

static serialize(writer, data) None[source]

Serializes an instance of ItemReplyServerPacket.ItemTypeDataHeal to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ItemTypeDataHeal) – The data to serialize.

static deserialize(reader) ItemTypeDataHeal[source]

Deserializes an instance of ItemReplyServerPacket.ItemTypeDataHeal from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemTypeDataHairDye[source]

Bases: object

Data associated with item_type value ItemType.HairDye

__init__(*, hair_color)[source]

Create a new instance of ItemReplyServerPacket.ItemTypeDataHairDye.

Parameters:

hair_color (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property hair_color: int

The hair_color field.

static serialize(writer, data) None[source]

Serializes an instance of ItemReplyServerPacket.ItemTypeDataHairDye to the provided EoWriter.

Parameters:
static deserialize(reader) ItemTypeDataHairDye[source]

Deserializes an instance of ItemReplyServerPacket.ItemTypeDataHairDye from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemTypeDataEffectPotion[source]

Bases: object

Data associated with item_type value ItemType.EffectPotion

__init__(*, effect_id)[source]

Create a new instance of ItemReplyServerPacket.ItemTypeDataEffectPotion.

Parameters:

effect_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property effect_id: int

The effect_id field.

static serialize(writer, data) None[source]

Serializes an instance of ItemReplyServerPacket.ItemTypeDataEffectPotion to the provided EoWriter.

Parameters:
static deserialize(reader) ItemTypeDataEffectPotion[source]

Deserializes an instance of ItemReplyServerPacket.ItemTypeDataEffectPotion from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemTypeDataCureCurse[source]

Bases: object

Data associated with item_type value ItemType.CureCurse

__init__(*, stats)[source]

Create a new instance of ItemReplyServerPacket.ItemTypeDataCureCurse.

Parameters:

stats (CharacterStatsEquipmentChange)

property byte_size: int

The size of the data that this was deserialized from.

property stats: CharacterStatsEquipmentChange

The stats field.

static serialize(writer, data) None[source]

Serializes an instance of ItemReplyServerPacket.ItemTypeDataCureCurse to the provided EoWriter.

Parameters:
static deserialize(reader) ItemTypeDataCureCurse[source]

Deserializes an instance of ItemReplyServerPacket.ItemTypeDataCureCurse from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemTypeDataExpReward[source]

Bases: object

Data associated with item_type value ItemType.ExpReward

__init__(*, experience, level_up, stat_points, skill_points, max_hp, max_tp, max_sp)[source]

Create a new instance of ItemReplyServerPacket.ItemTypeDataExpReward.

Parameters:
  • experience (int) – (Value range is 0-4097152080.)

  • level_up (int) – A value greater than 0 is “new level” and indicates the player leveled up. (Value range is 0-252.)

  • stat_points (int) – (Value range is 0-64008.)

  • skill_points (int) – (Value range is 0-64008.)

  • max_hp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

  • max_sp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property experience: int

The experience field.

property level_up: int

A value greater than 0 is “new level” and indicates the player leveled up.

property stat_points: int

The stat_points field.

property skill_points: int

The skill_points field.

property max_hp: int

The max_hp field.

property max_tp: int

The max_tp field.

property max_sp: int

The max_sp field.

static serialize(writer, data) None[source]

Serializes an instance of ItemReplyServerPacket.ItemTypeDataExpReward to the provided EoWriter.

Parameters:
static deserialize(reader) ItemTypeDataExpReward[source]

Deserializes an instance of ItemReplyServerPacket.ItemTypeDataExpReward from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ItemSpecServerPacket[source]

Bases: Packet

Reply to trying to take a protected item from the ground

__init__()[source]

Create a new instance of ItemSpecServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ItemSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ItemSpecServerPacket[source]

Deserializes an instance of ItemSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class JukeboxAgreeServerPacket[source]

Bases: Packet

Reply to successfully requesting a song

__init__(*, gold_amount)[source]

Create a new instance of JukeboxAgreeServerPacket.

Parameters:

gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of JukeboxAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) JukeboxAgreeServerPacket[source]

Deserializes an instance of JukeboxAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class JukeboxMsgServerPacket[source]

Bases: Packet

Someone playing a note with the bard skill nearby

__init__(*, player_id, direction, instrument_id, note_id)[source]

Create a new instance of JukeboxMsgServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • direction (Direction)

  • instrument_id (int) – (Value range is 0-252.)

  • note_id (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property direction: Direction

The direction field.

property instrument_id: int

The instrument_id field.

property note_id: int

The note_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of JukeboxMsgServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) JukeboxMsgServerPacket[source]

Deserializes an instance of JukeboxMsgServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class JukeboxOpenServerPacket[source]

Bases: Packet

Reply to opening the jukebox listing

__init__(*, map_id, jukebox_player)[source]

Create a new instance of JukeboxOpenServerPacket.

Parameters:
  • map_id (int) – (Value range is 0-64008.)

  • jukebox_player (str)

property byte_size: int

The size of the data that this was deserialized from.

property map_id: int

The map_id field.

property jukebox_player: str

The jukebox_player field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of JukeboxOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) JukeboxOpenServerPacket[source]

Deserializes an instance of JukeboxOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class JukeboxPlayerServerPacket[source]

Bases: Packet

Play background music

__init__(*, mfx_id)[source]

Create a new instance of JukeboxPlayerServerPacket.

Parameters:

mfx_id (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property mfx_id: int

The mfx_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of JukeboxPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) JukeboxPlayerServerPacket[source]

Deserializes an instance of JukeboxPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class JukeboxReplyServerPacket[source]

Bases: Packet

Reply to unsuccessfully requesting a song

__init__()[source]

Create a new instance of JukeboxReplyServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of JukeboxReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) JukeboxReplyServerPacket[source]

Deserializes an instance of JukeboxReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class JukeboxUseServerPacket[source]

Bases: Packet

Play jukebox music

__init__(*, track_id)[source]

Create a new instance of JukeboxUseServerPacket.

Parameters:

track_id (int) – This value is 1-indexed (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property track_id: int

This value is 1-indexed

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of JukeboxUseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) JukeboxUseServerPacket[source]

Deserializes an instance of JukeboxUseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LevelUpStats[source]

Bases: object

Level and stat updates

__init__(*, level, stat_points, skill_points, max_hp, max_tp, max_sp)[source]

Create a new instance of LevelUpStats.

Parameters:
  • level (int) – (Value range is 0-252.)

  • stat_points (int) – (Value range is 0-64008.)

  • skill_points (int) – (Value range is 0-64008.)

  • max_hp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

  • max_sp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property level: int

The level field.

property stat_points: int

The stat_points field.

property skill_points: int

The skill_points field.

property max_hp: int

The max_hp field.

property max_tp: int

The max_tp field.

property max_sp: int

The max_sp field.

static serialize(writer, data) None[source]

Serializes an instance of LevelUpStats to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (LevelUpStats) – The data to serialize.

static deserialize(reader) LevelUpStats[source]

Deserializes an instance of LevelUpStats from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LockerBuyServerPacket[source]

Bases: Packet

Response to buying a locker space upgrade from a banker NPC

__init__(*, gold_amount, locker_upgrades)[source]

Create a new instance of LockerBuyServerPacket.

Parameters:
  • gold_amount (int) – (Value range is 0-4097152080.)

  • locker_upgrades (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

property locker_upgrades: int

The locker_upgrades field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of LockerBuyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) LockerBuyServerPacket[source]

Deserializes an instance of LockerBuyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LockerGetServerPacket[source]

Bases: Packet

Response to taking an item from a bank locker

__init__(*, taken_item, weight, locker_items)[source]

Create a new instance of LockerGetServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property taken_item: ThreeItem

The taken_item field.

property weight: Weight

The weight field.

property locker_items: tuple[ThreeItem, ...]

The locker_items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of LockerGetServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) LockerGetServerPacket[source]

Deserializes an instance of LockerGetServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LockerOpenServerPacket[source]

Bases: Packet

Opening a bank locker

__init__(*, locker_coords, locker_items)[source]

Create a new instance of LockerOpenServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property locker_coords: Coords

The locker_coords field.

property locker_items: tuple[ThreeItem, ...]

The locker_items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of LockerOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) LockerOpenServerPacket[source]

Deserializes an instance of LockerOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LockerReplyServerPacket[source]

Bases: Packet

Response to adding an item to a bank locker

__init__(*, deposited_item, weight, locker_items)[source]

Create a new instance of LockerReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property deposited_item: Item

The deposited_item field.

property weight: Weight

The weight field.

property locker_items: tuple[ThreeItem, ...]

The locker_items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of LockerReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) LockerReplyServerPacket[source]

Deserializes an instance of LockerReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LockerSpecServerPacket[source]

Bases: Packet

Reply to trying to add an item to a full locker

__init__(*, locker_max_items)[source]

Create a new instance of LockerSpecServerPacket.

Parameters:

locker_max_items (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property locker_max_items: int

The locker_max_items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of LockerSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) LockerSpecServerPacket[source]

Deserializes an instance of LockerSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class LoginMessageCode[source]

Bases: IntEnum

Whether a warning message should be displayed upon entering the game

No = 0
Yes = 2
class LoginReply[source]

Bases: IntEnum

Reply code sent with LOGIN_REPLY packet. Indicates the result of a login attempt.

WrongUser = 1
WrongUserPassword = 2
Ok = 3
Banned = 4

The official client won’t display a message until the connection from the server is closed

LoggedIn = 5
Busy = 6

The official client won’t display a message until the connection from the server is closed

class LoginReplyServerPacket[source]

Bases: Packet

Login reply

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of LoginReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: LoginReply

The reply_code field.

property reply_code_data: ReplyCodeDataWrongUser | ReplyCodeDataWrongUserPassword | ReplyCodeDataOk | ReplyCodeDataBanned | ReplyCodeDataLoggedIn | ReplyCodeDataBusy | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) LoginReplyServerPacket[source]

Deserializes an instance of LoginReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of LoginReplyServerPacket.ReplyCodeDataWrongUser | LoginReplyServerPacket.ReplyCodeDataWrongUserPassword | LoginReplyServerPacket.ReplyCodeDataOk | LoginReplyServerPacket.ReplyCodeDataBanned | LoginReplyServerPacket.ReplyCodeDataLoggedIn | LoginReplyServerPacket.ReplyCodeDataBusy | None

class ReplyCodeDataWrongUser[source]

Bases: object

Data associated with reply_code value LoginReply.WrongUser

__init__()[source]

Create a new instance of LoginReplyServerPacket.ReplyCodeDataWrongUser.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket.ReplyCodeDataWrongUser to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataWrongUser[source]

Deserializes an instance of LoginReplyServerPacket.ReplyCodeDataWrongUser from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataWrongUserPassword[source]

Bases: object

Data associated with reply_code value LoginReply.WrongUserPassword

__init__()[source]

Create a new instance of LoginReplyServerPacket.ReplyCodeDataWrongUserPassword.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket.ReplyCodeDataWrongUserPassword to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataWrongUserPassword[source]

Deserializes an instance of LoginReplyServerPacket.ReplyCodeDataWrongUserPassword from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataOk[source]

Bases: object

Data associated with reply_code value LoginReply.Ok

__init__(*, characters)[source]

Create a new instance of LoginReplyServerPacket.ReplyCodeDataOk.

Parameters:

characters (Iterable[CharacterSelectionListEntry]) – (Length must be 252 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property characters: tuple[CharacterSelectionListEntry, ...]

The characters field.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket.ReplyCodeDataOk to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ReplyCodeDataOk) – The data to serialize.

static deserialize(reader) ReplyCodeDataOk[source]

Deserializes an instance of LoginReplyServerPacket.ReplyCodeDataOk from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataBanned[source]

Bases: object

Data associated with reply_code value LoginReply.Banned

__init__()[source]

Create a new instance of LoginReplyServerPacket.ReplyCodeDataBanned.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket.ReplyCodeDataBanned to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataBanned[source]

Deserializes an instance of LoginReplyServerPacket.ReplyCodeDataBanned from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataLoggedIn[source]

Bases: object

Data associated with reply_code value LoginReply.LoggedIn

__init__()[source]

Create a new instance of LoginReplyServerPacket.ReplyCodeDataLoggedIn.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket.ReplyCodeDataLoggedIn to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataLoggedIn[source]

Deserializes an instance of LoginReplyServerPacket.ReplyCodeDataLoggedIn from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataBusy[source]

Bases: object

Data associated with reply_code value LoginReply.Busy

__init__()[source]

Create a new instance of LoginReplyServerPacket.ReplyCodeDataBusy.

property byte_size: int

The size of the data that this was deserialized from.

static serialize(writer, data) None[source]

Serializes an instance of LoginReplyServerPacket.ReplyCodeDataBusy to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataBusy[source]

Deserializes an instance of LoginReplyServerPacket.ReplyCodeDataBusy from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MapDamageType[source]

Bases: IntEnum

Type of damage being caused by the environment

TpDrain = 1
Spikes = 2
class MapDrainDamageOther[source]

Bases: object

Another player taking damage from a map HP drain

__init__(*, player_id, hp_percentage, damage)[source]

Create a new instance of MapDrainDamageOther.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • hp_percentage (int) – (Value range is 0-252.)

  • damage (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property hp_percentage: int

The hp_percentage field.

property damage: int

The damage field.

static serialize(writer, data) None[source]

Serializes an instance of MapDrainDamageOther to the provided EoWriter.

Parameters:
static deserialize(reader) MapDrainDamageOther[source]

Deserializes an instance of MapDrainDamageOther from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MapEffect[source]

Bases: IntEnum

An effect that occurs for all players on a map

Quake = 1
class MapFile[source]

Bases: object

A map file (EMF)

__init__(*, content)[source]

Create a new instance of MapFile.

Parameters:

content (bytes)

property byte_size: int

The size of the data that this was deserialized from.

property content: bytes

The content field.

static serialize(writer, data) None[source]

Serializes an instance of MapFile to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (MapFile) – The data to serialize.

static deserialize(reader) MapFile[source]

Deserializes an instance of MapFile from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MarriageOpenServerPacket[source]

Bases: Packet

Response from talking to a law NPC

__init__(*, session_id)[source]

Create a new instance of MarriageOpenServerPacket.

Parameters:

session_id (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MarriageOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MarriageOpenServerPacket[source]

Deserializes an instance of MarriageOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MarriageReply[source]

Bases: IntEnum

Reply code sent with MARRIAGE_REPLY packet

AlreadyMarried = 1
NotMarried = 2
Success = 3
NotEnoughGold = 4
WrongName = 5
ServiceBusy = 6
DivorceNotification = 7
class MarriageReplyServerPacket[source]

Bases: Packet

Reply to client Marriage-family packets

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of MarriageReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: MarriageReply

The reply_code field.

property reply_code_data: ReplyCodeDataSuccess | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MarriageReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MarriageReplyServerPacket[source]

Deserializes an instance of MarriageReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of MarriageReplyServerPacket.ReplyCodeDataSuccess | None

class ReplyCodeDataSuccess[source]

Bases: object

Data associated with reply_code value MarriageReply.Success

__init__(*, gold_amount)[source]

Create a new instance of MarriageReplyServerPacket.ReplyCodeDataSuccess.

Parameters:

gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

static serialize(writer, data) None[source]

Serializes an instance of MarriageReplyServerPacket.ReplyCodeDataSuccess to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataSuccess[source]

Deserializes an instance of MarriageReplyServerPacket.ReplyCodeDataSuccess from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MessageAcceptServerPacket[source]

Bases: Packet

Large message box

__init__(*, messages)[source]

Create a new instance of MessageAcceptServerPacket.

Parameters:

messages (Iterable[str]) – (Length must be 4.)

property byte_size: int

The size of the data that this was deserialized from.

property messages: tuple[str, ...]

The messages field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MessageAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MessageAcceptServerPacket[source]

Deserializes an instance of MessageAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MessageCloseServerPacket[source]

Bases: Packet

Server is rebooting

__init__()[source]

Create a new instance of MessageCloseServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MessageCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MessageCloseServerPacket[source]

Deserializes an instance of MessageCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MessageOpenServerPacket[source]

Bases: Packet

Status bar message

__init__(*, message)[source]

Create a new instance of MessageOpenServerPacket.

Parameters:

message (str)

property byte_size: int

The size of the data that this was deserialized from.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MessageOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MessageOpenServerPacket[source]

Deserializes an instance of MessageOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MessagePongServerPacket[source]

Bases: Packet

#ping command reply

__init__()[source]

Create a new instance of MessagePongServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MessagePongServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MessagePongServerPacket[source]

Deserializes an instance of MessagePongServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class MusicPlayerServerPacket[source]

Bases: Packet

Sound effect

__init__(*, sound_id)[source]

Create a new instance of MusicPlayerServerPacket.

Parameters:

sound_id (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property sound_id: int

The sound_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of MusicPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) MusicPlayerServerPacket[source]

Deserializes an instance of MusicPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NearbyInfo[source]

Bases: object

Information about nearby entities

__init__(*, characters, npcs, items)[source]

Create a new instance of NearbyInfo.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property characters: tuple[CharacterMapInfo, ...]

The characters field.

property npcs: tuple[NpcMapInfo, ...]

The npcs field.

property items: tuple[ItemMapInfo, ...]

The items field.

static serialize(writer, data) None[source]

Serializes an instance of NearbyInfo to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (NearbyInfo) – The data to serialize.

static deserialize(reader) NearbyInfo[source]

Deserializes an instance of NearbyInfo from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcAcceptServerPacket[source]

Bases: Packet

Nearby NPC killed and killer leveled up

__init__(*, npc_killed_data, experience=None, level_up=None)[source]

Create a new instance of NpcAcceptServerPacket.

Parameters:
  • npc_killed_data (NpcKilledData)

  • experience (int | None, default: None) – This field should be sent to the killer, but not nearby players (Value range is 0-4097152080.)

  • level_up (LevelUpStats | None, default: None) – This field should be sent to the killer if they leveled up, but not nearby players

property byte_size: int

The size of the data that this was deserialized from.

property npc_killed_data: NpcKilledData

The npc_killed_data field.

property experience: int | None

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

property level_up: LevelUpStats | None

This field should be sent to the killer if they leveled up, but not nearby players

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcAcceptServerPacket[source]

Deserializes an instance of NpcAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcAgreeServerPacket[source]

Bases: Packet

Reply to request for information about nearby NPCs

__init__(*, npcs)[source]

Create a new instance of NpcAgreeServerPacket.

Parameters:

npcs (Iterable[NpcMapInfo]) – (Length must be 252 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property npcs: tuple[NpcMapInfo, ...]

The npcs field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcAgreeServerPacket[source]

Deserializes an instance of NpcAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcDialogServerPacket[source]

Bases: Packet

NPC chat message

__init__(*, npc_index, message)[source]

Create a new instance of NpcDialogServerPacket.

Parameters:
  • npc_index (int) – (Value range is 0-64008.)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property npc_index: int

The npc_index field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcDialogServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcDialogServerPacket[source]

Deserializes an instance of NpcDialogServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcJunkServerPacket[source]

Bases: Packet

Clearing all boss children

__init__(*, npc_id)[source]

Create a new instance of NpcJunkServerPacket.

Parameters:

npc_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property npc_id: int

The npc_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcJunkServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcJunkServerPacket[source]

Deserializes an instance of NpcJunkServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcKillStealProtectionState[source]

Bases: IntEnum

Flag to indicate whether you are able to attack an NPC

Unprotected = 1
Protected = 2
class NpcKilledData[source]

Bases: object

Information about an NPC that has been killed

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

Create a new instance of NpcKilledData.

Parameters:
  • 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.)

property byte_size: int

The size of the data that this was deserialized from.

property killer_id: int

The killer_id field.

property killer_direction: Direction

The killer_direction field.

property npc_index: int

The npc_index field.

property drop_index: int

The drop_index field.

property drop_id: int

The drop_id field.

property drop_coords: Coords

The drop_coords field.

property drop_amount: int

The drop_amount field.

property damage: int

The damage field.

static serialize(writer, data) None[source]

Serializes an instance of NpcKilledData to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (NpcKilledData) – The data to serialize.

static deserialize(reader) NpcKilledData[source]

Deserializes an instance of NpcKilledData from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcMapInfo[source]

Bases: object

Information about a nearby NPC

__init__(*, index, id, coords, direction)[source]

Create a new instance of NpcMapInfo.

Parameters:
  • index (int) – (Value range is 0-252.)

  • id (int) – (Value range is 0-64008.)

  • coords (Coords)

  • direction (Direction)

property byte_size: int

The size of the data that this was deserialized from.

property index: int

The index field.

property id: int

The id field.

property coords: Coords

The coords field.

property direction: Direction

The direction field.

static serialize(writer, data) None[source]

Serializes an instance of NpcMapInfo to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (NpcMapInfo) – The data to serialize.

static deserialize(reader) NpcMapInfo[source]

Deserializes an instance of NpcMapInfo from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcPlayerServerPacket[source]

Bases: Packet

Main NPC update message

__init__(*, positions, attacks, chats, hp=None, tp=None)[source]

Create a new instance of NpcPlayerServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property positions: tuple[NpcUpdatePosition, ...]

The positions field.

property attacks: tuple[NpcUpdateAttack, ...]

The attacks field.

property chats: tuple[NpcUpdateChat, ...]

The chats field.

property hp: int | None

The hp field.

property tp: int | None

The tp field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcPlayerServerPacket[source]

Deserializes an instance of NpcPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcReplyServerPacket[source]

Bases: Packet

Nearby NPC hit by a player

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

Create a new instance of NpcReplyServerPacket.

Parameters:
  • 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 (NpcKillStealProtectionState | None, default: None) – This field should be sent to the attacker, but not nearby players

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property player_direction: Direction

The player_direction field.

property npc_index: int

The npc_index field.

property damage: int

The damage field.

property hp_percentage: int

The hp_percentage field.

property kill_steal_protection: NpcKillStealProtectionState | None

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

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcReplyServerPacket[source]

Deserializes an instance of NpcReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcSpecServerPacket[source]

Bases: Packet

Nearby NPC killed by player

__init__(*, npc_killed_data, experience=None)[source]

Create a new instance of NpcSpecServerPacket.

Parameters:
  • npc_killed_data (NpcKilledData)

  • experience (int | None, default: None) – This field should be sent to the killer, but not nearby players (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property npc_killed_data: NpcKilledData

The npc_killed_data field.

property experience: int | None

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

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of NpcSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) NpcSpecServerPacket[source]

Deserializes an instance of NpcSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcUpdateAttack[source]

Bases: object

An NPC attacking

__init__(*, npc_index, killed, direction, player_id, damage, hp_percentage)[source]

Create a new instance of NpcUpdateAttack.

Parameters:
  • npc_index (int) – (Value range is 0-252.)

  • killed (PlayerKilledState)

  • direction (Direction)

  • player_id (int) – (Value range is 0-64008.)

  • damage (int) – (Value range is 0-16194276.)

  • hp_percentage (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property npc_index: int

The npc_index field.

property killed: PlayerKilledState

The killed field.

property direction: Direction

The direction field.

property player_id: int

The player_id field.

property damage: int

The damage field.

property hp_percentage: int

The hp_percentage field.

static serialize(writer, data) None[source]

Serializes an instance of NpcUpdateAttack to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (NpcUpdateAttack) – The data to serialize.

static deserialize(reader) NpcUpdateAttack[source]

Deserializes an instance of NpcUpdateAttack from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcUpdateChat[source]

Bases: object

An NPC talking

__init__(*, npc_index, message)[source]

Create a new instance of NpcUpdateChat.

Parameters:
  • npc_index (int) – (Value range is 0-252.)

  • message (str) – (Length must be 252 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property npc_index: int

The npc_index field.

property message: str

The message field.

static serialize(writer, data) None[source]

Serializes an instance of NpcUpdateChat to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (NpcUpdateChat) – The data to serialize.

static deserialize(reader) NpcUpdateChat[source]

Deserializes an instance of NpcUpdateChat from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class NpcUpdatePosition[source]

Bases: object

An NPC walking

__init__(*, npc_index, coords, direction)[source]

Create a new instance of NpcUpdatePosition.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property npc_index: int

The npc_index field.

property coords: Coords

The coords field.

property direction: Direction

The direction field.

static serialize(writer, data) None[source]

Serializes an instance of NpcUpdatePosition to the provided EoWriter.

Parameters:
static deserialize(reader) NpcUpdatePosition[source]

Deserializes an instance of NpcUpdatePosition from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class OnlinePlayer[source]

Bases: object

A player in the online list

__init__(*, name, title, level, icon, class_id, guild_tag)[source]

Create a new instance of OnlinePlayer.

Parameters:
  • name (str)

  • title (str)

  • level (int) – (Value range is 0-252.)

  • icon (CharacterIcon)

  • class_id (int) – (Value range is 0-252.)

  • guild_tag (str)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property title: str

The title field.

property level: int

The level field.

property icon: CharacterIcon

The icon field.

property class_id: int

The class_id field.

property guild_tag: str

The guild_tag field.

static serialize(writer, data) None[source]

Serializes an instance of OnlinePlayer to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (OnlinePlayer) – The data to serialize.

static deserialize(reader) OnlinePlayer[source]

Deserializes an instance of OnlinePlayer from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PaperdollAgreeServerPacket[source]

Bases: Packet

Reply to equipping an item

__init__(*, change, item_id, remaining_amount, sub_loc, stats)[source]

Create a new instance of PaperdollAgreeServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property change: AvatarChange

The change field.

property item_id: int

The item_id field.

property remaining_amount: int

The remaining_amount field.

property sub_loc: int

The sub_loc field.

property stats: CharacterStatsEquipmentChange

The stats field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PaperdollAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PaperdollAgreeServerPacket[source]

Deserializes an instance of PaperdollAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PaperdollPingServerPacket[source]

Bases: Packet

Failed to equip an item due to being the incorrect class

__init__(*, class_id)[source]

Create a new instance of PaperdollPingServerPacket.

Parameters:

class_id (int) – The player’s current class ID (not the item’s required class ID) (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property class_id: int

The player’s current class ID (not the item’s required class ID)

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PaperdollPingServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PaperdollPingServerPacket[source]

Deserializes an instance of PaperdollPingServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PaperdollRemoveServerPacket[source]

Bases: Packet

Reply to unequipping an item

__init__(*, change, item_id, sub_loc, stats)[source]

Create a new instance of PaperdollRemoveServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property change: AvatarChange

The change field.

property item_id: int

The item_id field.

property sub_loc: int

The sub_loc field.

property stats: CharacterStatsEquipmentChange

The stats field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PaperdollRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PaperdollRemoveServerPacket[source]

Deserializes an instance of PaperdollRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PaperdollReplyServerPacket[source]

Bases: Packet

Reply to requesting a paperdoll

__init__(*, details, equipment, icon)[source]

Create a new instance of PaperdollReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property details: CharacterDetails

The details field.

property equipment: EquipmentPaperdoll

The equipment field.

property icon: CharacterIcon

The icon field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PaperdollReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PaperdollReplyServerPacket[source]

Deserializes an instance of PaperdollReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyAddServerPacket[source]

Bases: Packet

New player joined the party

__init__(*, member)[source]

Create a new instance of PartyAddServerPacket.

Parameters:

member (PartyMember)

property byte_size: int

The size of the data that this was deserialized from.

property member: PartyMember

The member field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyAddServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyAddServerPacket[source]

Deserializes an instance of PartyAddServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyAgreeServerPacket[source]

Bases: Packet

Party member list update

__init__(*, player_id, hp_percentage)[source]

Create a new instance of PartyAgreeServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • hp_percentage (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property hp_percentage: int

The hp_percentage field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyAgreeServerPacket[source]

Deserializes an instance of PartyAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyCloseServerPacket[source]

Bases: Packet

Left / disbanded a party

__init__()[source]

Create a new instance of PartyCloseServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyCloseServerPacket[source]

Deserializes an instance of PartyCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyCreateServerPacket[source]

Bases: Packet

Member list received when party is first joined

__init__(*, members)[source]

Create a new instance of PartyCreateServerPacket.

Parameters:

members (Iterable[PartyMember])

property byte_size: int

The size of the data that this was deserialized from.

property members: tuple[PartyMember, ...]

The members field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyCreateServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyCreateServerPacket[source]

Deserializes an instance of PartyCreateServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyExpShare[source]

Bases: object

EXP gain for a member of the player’s party

__init__(*, player_id, experience, level_up)[source]

Create a new instance of PartyExpShare.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • experience (int) – (Value range is 0-4097152080.)

  • level_up (int) – A value greater than 0 is “new level” and indicates the player leveled up. (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property experience: int

The experience field.

property level_up: int

A value greater than 0 is “new level” and indicates the player leveled up.

static serialize(writer, data) None[source]

Serializes an instance of PartyExpShare to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PartyExpShare) – The data to serialize.

static deserialize(reader) PartyExpShare[source]

Deserializes an instance of PartyExpShare from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyListServerPacket[source]

Bases: Packet

Party member list update

__init__(*, members)[source]

Create a new instance of PartyListServerPacket.

Parameters:

members (Iterable[PartyMember])

property byte_size: int

The size of the data that this was deserialized from.

property members: tuple[PartyMember, ...]

The members field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyListServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyListServerPacket[source]

Deserializes an instance of PartyListServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyMember[source]

Bases: object

A member of the player’s party

__init__(*, player_id, leader, level, hp_percentage, name)[source]

Create a new instance of PartyMember.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • leader (bool)

  • level (int) – (Value range is 0-252.)

  • hp_percentage (int) – (Value range is 0-252.)

  • name (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property leader: bool

The leader field.

property level: int

The level field.

property hp_percentage: int

The hp_percentage field.

property name: str

The name field.

static serialize(writer, data) None[source]

Serializes an instance of PartyMember to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PartyMember) – The data to serialize.

static deserialize(reader) PartyMember[source]

Deserializes an instance of PartyMember from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyRemoveServerPacket[source]

Bases: Packet

Player left the party

__init__(*, player_id)[source]

Create a new instance of PartyRemoveServerPacket.

Parameters:

player_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyRemoveServerPacket[source]

Deserializes an instance of PartyRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyReplyCode[source]

Bases: IntEnum

Reply code sent with PARTY_REPLY packet. Indicates why an invite or join request failed.

AlreadyInAnotherParty = 0
AlreadyInYourParty = 1
PartyIsFull = 2
class PartyReplyServerPacket[source]

Bases: Packet

Failed party invite / join request

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of PartyReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: PartyReplyCode

The reply_code field.

property reply_code_data: ReplyCodeDataAlreadyInAnotherParty | ReplyCodeDataAlreadyInYourParty | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyReplyServerPacket[source]

Deserializes an instance of PartyReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty | PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty | None

class ReplyCodeDataAlreadyInAnotherParty[source]

Bases: object

Data associated with reply_code value PartyReplyCode.AlreadyInAnotherParty

__init__(*, player_name)[source]

Create a new instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty.

Parameters:

player_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

static serialize(writer, data) None[source]

Serializes an instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataAlreadyInAnotherParty[source]

Deserializes an instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInAnotherParty from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ReplyCodeDataAlreadyInYourParty[source]

Bases: object

Data associated with reply_code value PartyReplyCode.AlreadyInYourParty

__init__(*, player_name)[source]

Create a new instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty.

Parameters:

player_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

static serialize(writer, data) None[source]

Serializes an instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataAlreadyInYourParty[source]

Deserializes an instance of PartyReplyServerPacket.ReplyCodeDataAlreadyInYourParty from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyRequestServerPacket[source]

Bases: Packet

Received party invite / join request

__init__(*, request_type, inviter_player_id, player_name)[source]

Create a new instance of PartyRequestServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property request_type: PartyRequestType

The request_type field.

property inviter_player_id: int

The inviter_player_id field.

property player_name: str

The player_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyRequestServerPacket[source]

Deserializes an instance of PartyRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PartyTargetGroupServerPacket[source]

Bases: Packet

Updated experience and level-ups from party experience

__init__(*, gains)[source]

Create a new instance of PartyTargetGroupServerPacket.

Parameters:

gains (Iterable[PartyExpShare])

property byte_size: int

The size of the data that this was deserialized from.

property gains: tuple[PartyExpShare, ...]

The gains field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PartyTargetGroupServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PartyTargetGroupServerPacket[source]

Deserializes an instance of PartyTargetGroupServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayerEffect[source]

Bases: object

An effect playing on a player

__init__(*, player_id, effect_id)[source]

Create a new instance of PlayerEffect.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • effect_id (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property effect_id: int

The effect_id field.

static serialize(writer, data) None[source]

Serializes an instance of PlayerEffect to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PlayerEffect) – The data to serialize.

static deserialize(reader) PlayerEffect[source]

Deserializes an instance of PlayerEffect from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayerKilledState[source]

Bases: IntEnum

Flag to indicate that a player has been killed

Alive = 1
Killed = 2
class PlayersAgreeServerPacket[source]

Bases: Packet

Player has appeared in nearby view

__init__(*, nearby)[source]

Create a new instance of PlayersAgreeServerPacket.

Parameters:

nearby (NearbyInfo)

property byte_size: int

The size of the data that this was deserialized from.

property nearby: NearbyInfo

The nearby field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersAgreeServerPacket[source]

Deserializes an instance of PlayersAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersList[source]

Bases: object

Information about online players

__init__(*, players)[source]

Create a new instance of PlayersList.

Parameters:

players (Iterable[OnlinePlayer]) – (Length must be 64008 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property players: tuple[OnlinePlayer, ...]

The players field.

static serialize(writer, data) None[source]

Serializes an instance of PlayersList to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PlayersList) – The data to serialize.

static deserialize(reader) PlayersList[source]

Deserializes an instance of PlayersList from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersListFriends[source]

Bases: object

Information about online players. Sent in reply to friends list requests.

__init__(*, players)[source]

Create a new instance of PlayersListFriends.

Parameters:

players (Iterable[str]) – (Length must be 64008 or less.)

property byte_size: int

The size of the data that this was deserialized from.

property players: tuple[str, ...]

The players field.

static serialize(writer, data) None[source]

Serializes an instance of PlayersListFriends to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersListFriends[source]

Deserializes an instance of PlayersListFriends from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersListServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.PlayersList

__init__(*, players_list)[source]

Create a new instance of PlayersListServerPacket.

Parameters:

players_list (PlayersList)

property byte_size: int

The size of the data that this was deserialized from.

property players_list: PlayersList

The players_list field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersListServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersListServerPacket[source]

Deserializes an instance of PlayersListServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersNet242ServerPacket[source]

Bases: Packet

#find command reply - different map

__init__(*, name)[source]

Create a new instance of PlayersNet242ServerPacket.

Parameters:

name (str)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersNet242ServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersNet242ServerPacket[source]

Deserializes an instance of PlayersNet242ServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersPingServerPacket[source]

Bases: Packet

#find command reply - offline

__init__(*, name)[source]

Create a new instance of PlayersPingServerPacket.

Parameters:

name (str)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersPingServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersPingServerPacket[source]

Deserializes an instance of PlayersPingServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersPongServerPacket[source]

Bases: Packet

#find command reply - same map

__init__(*, name)[source]

Create a new instance of PlayersPongServerPacket.

Parameters:

name (str)

property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersPongServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersPongServerPacket[source]

Deserializes an instance of PlayersPongServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersRemoveServerPacket[source]

Bases: Packet

Nearby player has logged out

__init__(*, player_id)[source]

Create a new instance of PlayersRemoveServerPacket.

Parameters:

player_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersRemoveServerPacket[source]

Deserializes an instance of PlayersRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PlayersReplyServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.PlayersListFriends

__init__(*, players_list)[source]

Create a new instance of PlayersReplyServerPacket.

Parameters:

players_list (PlayersListFriends)

property byte_size: int

The size of the data that this was deserialized from.

property players_list: PlayersListFriends

The players_list field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PlayersReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PlayersReplyServerPacket[source]

Deserializes an instance of PlayersReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PriestOpenServerPacket[source]

Bases: Packet

Response from talking to a priest NPC

__init__(*, session_id)[source]

Create a new instance of PriestOpenServerPacket.

Parameters:

session_id (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PriestOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PriestOpenServerPacket[source]

Deserializes an instance of PriestOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PriestReply[source]

Bases: IntEnum

Reply code sent with PRIEST_REPLY packet

NotDressed = 1
LowLevel = 2
PartnerNotPresent = 3
PartnerNotDressed = 4
Busy = 5
DoYou = 6
PartnerAlreadyMarried = 7
NoPermission = 8
class PriestReplyServerPacket[source]

Bases: Packet

Reply to client Priest-family packets

__init__(*, reply_code)[source]

Create a new instance of PriestReplyServerPacket.

Parameters:

reply_code (PriestReply)

property byte_size: int

The size of the data that this was deserialized from.

property reply_code: PriestReply

The reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PriestReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PriestReplyServerPacket[source]

Deserializes an instance of PriestReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PriestRequestServerPacket[source]

Bases: Packet

Wedding request

__init__(*, session_id, partner_name)[source]

Create a new instance of PriestRequestServerPacket.

Parameters:
  • session_id (int) – (Value range is 0-64008.)

  • partner_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

property partner_name: str

The partner_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of PriestRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) PriestRequestServerPacket[source]

Deserializes an instance of PriestRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PubFile[source]

Bases: object

A pub file (EIF, ENF, ECF, ESF)

__init__(*, file_id, content)[source]

Create a new instance of PubFile.

Parameters:
  • file_id (int) – (Value range is 0-252.)

  • content (bytes)

property byte_size: int

The size of the data that this was deserialized from.

property file_id: int

The file_id field.

property content: bytes

The content field.

static serialize(writer, data) None[source]

Serializes an instance of PubFile to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PubFile) – The data to serialize.

static deserialize(reader) PubFile[source]

Deserializes an instance of PubFile from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class QuestDialogServerPacket[source]

Bases: Packet

Quest selection dialog

__init__(*, behavior_id, quest_id, session_id, dialog_id, quest_entries, dialog_entries)[source]

Create a new instance of QuestDialogServerPacket.

Parameters:
  • behavior_id (int) – (Value range is 0-64008.)

  • quest_id (int) – (Value range is 0-64008.)

  • session_id (int) – (Value range is 0-64008.)

  • dialog_id (int) – (Value range is 0-64008.)

  • quest_entries (Iterable[DialogQuestEntry]) – (Length must be 252 or less.)

  • dialog_entries (Iterable[DialogEntry])

property byte_size: int

The size of the data that this was deserialized from.

property behavior_id: int

The behavior_id field.

property quest_id: int

The quest_id field.

property session_id: int

The session_id field.

property dialog_id: int

The dialog_id field.

property quest_entries: tuple[DialogQuestEntry, ...]

The quest_entries field.

property dialog_entries: tuple[DialogEntry, ...]

The dialog_entries field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of QuestDialogServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) QuestDialogServerPacket[source]

Deserializes an instance of QuestDialogServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class QuestListServerPacket[source]

Bases: Packet

Quest history / progress reply

__init__(*, page, quests_count, page_data=None)[source]

Create a new instance of QuestListServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property page: QuestPage

The page field.

property quests_count: int

The quests_count field.

property page_data: PageDataProgress | PageDataHistory | None

Data associated with the page field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of QuestListServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) QuestListServerPacket[source]

Deserializes an instance of QuestListServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

PageData

Data associated with different values of the page field.

alias of QuestListServerPacket.PageDataProgress | QuestListServerPacket.PageDataHistory | None

class PageDataProgress[source]

Bases: object

Data associated with page value QuestPage.Progress

__init__(*, quest_progress_entries)[source]

Create a new instance of QuestListServerPacket.PageDataProgress.

Parameters:

quest_progress_entries (Iterable[QuestProgressEntry])

property byte_size: int

The size of the data that this was deserialized from.

property quest_progress_entries: tuple[QuestProgressEntry, ...]

The quest_progress_entries field.

static serialize(writer, data) None[source]

Serializes an instance of QuestListServerPacket.PageDataProgress to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PageDataProgress) – The data to serialize.

static deserialize(reader) PageDataProgress[source]

Deserializes an instance of QuestListServerPacket.PageDataProgress from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class PageDataHistory[source]

Bases: object

Data associated with page value QuestPage.History

__init__(*, completed_quests)[source]

Create a new instance of QuestListServerPacket.PageDataHistory.

Parameters:

completed_quests (Iterable[str])

property byte_size: int

The size of the data that this was deserialized from.

property completed_quests: tuple[str, ...]

The completed_quests field.

static serialize(writer, data) None[source]

Serializes an instance of QuestListServerPacket.PageDataHistory to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (PageDataHistory) – The data to serialize.

static deserialize(reader) PageDataHistory[source]

Deserializes an instance of QuestListServerPacket.PageDataHistory from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class QuestProgressEntry[source]

Bases: object

An entry in the Quest Progress window

__init__(*, name, description, icon, progress, target)[source]

Create a new instance of QuestProgressEntry.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property name: str

The name field.

property description: str

The description field.

property icon: QuestRequirementIcon

The icon field.

property progress: int

The progress field.

property target: int

The target field.

static serialize(writer, data) None[source]

Serializes an instance of QuestProgressEntry to the provided EoWriter.

Parameters:
static deserialize(reader) QuestProgressEntry[source]

Deserializes an instance of QuestProgressEntry from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class QuestReportServerPacket[source]

Bases: Packet

NPC chat messages

__init__(*, npc_index, messages)[source]

Create a new instance of QuestReportServerPacket.

Parameters:
  • npc_index (int) – (Value range is 0-64008.)

  • messages (Iterable[str])

property byte_size: int

The size of the data that this was deserialized from.

property npc_index: int

The npc_index field.

property messages: tuple[str, ...]

The messages field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of QuestReportServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) QuestReportServerPacket[source]

Deserializes an instance of QuestReportServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class QuestRequirementIcon[source]

Bases: IntEnum

Icon displayed for each quest in the Quest Progress window

Item = 3
Talk = 5
Kill = 8
Step = 10
class RangeReplyServerPacket[source]

Bases: Packet

Reply to request for information about nearby players and NPCs

__init__(*, nearby)[source]

Create a new instance of RangeReplyServerPacket.

Parameters:

nearby (NearbyInfo)

property byte_size: int

The size of the data that this was deserialized from.

property nearby: NearbyInfo

The nearby field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RangeReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RangeReplyServerPacket[source]

Deserializes an instance of RangeReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class RecoverAgreeServerPacket[source]

Bases: Packet

Nearby player gained HP

__init__(*, player_id, heal_hp, hp_percentage)[source]

Create a new instance of RecoverAgreeServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • heal_hp (int) – (Value range is 0-4097152080.)

  • hp_percentage (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property heal_hp: int

The heal_hp field.

property hp_percentage: int

The hp_percentage field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RecoverAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RecoverAgreeServerPacket[source]

Deserializes an instance of RecoverAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class RecoverListServerPacket[source]

Bases: Packet

Stats update

__init__(*, class_id, stats)[source]

Create a new instance of RecoverListServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property class_id: int

The class_id field.

property stats: CharacterStatsUpdate

The stats field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RecoverListServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RecoverListServerPacket[source]

Deserializes an instance of RecoverListServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class RecoverPlayerServerPacket[source]

Bases: Packet

HP/TP update

__init__(*, hp, tp)[source]

Create a new instance of RecoverPlayerServerPacket.

Parameters:
  • hp (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property hp: int

The hp field.

property tp: int

The tp field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RecoverPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RecoverPlayerServerPacket[source]

Deserializes an instance of RecoverPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class RecoverReplyServerPacket[source]

Bases: Packet

Karma/experience update

__init__(*, experience, karma, level_up=None, stat_points=None, skill_points=None)[source]

Create a new instance of RecoverReplyServerPacket.

Parameters:
  • experience (int) – (Value range is 0-4097152080.)

  • karma (int) – (Value range is 0-64008.)

  • level_up (int | None, default: None) – A value greater than 0 is “new level” and indicates the player leveled up. The official client reads this if the packet is larger than 6 bytes. (Value range is 0-252.)

  • stat_points (int | None, default: None) – The official client reads this if the player leveled up (Value range is 0-64008.)

  • skill_points (int | None, default: None) – The official client reads this if the player leveled up (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property experience: int

The experience field.

property karma: int

The karma field.

property level_up: int | None

A value greater than 0 is “new level” and indicates the player leveled up. The official client reads this if the packet is larger than 6 bytes.

property stat_points: int | None

The official client reads this if the player leveled up

property skill_points: int | None

The official client reads this if the player leveled up

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RecoverReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RecoverReplyServerPacket[source]

Deserializes an instance of RecoverReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class RecoverTargetGroupServerPacket[source]

Bases: Packet

Updated stats when levelling up from party experience

__init__(*, stat_points, skill_points, max_hp, max_tp, max_sp)[source]

Create a new instance of RecoverTargetGroupServerPacket.

Parameters:
  • stat_points (int) – (Value range is 0-64008.)

  • skill_points (int) – (Value range is 0-64008.)

  • max_hp (int) – (Value range is 0-64008.)

  • max_tp (int) – (Value range is 0-64008.)

  • max_sp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property stat_points: int

The stat_points field.

property skill_points: int

The skill_points field.

property max_hp: int

The max_hp field.

property max_tp: int

The max_tp field.

property max_sp: int

The max_sp field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RecoverTargetGroupServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RecoverTargetGroupServerPacket[source]

Deserializes an instance of RecoverTargetGroupServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class RefreshReplyServerPacket[source]

Bases: Packet

Reply to request for new info about nearby objects

__init__(*, nearby)[source]

Create a new instance of RefreshReplyServerPacket.

Parameters:

nearby (NearbyInfo)

property byte_size: int

The size of the data that this was deserialized from.

property nearby: NearbyInfo

The nearby field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of RefreshReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) RefreshReplyServerPacket[source]

Deserializes an instance of RefreshReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ServerSettings[source]

Bases: object

Settings sent with WELCOME_REPLY packet

__init__(*, jail_map, rescue_map, rescue_coords, spy_and_light_guide_flood_rate, guardian_flood_rate, game_master_flood_rate, high_game_master_flood_rate)[source]

Create a new instance of ServerSettings.

Parameters:
  • jail_map (int) – (Value range is 0-64008.)

  • rescue_map (int) – (Value range is 0-64008.)

  • rescue_coords (Coords)

  • spy_and_light_guide_flood_rate (int) – (Value range is 0-64008.)

  • guardian_flood_rate (int) – (Value range is 0-64008.)

  • game_master_flood_rate (int) – (Value range is 0-64008.)

  • high_game_master_flood_rate (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property jail_map: int

The jail_map field.

property rescue_map: int

The rescue_map field.

property rescue_coords: Coords

The rescue_coords field.

property spy_and_light_guide_flood_rate: int

The spy_and_light_guide_flood_rate field.

property guardian_flood_rate: int

The guardian_flood_rate field.

property game_master_flood_rate: int

The game_master_flood_rate field.

property high_game_master_flood_rate: int

The high_game_master_flood_rate field.

static serialize(writer, data) None[source]

Serializes an instance of ServerSettings to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ServerSettings) – The data to serialize.

static deserialize(reader) ServerSettings[source]

Deserializes an instance of ServerSettings from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopBuyServerPacket[source]

Bases: Packet

Response to purchasing an item from a shop

__init__(*, gold_amount, bought_item, weight)[source]

Create a new instance of ShopBuyServerPacket.

Parameters:
  • gold_amount (int) – (Value range is 0-4097152080.)

  • bought_item (Item)

  • weight (Weight)

property byte_size: int

The size of the data that this was deserialized from.

property gold_amount: int

The gold_amount field.

property bought_item: Item

The bought_item field.

property weight: Weight

The weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ShopBuyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ShopBuyServerPacket[source]

Deserializes an instance of ShopBuyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopCraftItem[source]

Bases: object

An item that a shop can craft

__init__(*, item_id, ingredients)[source]

Create a new instance of ShopCraftItem.

Parameters:
  • item_id (int) – (Value range is 0-64008.)

  • ingredients (Iterable[CharItem]) – (Length must be 4.)

property byte_size: int

The size of the data that this was deserialized from.

property item_id: int

The item_id field.

property ingredients: tuple[CharItem, ...]

The ingredients field.

static serialize(writer, data) None[source]

Serializes an instance of ShopCraftItem to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ShopCraftItem) – The data to serialize.

static deserialize(reader) ShopCraftItem[source]

Deserializes an instance of ShopCraftItem from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopCreateServerPacket[source]

Bases: Packet

Response to crafting an item from a shop

__init__(*, craft_item_id, weight, ingredients)[source]

Create a new instance of ShopCreateServerPacket.

Parameters:
  • craft_item_id (int) – (Value range is 0-64008.)

  • weight (Weight)

  • ingredients (Iterable[Item]) – (Length must be 4.)

property byte_size: int

The size of the data that this was deserialized from.

property craft_item_id: int

The craft_item_id field.

property weight: Weight

The weight field.

property ingredients: tuple[Item, ...]

The ingredients field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ShopCreateServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ShopCreateServerPacket[source]

Deserializes an instance of ShopCreateServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopOpenServerPacket[source]

Bases: Packet

Response from talking to a shop NPC

__init__(*, session_id, shop_name, trade_items, craft_items)[source]

Create a new instance of ShopOpenServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

property shop_name: str

The shop_name field.

property trade_items: tuple[ShopTradeItem, ...]

The trade_items field.

property craft_items: tuple[ShopCraftItem, ...]

The craft_items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ShopOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ShopOpenServerPacket[source]

Deserializes an instance of ShopOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopSellServerPacket[source]

Bases: Packet

Response to selling an item to a shop

__init__(*, sold_item, gold_amount, weight)[source]

Create a new instance of ShopSellServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property sold_item: ShopSoldItem

The sold_item field.

property gold_amount: int

The gold_amount field.

property weight: Weight

The weight field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of ShopSellServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) ShopSellServerPacket[source]

Deserializes an instance of ShopSellServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopSoldItem[source]

Bases: object

A sold item when selling an item to a shop

__init__(*, amount, id)[source]

Create a new instance of ShopSoldItem.

Parameters:
  • amount (int) – (Value range is 0-4097152080.)

  • id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property amount: int

The amount field.

property id: int

The id field.

static serialize(writer, data) None[source]

Serializes an instance of ShopSoldItem to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ShopSoldItem) – The data to serialize.

static deserialize(reader) ShopSoldItem[source]

Deserializes an instance of ShopSoldItem from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class ShopTradeItem[source]

Bases: object

An item that a shop can buy or sell

__init__(*, item_id, buy_price, sell_price, max_buy_amount)[source]

Create a new instance of ShopTradeItem.

Parameters:
  • item_id (int) – (Value range is 0-64008.)

  • buy_price (int) – (Value range is 0-16194276.)

  • sell_price (int) – (Value range is 0-16194276.)

  • max_buy_amount (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property item_id: int

The item_id field.

property buy_price: int

The buy_price field.

property sell_price: int

The sell_price field.

property max_buy_amount: int

The max_buy_amount field.

static serialize(writer, data) None[source]

Serializes an instance of ShopTradeItem to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (ShopTradeItem) – The data to serialize.

static deserialize(reader) ShopTradeItem[source]

Deserializes an instance of ShopTradeItem from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SitCloseServerPacket[source]

Bases: Packet

Your character standing up

__init__(*, player_id, coords)[source]

Create a new instance of SitCloseServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • coords (Coords)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SitCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SitCloseServerPacket[source]

Deserializes an instance of SitCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SitPlayerServerPacket[source]

Bases: Packet

Nearby player sitting down

__init__(*, player_id, coords, direction)[source]

Create a new instance of SitPlayerServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SitPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SitPlayerServerPacket[source]

Deserializes an instance of SitPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SitRemoveServerPacket[source]

Bases: Packet

Nearby player standing up

__init__(*, player_id, coords)[source]

Create a new instance of SitRemoveServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • coords (Coords)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SitRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SitRemoveServerPacket[source]

Deserializes an instance of SitRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SitReplyServerPacket[source]

Bases: Packet

Your character sitting down

__init__(*, player_id, coords, direction)[source]

Create a new instance of SitReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property coords: Coords

The coords field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SitReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SitReplyServerPacket[source]

Deserializes an instance of SitReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SitState[source]

Bases: IntEnum

Indicates how a player is sitting (or not sitting)

Stand = 0
Chair = 1
Floor = 2
class SkillLearn[source]

Bases: object

A skill that can be learned from a skill master NPC

__init__(*, id, level_requirement, class_requirement, cost, skill_requirements, stat_requirements)[source]

Create a new instance of SkillLearn.

Parameters:
  • id (int) – (Value range is 0-64008.)

  • level_requirement (int) – (Value range is 0-252.)

  • class_requirement (int) – (Value range is 0-252.)

  • cost (int) – (Value range is 0-4097152080.)

  • skill_requirements (Iterable[int]) – (Length must be 4.) (Element value range is 0-64008.)

  • stat_requirements (SkillStatRequirements)

property byte_size: int

The size of the data that this was deserialized from.

property id: int

The id field.

property level_requirement: int

The level_requirement field.

property class_requirement: int

The class_requirement field.

property cost: int

The cost field.

property skill_requirements: tuple[int, ...]

The skill_requirements field.

property stat_requirements: SkillStatRequirements

The stat_requirements field.

static serialize(writer, data) None[source]

Serializes an instance of SkillLearn to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (SkillLearn) – The data to serialize.

static deserialize(reader) SkillLearn[source]

Deserializes an instance of SkillLearn from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SkillMasterReply[source]

Bases: IntEnum

Reply code sent with STATSKILL_REPLY packet. Indicates why an action was unsuccessful.

RemoveItems = 1
WrongClass = 2
class SkillStatRequirements[source]

Bases: object

Stat requirements to learn a skill from a skill master NPC

__init__(*, str, wis, intl, agi, con, cha)[source]

Create a new instance of SkillStatRequirements.

Parameters:
  • str (int) – (Value range is 0-64008.)

  • wis (int) – (Value range is 0-64008.)

  • intl (int) – (Value range is 0-64008.)

  • agi (int) – (Value range is 0-64008.)

  • con (int) – (Value range is 0-64008.)

  • cha (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property str: int

The str field.

property wis: int

The wis field.

property intl: int

The intl field.

property agi: int

The agi field.

property con: int

The con field.

property cha: int

The cha field.

static serialize(writer, data) None[source]

Serializes an instance of SkillStatRequirements to the provided EoWriter.

Parameters:
static deserialize(reader) SkillStatRequirements[source]

Deserializes an instance of SkillStatRequirements from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellErrorServerPacket[source]

Bases: Packet

Show flood protection message (vestigial)

__init__()[source]

Create a new instance of SpellErrorServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellErrorServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellErrorServerPacket[source]

Deserializes an instance of SpellErrorServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellPlayerServerPacket[source]

Bases: Packet

Nearby player raising their arm to cast a spell (vestigial)

__init__(*, player_id, direction)[source]

Create a new instance of SpellPlayerServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • direction (Direction)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property direction: Direction

The direction field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellPlayerServerPacket[source]

Deserializes an instance of SpellPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellReplyServerPacket[source]

Bases: Packet

Your character self-cast a targetable heal spell

__init__(*, spell_id, hp, tp)[source]

Create a new instance of SpellReplyServerPacket.

Parameters:
  • spell_id (int) – (Value range is 0-64008.)

  • hp (int) – (Value range is 0-64008.)

  • tp (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

property hp: int

The hp field.

property tp: int

The tp field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellReplyServerPacket[source]

Deserializes an instance of SpellReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellRequestServerPacket[source]

Bases: Packet

Nearby player chanting a spell

__init__(*, player_id, spell_id)[source]

Create a new instance of SpellRequestServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • spell_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property spell_id: int

The spell_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellRequestServerPacket[source]

Deserializes an instance of SpellRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellTargetGroupServerPacket[source]

Bases: Packet

Nearby player(s) hit by a group heal spell from a player

__init__(*, spell_id, caster_id, caster_tp, spell_heal_hp, players)[source]

Create a new instance of SpellTargetGroupServerPacket.

Parameters:
  • spell_id (int) – (Value range is 0-64008.)

  • caster_id (int) – (Value range is 0-64008.)

  • caster_tp (int) – (Value range is 0-64008.)

  • spell_heal_hp (int) – (Value range is 0-64008.)

  • players (Iterable[GroupHealTargetPlayer])

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

property caster_id: int

The caster_id field.

property caster_tp: int

The caster_tp field.

property spell_heal_hp: int

The spell_heal_hp field.

property players: tuple[GroupHealTargetPlayer, ...]

The players field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellTargetGroupServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellTargetGroupServerPacket[source]

Deserializes an instance of SpellTargetGroupServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellTargetOtherServerPacket[source]

Bases: Packet

Nearby player hit by a heal spell from a player

__init__(*, victim_id, caster_id, caster_direction, spell_id, spell_heal_hp, hp_percentage, hp=None)[source]

Create a new instance of SpellTargetOtherServerPacket.

Parameters:
  • victim_id (int) – (Value range is 0-64008.)

  • caster_id (int) – (Value range is 0-64008.)

  • caster_direction (Direction)

  • 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 (int | None, default: None) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property victim_id: int

The victim_id field.

property caster_id: int

The caster_id field.

property caster_direction: Direction

The caster_direction field.

property spell_id: int

The spell_id field.

property spell_heal_hp: int

The spell_heal_hp field.

property hp_percentage: int

The hp_percentage field.

property hp: int | None

The hp field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellTargetOtherServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellTargetOtherServerPacket[source]

Deserializes an instance of SpellTargetOtherServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class SpellTargetSelfServerPacket[source]

Bases: Packet

Nearby player self-casted a spell

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

Create a new instance of SpellTargetSelfServerPacket.

Parameters:
  • 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 (int | None, default: None) – The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)

  • tp (int | None, default: None) – The official client reads this if the packet is larger than 12 bytes (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property spell_id: int

The spell_id field.

property spell_heal_hp: int

The spell_heal_hp field.

property hp_percentage: int

The hp_percentage field.

property hp: int | None

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

property tp: int | None

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

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of SpellTargetSelfServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) SpellTargetSelfServerPacket[source]

Deserializes an instance of SpellTargetSelfServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillAcceptServerPacket[source]

Bases: Packet

Response to spending skill points

__init__(*, skill_points, spell)[source]

Create a new instance of StatSkillAcceptServerPacket.

Parameters:
  • skill_points (int) – (Value range is 0-64008.)

  • spell (Spell)

property byte_size: int

The size of the data that this was deserialized from.

property skill_points: int

The skill_points field.

property spell: Spell

The spell field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillAcceptServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillAcceptServerPacket[source]

Deserializes an instance of StatSkillAcceptServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillJunkServerPacket[source]

Bases: Packet

Response to resetting stats and skills at a skill master

__init__(*, stats)[source]

Create a new instance of StatSkillJunkServerPacket.

Parameters:

stats (CharacterStatsReset)

property byte_size: int

The size of the data that this was deserialized from.

property stats: CharacterStatsReset

The stats field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillJunkServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillJunkServerPacket[source]

Deserializes an instance of StatSkillJunkServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillOpenServerPacket[source]

Bases: Packet

Response from talking to a skill master NPC

__init__(*, session_id, shop_name, skills)[source]

Create a new instance of StatSkillOpenServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

property shop_name: str

The shop_name field.

property skills: tuple[SkillLearn, ...]

The skills field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillOpenServerPacket[source]

Deserializes an instance of StatSkillOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillPlayerServerPacket[source]

Bases: Packet

Response to spending stat points

__init__(*, stat_points, stats)[source]

Create a new instance of StatSkillPlayerServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property stat_points: int

The stat_points field.

property stats: CharacterStatsUpdate

The stats field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillPlayerServerPacket[source]

Deserializes an instance of StatSkillPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillRemoveServerPacket[source]

Bases: Packet

Response to forgetting a skill at a skill master

__init__(*, spell_id)[source]

Create a new instance of StatSkillRemoveServerPacket.

Parameters:

spell_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillRemoveServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillRemoveServerPacket[source]

Deserializes an instance of StatSkillRemoveServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillReplyServerPacket[source]

Bases: Packet

Response from unsuccessful action at a skill master

__init__(*, reply_code, reply_code_data=None)[source]

Create a new instance of StatSkillReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: SkillMasterReply

The reply_code field.

property reply_code_data: ReplyCodeDataWrongClass | None

Data associated with the reply_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillReplyServerPacket[source]

Deserializes an instance of StatSkillReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

ReplyCodeData

Data associated with different values of the reply_code field.

alias of StatSkillReplyServerPacket.ReplyCodeDataWrongClass | None

class ReplyCodeDataWrongClass[source]

Bases: object

Data associated with reply_code value SkillMasterReply.WrongClass

__init__(*, class_id)[source]

Create a new instance of StatSkillReplyServerPacket.ReplyCodeDataWrongClass.

Parameters:

class_id (int) – (Value range is 0-252.)

property byte_size: int

The size of the data that this was deserialized from.

property class_id: int

The class_id field.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillReplyServerPacket.ReplyCodeDataWrongClass to the provided EoWriter.

Parameters:
static deserialize(reader) ReplyCodeDataWrongClass[source]

Deserializes an instance of StatSkillReplyServerPacket.ReplyCodeDataWrongClass from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class StatSkillTakeServerPacket[source]

Bases: Packet

Response from learning a skill from a skill master

__init__(*, spell_id, gold_amount)[source]

Create a new instance of StatSkillTakeServerPacket.

Parameters:
  • spell_id (int) – (Value range is 0-64008.)

  • gold_amount (int) – (Value range is 0-4097152080.)

property byte_size: int

The size of the data that this was deserialized from.

property spell_id: int

The spell_id field.

property gold_amount: int

The gold_amount field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of StatSkillTakeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) StatSkillTakeServerPacket[source]

Deserializes an instance of StatSkillTakeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkAdminServerPacket[source]

Bases: Packet

Admin chat message

__init__(*, player_name, message)[source]

Create a new instance of TalkAdminServerPacket.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkAdminServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkAdminServerPacket[source]

Deserializes an instance of TalkAdminServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkAnnounceServerPacket[source]

Bases: Packet

Admin announcement

__init__(*, player_name, message)[source]

Create a new instance of TalkAnnounceServerPacket.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkAnnounceServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkAnnounceServerPacket[source]

Deserializes an instance of TalkAnnounceServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkListServerPacket[source]

Bases: Packet

Global chat backfill. Sent by the official game server when a player opens the global chat tab.

__init__(*, messages)[source]

Create a new instance of TalkListServerPacket.

Parameters:

messages (Iterable[GlobalBackfillMessage])

property byte_size: int

The size of the data that this was deserialized from.

property messages: tuple[GlobalBackfillMessage, ...]

The messages field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkListServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkListServerPacket[source]

Deserializes an instance of TalkListServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkMsgServerPacket[source]

Bases: Packet

Global chat message

__init__(*, player_name, message)[source]

Create a new instance of TalkMsgServerPacket.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkMsgServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkMsgServerPacket[source]

Deserializes an instance of TalkMsgServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkOpenServerPacket[source]

Bases: Packet

Party chat message

__init__(*, player_id, message)[source]

Create a new instance of TalkOpenServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkOpenServerPacket[source]

Deserializes an instance of TalkOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkPlayerServerPacket[source]

Bases: Packet

Public chat message

__init__(*, player_id, message)[source]

Create a new instance of TalkPlayerServerPacket.

Parameters:
  • player_id (int) – (Value range is 0-64008.)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkPlayerServerPacket[source]

Deserializes an instance of TalkPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkReply[source]

Bases: IntEnum

Reply code sent with TALK_REPLY packet

NotFound = 1
class TalkReplyServerPacket[source]

Bases: Packet

Reply to trying to send a private message

__init__(*, reply_code, name)[source]

Create a new instance of TalkReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property reply_code: TalkReply

The reply_code field.

property name: str

The name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkReplyServerPacket[source]

Deserializes an instance of TalkReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkRequestServerPacket[source]

Bases: Packet

Guild chat message

__init__(*, player_name, message)[source]

Create a new instance of TalkRequestServerPacket.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkRequestServerPacket[source]

Deserializes an instance of TalkRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkServerServerPacket[source]

Bases: Packet

Server message

__init__(*, message)[source]

Create a new instance of TalkServerServerPacket.

Parameters:

message (str)

property byte_size: int

The size of the data that this was deserialized from.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkServerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkServerServerPacket[source]

Deserializes an instance of TalkServerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkSpecServerPacket[source]

Bases: Packet

Temporary mute applied

__init__(*, admin_name)[source]

Create a new instance of TalkSpecServerPacket.

Parameters:

admin_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property admin_name: str

The admin_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkSpecServerPacket[source]

Deserializes an instance of TalkSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TalkTellServerPacket[source]

Bases: Packet

Private chat message

__init__(*, player_name, message)[source]

Create a new instance of TalkTellServerPacket.

Parameters:
  • player_name (str)

  • message (str)

property byte_size: int

The size of the data that this was deserialized from.

property player_name: str

The player_name field.

property message: str

The message field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TalkTellServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TalkTellServerPacket[source]

Deserializes an instance of TalkTellServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TileEffect[source]

Bases: object

An effect playing on a tile

__init__(*, coords, effect_id)[source]

Create a new instance of TileEffect.

Parameters:
  • coords (Coords)

  • effect_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property coords: Coords

The coords field.

property effect_id: int

The effect_id field.

static serialize(writer, data) None[source]

Serializes an instance of TileEffect to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (TileEffect) – The data to serialize.

static deserialize(reader) TileEffect[source]

Deserializes an instance of TileEffect from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeAdminServerPacket[source]

Bases: Packet

Trade updated (items changed while trade was accepted)

__init__(*, trade_data)[source]

Create a new instance of TradeAdminServerPacket.

Parameters:

trade_data (Iterable[TradeItemData]) – (Length must be 2.)

property byte_size: int

The size of the data that this was deserialized from.

property trade_data: tuple[TradeItemData, ...]

The trade_data field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeAdminServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeAdminServerPacket[source]

Deserializes an instance of TradeAdminServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeAgreeServerPacket[source]

Bases: Packet

Partner agree state updated

__init__(*, partner_player_id, agree)[source]

Create a new instance of TradeAgreeServerPacket.

Parameters:
  • partner_player_id (int) – (Value range is 0-64008.)

  • agree (bool)

property byte_size: int

The size of the data that this was deserialized from.

property partner_player_id: int

The partner_player_id field.

property agree: bool

The agree field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeAgreeServerPacket[source]

Deserializes an instance of TradeAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeCloseServerPacket[source]

Bases: Packet

Partner closed trade window

__init__(*, partner_player_id)[source]

Create a new instance of TradeCloseServerPacket.

Parameters:

partner_player_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property partner_player_id: int

The partner_player_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeCloseServerPacket[source]

Deserializes an instance of TradeCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeItemData[source]

Bases: object

Trade window item data

__init__(*, player_id, items)[source]

Create a new instance of TradeItemData.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property items: tuple[Item, ...]

The items field.

static serialize(writer, data) None[source]

Serializes an instance of TradeItemData to the provided EoWriter.

Parameters:
  • writer (EoWriter) – The writer that the data will be serialized to.

  • data (TradeItemData) – The data to serialize.

static deserialize(reader) TradeItemData[source]

Deserializes an instance of TradeItemData from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeOpenServerPacket[source]

Bases: Packet

Trade window opens

__init__(*, partner_player_id, partner_player_name, your_player_id, your_player_name)[source]

Create a new instance of TradeOpenServerPacket.

Parameters:
  • partner_player_id (int) – (Value range is 0-64008.)

  • partner_player_name (str)

  • your_player_id (int) – (Value range is 0-64008.)

  • your_player_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property partner_player_id: int

The partner_player_id field.

property partner_player_name: str

The partner_player_name field.

property your_player_id: int

The your_player_id field.

property your_player_name: str

The your_player_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeOpenServerPacket[source]

Deserializes an instance of TradeOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeReplyServerPacket[source]

Bases: Packet

Trade updated (items changed)

__init__(*, trade_data)[source]

Create a new instance of TradeReplyServerPacket.

Parameters:

trade_data (Iterable[TradeItemData]) – (Length must be 2.)

property byte_size: int

The size of the data that this was deserialized from.

property trade_data: tuple[TradeItemData, ...]

The trade_data field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeReplyServerPacket[source]

Deserializes an instance of TradeReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeRequestServerPacket[source]

Bases: Packet

Trade request from another player

__init__(*, partner_player_id, partner_player_name)[source]

Create a new instance of TradeRequestServerPacket.

Parameters:
  • partner_player_id (int) – (Value range is 0-64008.)

  • partner_player_name (str)

property byte_size: int

The size of the data that this was deserialized from.

property partner_player_id: int

The partner_player_id field.

property partner_player_name: str

The partner_player_name field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeRequestServerPacket[source]

Deserializes an instance of TradeRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeSpecServerPacket[source]

Bases: Packet

Own agree state updated

__init__(*, agree)[source]

Create a new instance of TradeSpecServerPacket.

Parameters:

agree (bool)

property byte_size: int

The size of the data that this was deserialized from.

property agree: bool

The agree field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeSpecServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeSpecServerPacket[source]

Deserializes an instance of TradeSpecServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class TradeUseServerPacket[source]

Bases: Packet

Trade completed

__init__(*, trade_data)[source]

Create a new instance of TradeUseServerPacket.

Parameters:

trade_data (Iterable[TradeItemData]) – (Length must be 2.)

property byte_size: int

The size of the data that this was deserialized from.

property trade_data: tuple[TradeItemData, ...]

The trade_data field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of TradeUseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) TradeUseServerPacket[source]

Deserializes an instance of TradeUseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WalkCloseServerPacket[source]

Bases: Packet

Your character has been frozen

__init__()[source]

Create a new instance of WalkCloseServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WalkCloseServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WalkCloseServerPacket[source]

Deserializes an instance of WalkCloseServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WalkOpenServerPacket[source]

Bases: Packet

Your character has been unfrozen

__init__()[source]

Create a new instance of WalkOpenServerPacket.

property byte_size: int

The size of the data that this was deserialized from.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WalkOpenServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WalkOpenServerPacket[source]

Deserializes an instance of WalkOpenServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WalkPlayerServerPacket[source]

Bases: Packet

Nearby player has walked

__init__(*, player_id, direction, coords)[source]

Create a new instance of WalkPlayerServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_id: int

The player_id field.

property direction: Direction

The direction field.

property coords: Coords

The coords field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WalkPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WalkPlayerServerPacket[source]

Deserializes an instance of WalkPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WalkReplyServerPacket[source]

Bases: Packet

Players, NPCs, and Items appearing in nearby view

__init__(*, player_ids, npc_indexes, items)[source]

Create a new instance of WalkReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property player_ids: tuple[int, ...]

The player_ids field.

property npc_indexes: tuple[int, ...]

The npc_indexes field.

property items: tuple[ItemMapInfo, ...]

The items field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WalkReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WalkReplyServerPacket[source]

Deserializes an instance of WalkReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WarpAgreeServerPacket[source]

Bases: Packet

Reply after accepting a warp

__init__(*, warp_type, warp_type_data=None, nearby)[source]

Create a new instance of WarpAgreeServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property warp_type: WarpType

The warp_type field.

property warp_type_data: WarpTypeDataMapSwitch | None

Data associated with the warp_type field.

property nearby: NearbyInfo

The nearby field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WarpAgreeServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WarpAgreeServerPacket[source]

Deserializes an instance of WarpAgreeServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

WarpTypeData

Data associated with different values of the warp_type field.

alias of WarpAgreeServerPacket.WarpTypeDataMapSwitch | None

class WarpTypeDataMapSwitch[source]

Bases: object

Data associated with warp_type value WarpType.MapSwitch

__init__(*, map_id, warp_effect)[source]

Create a new instance of WarpAgreeServerPacket.WarpTypeDataMapSwitch.

Parameters:
  • map_id (int) – (Value range is 0-64008.)

  • warp_effect (WarpEffect)

property byte_size: int

The size of the data that this was deserialized from.

property map_id: int

The map_id field.

property warp_effect: WarpEffect

The warp_effect field.

static serialize(writer, data) None[source]

Serializes an instance of WarpAgreeServerPacket.WarpTypeDataMapSwitch to the provided EoWriter.

Parameters:
static deserialize(reader) WarpTypeDataMapSwitch[source]

Deserializes an instance of WarpAgreeServerPacket.WarpTypeDataMapSwitch from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WarpCreateServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.MapMutation

__init__(*, map_file)[source]

Create a new instance of WarpCreateServerPacket.

Parameters:

map_file (MapFile)

property byte_size: int

The size of the data that this was deserialized from.

property map_file: MapFile

The map_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WarpCreateServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WarpCreateServerPacket[source]

Deserializes an instance of WarpCreateServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WarpEffect[source]

Bases: IntEnum

An effect that accompanies a player warp

None_ = 0

Does nothing

Scroll = 1

Plays the scroll sound effect

Admin = 2

Plays the admin warp sound effect and animation

class WarpPlayerServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.WarpMap

__init__(*, map_file)[source]

Create a new instance of WarpPlayerServerPacket.

Parameters:

map_file (MapFile)

property byte_size: int

The size of the data that this was deserialized from.

property map_file: MapFile

The map_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WarpPlayerServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WarpPlayerServerPacket[source]

Deserializes an instance of WarpPlayerServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WarpRequestServerPacket[source]

Bases: Packet

Warp request from server

__init__(*, warp_type, map_id, warp_type_data=None, session_id)[source]

Create a new instance of WarpRequestServerPacket.

Parameters:
  • warp_type (WarpType)

  • map_id (int) – (Value range is 0-64008.)

  • warp_type_data (WarpTypeDataMapSwitch | None, default: None) – Data associated with the warp_type field.

  • session_id (int) – (Value range is 0-64008.)

property byte_size: int

The size of the data that this was deserialized from.

property warp_type: WarpType

The warp_type field.

property map_id: int

The map_id field.

property warp_type_data: WarpTypeDataMapSwitch | None

Data associated with the warp_type field.

property session_id: int

The session_id field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WarpRequestServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WarpRequestServerPacket[source]

Deserializes an instance of WarpRequestServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

WarpTypeData

Data associated with different values of the warp_type field.

alias of WarpRequestServerPacket.WarpTypeDataMapSwitch | None

class WarpTypeDataMapSwitch[source]

Bases: object

Data associated with warp_type value WarpType.MapSwitch

__init__(*, map_rid, map_file_size)[source]

Create a new instance of WarpRequestServerPacket.WarpTypeDataMapSwitch.

Parameters:
  • map_rid (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • map_file_size (int) – (Value range is 0-16194276.)

property byte_size: int

The size of the data that this was deserialized from.

property map_rid: tuple[int, ...]

The map_rid field.

property map_file_size: int

The map_file_size field.

static serialize(writer, data) None[source]

Serializes an instance of WarpRequestServerPacket.WarpTypeDataMapSwitch to the provided EoWriter.

Parameters:
static deserialize(reader) WarpTypeDataMapSwitch[source]

Deserializes an instance of WarpRequestServerPacket.WarpTypeDataMapSwitch from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WarpType[source]

Bases: IntEnum

Indicates whether a warp is within the current map, or switching to another map

Local = 1
MapSwitch = 2
class WelcomeCode[source]

Bases: IntEnum

Reply code sent with WELCOME_REPLY packet

SelectCharacter = 1
EnterGame = 2
ServerBusy = 3
LoggedIn = 4
class WelcomeNet242ServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.FileEnf

__init__(*, pub_file)[source]

Create a new instance of WelcomeNet242ServerPacket.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WelcomeNet242ServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomeNet242ServerPacket[source]

Deserializes an instance of WelcomeNet242ServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WelcomeNet243ServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.FileEsf

__init__(*, pub_file)[source]

Create a new instance of WelcomeNet243ServerPacket.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WelcomeNet243ServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomeNet243ServerPacket[source]

Deserializes an instance of WelcomeNet243ServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WelcomeNet244ServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.FileEcf

__init__(*, pub_file)[source]

Create a new instance of WelcomeNet244ServerPacket.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WelcomeNet244ServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomeNet244ServerPacket[source]

Deserializes an instance of WelcomeNet244ServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WelcomePingServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.FileMap

__init__(*, map_file)[source]

Create a new instance of WelcomePingServerPacket.

Parameters:

map_file (MapFile)

property byte_size: int

The size of the data that this was deserialized from.

property map_file: MapFile

The map_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WelcomePingServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomePingServerPacket[source]

Deserializes an instance of WelcomePingServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WelcomePongServerPacket[source]

Bases: Packet

Equivalent to INIT_INIT with InitReply.FileEif

__init__(*, pub_file)[source]

Create a new instance of WelcomePongServerPacket.

Parameters:

pub_file (PubFile)

property byte_size: int

The size of the data that this was deserialized from.

property pub_file: PubFile

The pub_file field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WelcomePongServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomePongServerPacket[source]

Deserializes an instance of WelcomePongServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WelcomeReplyServerPacket[source]

Bases: Packet

Reply to selecting a character / entering game

__init__(*, welcome_code, welcome_code_data=None)[source]

Create a new instance of WelcomeReplyServerPacket.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property welcome_code: WelcomeCode

The welcome_code field.

property welcome_code_data: WelcomeCodeDataSelectCharacter | WelcomeCodeDataEnterGame | None

Data associated with the welcome_code field.

static family() PacketFamily[source]

Returns the packet family associated with this packet.

Returns:

The packet family associated with this packet.

static action() PacketAction[source]

Returns the packet action associated with this packet.

Returns:

The packet action associated with this packet.

write(writer)[source]

Serializes and writes this packet to the provided EoWriter.

Parameters:

writer (EoWriter) – the writer that this packet will be written to.

static serialize(writer, data) None[source]

Serializes an instance of WelcomeReplyServerPacket to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomeReplyServerPacket[source]

Deserializes an instance of WelcomeReplyServerPacket from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

WelcomeCodeData

Data associated with different values of the welcome_code field.

alias of WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter | WelcomeReplyServerPacket.WelcomeCodeDataEnterGame | None

class WelcomeCodeDataSelectCharacter[source]

Bases: object

Data associated with welcome_code value WelcomeCode.SelectCharacter

__init__(*, session_id, character_id, map_id, map_rid, map_file_size, eif_rid, eif_length, enf_rid, enf_length, esf_rid, esf_length, ecf_rid, ecf_length, name, title, guild_name, guild_rank_name, class_id, guild_tag, admin, level, experience, usage, stats, equipment, guild_rank, settings, login_message_code)[source]

Create a new instance of WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter.

Parameters:
  • session_id (int) – (Value range is 0-64008.)

  • character_id (int) – (Value range is 0-4097152080.)

  • map_id (int) – (Value range is 0-64008.)

  • map_rid (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • map_file_size (int) – (Value range is 0-16194276.)

  • eif_rid (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • eif_length (int) – (Value range is 0-64008.)

  • enf_rid (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • enf_length (int) – (Value range is 0-64008.)

  • esf_rid (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • esf_length (int) – (Value range is 0-64008.)

  • ecf_rid (Iterable[int]) – (Length must be 2.) (Element value range is 0-64008.)

  • ecf_length (int) – (Value range is 0-64008.)

  • name (str)

  • title (str)

  • guild_name (str)

  • guild_rank_name (str)

  • class_id (int) – (Value range is 0-252.)

  • guild_tag (str) – (Length must be 3.)

  • admin (AdminLevel)

  • level (int) – (Value range is 0-252.)

  • experience (int) – (Value range is 0-4097152080.)

  • usage (int) – (Value range is 0-4097152080.)

  • stats (CharacterStatsWelcome)

  • equipment (EquipmentWelcome)

  • guild_rank (int) – (Value range is 0-252.)

  • settings (ServerSettings)

  • login_message_code (LoginMessageCode)

property byte_size: int

The size of the data that this was deserialized from.

property session_id: int

The session_id field.

property character_id: int

The character_id field.

property map_id: int

The map_id field.

property map_rid: tuple[int, ...]

The map_rid field.

property map_file_size: int

The map_file_size field.

property eif_rid: tuple[int, ...]

The eif_rid field.

property eif_length: int

The eif_length field.

property enf_rid: tuple[int, ...]

The enf_rid field.

property enf_length: int

The enf_length field.

property esf_rid: tuple[int, ...]

The esf_rid field.

property esf_length: int

The esf_length field.

property ecf_rid: tuple[int, ...]

The ecf_rid field.

property ecf_length: int

The ecf_length field.

property name: str

The name field.

property title: str

The title field.

property guild_name: str

The guild_name field.

property guild_rank_name: str

The guild_rank_name field.

property class_id: int

The class_id field.

property guild_tag: str

The guild_tag field.

property admin: AdminLevel

The admin field.

property level: int

The level field.

property experience: int

The experience field.

property usage: int

The usage field.

property stats: CharacterStatsWelcome

The stats field.

property equipment: EquipmentWelcome

The equipment field.

property guild_rank: int

The guild_rank field.

property settings: ServerSettings

The settings field.

property login_message_code: LoginMessageCode

The login_message_code field.

static serialize(writer, data) None[source]

Serializes an instance of WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomeCodeDataSelectCharacter[source]

Deserializes an instance of WelcomeReplyServerPacket.WelcomeCodeDataSelectCharacter from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.

class WelcomeCodeDataEnterGame[source]

Bases: object

Data associated with welcome_code value WelcomeCode.EnterGame

__init__(*, news, weight, items, spells, nearby)[source]

Create a new instance of WelcomeReplyServerPacket.WelcomeCodeDataEnterGame.

Parameters:
property byte_size: int

The size of the data that this was deserialized from.

property news: tuple[str, ...]

The news field.

property weight: Weight

The weight field.

property items: tuple[Item, ...]

The items field.

property spells: tuple[Spell, ...]

The spells field.

property nearby: NearbyInfo

The nearby field.

static serialize(writer, data) None[source]

Serializes an instance of WelcomeReplyServerPacket.WelcomeCodeDataEnterGame to the provided EoWriter.

Parameters:
static deserialize(reader) WelcomeCodeDataEnterGame[source]

Deserializes an instance of WelcomeReplyServerPacket.WelcomeCodeDataEnterGame from the provided EoReader.

Parameters:

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

Returns:

The data to serialize.