eolib 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

eolib/protocol/_generated/net/server/chest_spec_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestSpecServerPacket(Packet):
+    """
+    Reply to trying to add an item to a full chest
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/citizen_accept_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenAcceptServerPacket(Packet):
+    """
+    Sleeping at an inn
+    """
     _byte_size: int = 0
     _gold_amount: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/citizen_open_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenOpenServerPacket(Packet):
+    """
+    Response from talking to a citizenship NPC
+    """
     _byte_size: int = 0
     _behavior_id: int = None # type: ignore [assignment]
     _current_home_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/citizen_remove_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenRemoveServerPacket(Packet):
+    """
+    Response to giving up citizenship of a town
+    """
     _byte_size: int = 0
     _reply_code: InnUnsubscribeReply = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/citizen_reply_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenReplyServerPacket(Packet):
+    """
+    Response to subscribing to a town
+    """
     _byte_size: int = 0
     _questions_wrong: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/citizen_request_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CitizenRequestServerPacket(Packet):
+    """
+    Reply to requesting sleeping at an inn
+    """
     _byte_size: int = 0
     _cost: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/connection_player_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ConnectionPlayerServerPacket(Packet):
+    """
+    Ping request
+    """
     _byte_size: int = 0
     _seq1: int = None # type: ignore [assignment]
     _seq2: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/door_close_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class DoorCloseServerPacket(Packet):
+    """
+    Reply to trying to open a locked door
+    """
     _byte_size: int = 0
     _key: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/door_open_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class DoorOpenServerPacket(Packet):
+    """
+    Nearby door opening
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/effect_admin_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectAdminServerPacket(Packet):
+    """
+    Nearby character taking spike damage
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _hp_percentage: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/effect_agree_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectAgreeServerPacket(Packet):
+    """
+    Map tile effect
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
     _effect_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/effect_player_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectPlayerServerPacket(Packet):
+    """
+    Nearby player doing an effect
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _effect_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/effect_report_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectReportServerPacket(Packet):
+    """
+    Map spike timer
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/effect_spec_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectSpecServerPacket(Packet):
+    """
+    Taking spike or tp drain damage
+    """
     _byte_size: int = 0
     _map_damage_type: MapDamageType = None # type: ignore [assignment]
     _map_damage_type_data: 'EffectSpecServerPacket.MapDamageTypeData' = None

eolib/protocol/_generated/net/server/effect_target_other_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectTargetOtherServerPacket(Packet):
+    """
+    Map drain damage
+    """
     _byte_size: int = 0
     _damage: int = None # type: ignore [assignment]
     _hp: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/effect_use_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EffectUseServerPacket(Packet):
+    """
+    Map effect
+    """
     _byte_size: int = 0
     _effect: MapEffect = None # type: ignore [assignment]
     _effect_data: 'EffectUseServerPacket.EffectData' = None

eolib/protocol/_generated/net/server/emote_player_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class EmotePlayerServerPacket(Packet):
+    """
+    Nearby player doing an emote
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _emote: Emote = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/face_player_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class FacePlayerServerPacket(Packet):
+    """
+    Nearby player facing a direction
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _direction: Direction = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/guild_accept_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildAcceptServerPacket(Packet):
+    """
+    Update guild rank
+    """
     _byte_size: int = 0
     _rank: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/guild_agree_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildAgreeServerPacket(Packet):
+    """
+    Joined guild info
+    """
     _byte_size: int = 0
     _recruiter_id: int = None # type: ignore [assignment]
     _guild_tag: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/guild_buy_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildBuyServerPacket(Packet):
+    """
+    Deposit guild bank list reply
+    """
     _byte_size: int = 0
     _gold_amount: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/guild_create_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildCreateServerPacket(Packet):
+    """
+    Guild created
+    """
     _byte_size: int = 0
     _leader_player_id: int = None # type: ignore [assignment]
     _guild_tag: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/guild_kick_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildKickServerPacket(Packet):
+    """
+    Left the guild
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/guild_open_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildOpenServerPacket(Packet):
+    """
+    Talk to guild master NPC reply
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/guild_rank_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildRankServerPacket(Packet):
+    """
+    Get guild rank list reply
+    """
     _byte_size: int = 0
     _ranks: list[str] = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/guild_reply_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildReplyServerPacket(Packet):
+    """
+    Generic guild reply messages
+    """
     _byte_size: int = 0
     _reply_code: GuildReply = None # type: ignore [assignment]
     _reply_code_data: 'GuildReplyServerPacket.ReplyCodeData' = None

eolib/protocol/_generated/net/server/guild_report_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildReportServerPacket(Packet):
+    """
+    Get guild info reply
+    """
     _byte_size: int = 0
     _name: str = None # type: ignore [assignment]
     _tag: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/guild_request_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildRequestServerPacket(Packet):
+    """
+    Guild create request
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _guild_identity: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/guild_sell_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildSellServerPacket(Packet):
+    """
+    Get guild bank reply
+    """
     _byte_size: int = 0
     _gold_amount: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/guild_take_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildTakeServerPacket(Packet):
+    """
+    Get guild description reply
+    """
     _byte_size: int = 0
     _description: str = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/guild_tell_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class GuildTellServerPacket(Packet):
+    """
+    Get guild member list reply
+    """
     _byte_size: int = 0
     _members_count: int = None # type: ignore [assignment]
     _members: list[GuildMember] = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/init_init_server_packet.py

@@ -19,6 +19,10 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class InitInitServerPacket(Packet):
+    """
+    Reply to connection initialization and requests for unencrypted data.
+    This packet is unencrypted.
+    """
     _byte_size: int = 0
     _reply_code: InitReply = None # type: ignore [assignment]
     _reply_code_data: 'InitInitServerPacket.ReplyCodeData' = None

eolib/protocol/_generated/net/server/item_accept_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemAcceptServerPacket(Packet):
+    """
+    Nearby player leveled up from quest
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/item_add_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemAddServerPacket(Packet):
+    """
+    Item appeared on the ground
+    """
     _byte_size: int = 0
     _item_id: int = None # type: ignore [assignment]
     _item_index: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_agree_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemAgreeServerPacket(Packet):
+    """
+    Reply to using an item that you don't have
+    """
     _byte_size: int = 0
     _item_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/item_drop_server_packet.py

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemDropServerPacket(Packet):
+    """
+    Reply to dropping items on the ground
+    """
     _byte_size: int = 0
     _dropped_item: ThreeItem = None # type: ignore [assignment]
     _remaining_amount: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_get_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemGetServerPacket(Packet):
+    """
+    Reply to taking items from the ground
+    """
     _byte_size: int = 0
     _taken_item_index: int = None # type: ignore [assignment]
     _taken_item: ThreeItem = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_junk_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemJunkServerPacket(Packet):
+    """
+    Reply to junking items
+    """
     _byte_size: int = 0
     _junked_item: ThreeItem = None # type: ignore [assignment]
     _remaining_amount: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_kick_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemKickServerPacket(Packet):
+    """
+    Lose item (from quest)
+    """
     _byte_size: int = 0
     _item: Item = None # type: ignore [assignment]
     _current_weight: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_obtain_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemObtainServerPacket(Packet):
+    """
+    Receive item (from quest)
+    """
     _byte_size: int = 0
     _item: ThreeItem = None # type: ignore [assignment]
     _current_weight: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_remove_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemRemoveServerPacket(Packet):
+    """
+    Item disappeared from the ground
+    """
     _byte_size: int = 0
     _item_index: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/item_reply_server_packet.py

@@ -16,6 +16,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemReplyServerPacket(Packet):
+    """
+    Reply to using an item
+    """
     _byte_size: int = 0
     _item_type: ItemType = None # type: ignore [assignment]
     _used_item: Item = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/item_spec_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemSpecServerPacket(Packet):
+    """
+    Reply to trying to take a protected item from the ground
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/jukebox_agree_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxAgreeServerPacket(Packet):
+    """
+    Reply to successfully requesting a song
+    """
     _byte_size: int = 0
     _gold_amount: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/jukebox_msg_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxMsgServerPacket(Packet):
+    """
+    Someone playing a note with the bard skill nearby
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _direction: Direction = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/jukebox_open_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxOpenServerPacket(Packet):
+    """
+    Reply to opening the jukebox listing
+    """
     _byte_size: int = 0
     _map_id: int = None # type: ignore [assignment]
     _jukebox_player: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/jukebox_player_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxPlayerServerPacket(Packet):
+    """
+    Play background music
+    """
     _byte_size: int = 0
     _mfx_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/jukebox_reply_server_packet.py

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxReplyServerPacket(Packet):
+    """
+    Reply to unsuccessfully requesting a song
+    """
     _byte_size: int = 0
 
     @property

eolib/protocol/_generated/net/server/jukebox_use_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxUseServerPacket(Packet):
+    """
+    Play jukebox music
+    """
     _byte_size: int = 0
     _track_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/locker_buy_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerBuyServerPacket(Packet):
+    """
+    Response to buying a locker space upgrade from a banker NPC
+    """
     _byte_size: int = 0
     _gold_amount: int = None # type: ignore [assignment]
     _locker_upgrades: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/locker_get_server_packet.py

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerGetServerPacket(Packet):
+    """
+    Response to taking an item from a bank locker
+    """
     _byte_size: int = 0
     _taken_item: ThreeItem = None # type: ignore [assignment]
     _weight: Weight = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/locker_open_server_packet.py

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerOpenServerPacket(Packet):
+    """
+    Opening a bank locker
+    """
     _byte_size: int = 0
     _locker_coords: Coords = None # type: ignore [assignment]
     _locker_items: list[ThreeItem] = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/locker_reply_server_packet.py

@@ -15,6 +15,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerReplyServerPacket(Packet):
+    """
+    Response to adding an item to a bank locker
+    """
     _byte_size: int = 0
     _deposited_item: Item = None # type: ignore [assignment]
     _weight: Weight = None # type: ignore [assignment]

eolib/protocol/_generated/net/server/locker_spec_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerSpecServerPacket(Packet):
+    """
+    Reply to trying to add an item to a full locker
+    """
     _byte_size: int = 0
     _locker_max_items: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/login_reply_server_packet.py

@@ -15,6 +15,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LoginReplyServerPacket(Packet):
+    """
+    Login reply
+    """
     _byte_size: int = 0
     _reply_code: LoginReply = None # type: ignore [assignment]
     _reply_code_data: 'LoginReplyServerPacket.ReplyCodeData' = None

eolib/protocol/_generated/net/server/marriage_open_server_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class MarriageOpenServerPacket(Packet):
+    """
+    Response from talking to a law NPC
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/server/marriage_reply_server_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class MarriageReplyServerPacket(Packet):
+    """
+    Reply to client Marriage-family packets
+    """
     _byte_size: int = 0
     _reply_code: MarriageReply = None # type: ignore [assignment]
     _reply_code_data: 'MarriageReplyServerPacket.ReplyCodeData' = None

eolib/protocol/_generated/net/server/message_accept_server_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class MessageAcceptServerPacket(Packet):
+    """
+    Large message box
+    """
     _byte_size: int = 0
     _messages: list[str] = None # type: ignore [assignment]