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

eolib/protocol/_generated/net/client/talk_report_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkReportClientPacket(Packet):
+    """
+    Public chat message
+    """
     _byte_size: int = 0
     _message: str = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/talk_request_client_packet.py

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

eolib/protocol/_generated/net/client/talk_tell_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkTellClientPacket(Packet):
+    """
+    Private chat message
+    """
     _byte_size: int = 0
     _name: str = None # type: ignore [assignment]
     _message: str = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/talk_use_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TalkUseClientPacket(Packet):
+    """
+    Public chat message - alias of TALK_REPORT (vestigial)
+    """
     _byte_size: int = 0
     _message: str = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/trade_accept_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeAcceptClientPacket(Packet):
+    """
+    Accepting a trade request
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/trade_add_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeAddClientPacket(Packet):
+    """
+    Add an item to the trade screen
+    """
     _byte_size: int = 0
     _add_item: Item = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/trade_agree_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeAgreeClientPacket(Packet):
+    """
+    Mark trade as agreed
+    """
     _byte_size: int = 0
     _agree: bool = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/trade_close_client_packet.py

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

eolib/protocol/_generated/net/client/trade_remove_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeRemoveClientPacket(Packet):
+    """
+    Remove an item from the trade screen
+    """
     _byte_size: int = 0
     _item_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/trade_request_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class TradeRequestClientPacket(Packet):
+    """
+    Requesting a trade with another player
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/walk_admin_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkAdminClientPacket(Packet):
+    """
+    Walking with #nowall
+    """
     _byte_size: int = 0
     _walk_action: WalkAction = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/walk_player_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkPlayerClientPacket(Packet):
+    """
+    Walking
+    """
     _byte_size: int = 0
     _walk_action: WalkAction = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/walk_spec_client_packet.py

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WalkSpecClientPacket(Packet):
+    """
+    Walking through a player
+    """
     _byte_size: int = 0
     _walk_action: WalkAction = None # type: ignore [assignment]
 

eolib/protocol/_generated/net/client/warp_accept_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WarpAcceptClientPacket(Packet):
+    """
+    Accept a warp request from the server
+    """
     _byte_size: int = 0
     _map_id: int = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/warp_take_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WarpTakeClientPacket(Packet):
+    """
+    Request to download a copy of the map
+    """
     _byte_size: int = 0
     _map_id: int = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/welcome_agree_client_packet.py

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeAgreeClientPacket(Packet):
+    """
+    Requesting a file
+    """
     _byte_size: int = 0
     _file_type: FileType = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/welcome_msg_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeMsgClientPacket(Packet):
+    """
+    Entering game
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _character_id: int = None # type: ignore [assignment]

eolib/protocol/_generated/net/client/welcome_request_client_packet.py

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class WelcomeRequestClientPacket(Packet):
+    """
+    Selected a character
+    """
     _byte_size: int = 0
     _character_id: int = None # type: ignore [assignment]
 

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

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

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AdminInteractAgreeServerPacket(Packet):
+    """
+    Nearby player appearing (admin un-hide)
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AdminInteractListServerPacket(Packet):
+    """
+    Admin character inventory popup
+    """
     _byte_size: int = 0
     _name: str = None # type: ignore [assignment]
     _usage: int = None # type: ignore [assignment]

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

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

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AdminInteractReplyServerPacket(Packet):
+    """
+    Incoming admin message
+    """
     _byte_size: int = 0
     _message_type: AdminMessageType = None # type: ignore [assignment]
     _message_type_data: 'AdminInteractReplyServerPacket.MessageTypeData' = None

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AdminInteractTellServerPacket(Packet):
+    """
+    Admin character info lookup
+    """
     _byte_size: int = 0
     _name: str = None # type: ignore [assignment]
     _usage: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ArenaAcceptServerPacket(Packet):
+    """
+    Arena win message
+    """
     _byte_size: int = 0
     _winner_name: str = None # type: ignore [assignment]
     _kills_count: int = None # type: ignore [assignment]
@@ -120,7 +123,6 @@ class ArenaAcceptServerPacket(Packet):
         if data._victim_name is None:
             raise SerializationError("victim_name must be provided.")
         writer.add_string(data._victim_name)
-        writer.add_byte(0xFF)
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ArenaAcceptServerPacket":
@@ -145,7 +147,6 @@ class ArenaAcceptServerPacket(Packet):
             data._killer_name = reader.get_string()
             reader.next_chunk()
             data._victim_name = reader.get_string()
-            reader.next_chunk()
             reader.chunked_reading_mode = False
             data._byte_size = reader.position - reader_start_position
             return data

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ArenaDropServerPacket(Packet):
+    """
+    "Arena is blocked" message
+    """
     _byte_size: int = 0
 
     @property

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ArenaSpecServerPacket(Packet):
+    """
+    Arena kill message
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _direction: Direction = None # type: ignore [assignment]
@@ -142,7 +145,6 @@ class ArenaSpecServerPacket(Packet):
         if data._victim_name is None:
             raise SerializationError("victim_name must be provided.")
         writer.add_string(data._victim_name)
-        writer.add_byte(0xFF)
 
     @staticmethod
     def deserialize(reader: EoReader) -> "ArenaSpecServerPacket":
@@ -169,7 +171,6 @@ class ArenaSpecServerPacket(Packet):
             data._killer_name = reader.get_string()
             reader.next_chunk()
             data._victim_name = reader.get_string()
-            reader.next_chunk()
             reader.chunked_reading_mode = False
             data._byte_size = reader.position - reader_start_position
             return data

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ArenaUseServerPacket(Packet):
+    """
+    Arena start message
+    """
     _byte_size: int = 0
     _players_count: int = None # type: ignore [assignment]
 

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AttackErrorServerPacket(Packet):
+    """
+    Show flood protection message (vestigial)
+    """
     _byte_size: int = 0
 
     @property

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

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

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AvatarAdminServerPacket(Packet):
+    """
+    Nearby player hit by a damage spell from a player
+    """
     _byte_size: int = 0
     _caster_id: int = None # type: ignore [assignment]
     _victim_id: int = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AvatarAgreeServerPacket(Packet):
+    """
+    Nearby player changed appearance
+    """
     _byte_size: int = 0
     _change: AvatarChange = None # type: ignore [assignment]
 

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AvatarRemoveServerPacket(Packet):
+    """
+    Nearby player has disappeared from view
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _warp_effect: Optional[WarpEffect] = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class AvatarReplyServerPacket(Packet):
+    """
+    Nearby player hit by another player
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _victim_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BankOpenServerPacket(Packet):
+    """
+    Open banker NPC interface
+    """
     _byte_size: int = 0
     _gold_bank: int = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BankReplyServerPacket(Packet):
+    """
+    Update gold counts after deposit/withdraw
+    """
     _byte_size: int = 0
     _gold_inventory: int = None # type: ignore [assignment]
     _gold_bank: int = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BarberAgreeServerPacket(Packet):
+    """
+    Purchasing a new hair style
+    """
     _byte_size: int = 0
     _gold_amount: int = None # type: ignore [assignment]
     _change: AvatarChange = None # type: ignore [assignment]

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

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

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BoardOpenServerPacket(Packet):
+    """
+    Reply to opening a town board
+    """
     _byte_size: int = 0
     _board_id: int = None # type: ignore [assignment]
     _posts_count: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BoardPlayerServerPacket(Packet):
+    """
+    Reply to reading a post on a town board
+    """
     _byte_size: int = 0
     _post_id: int = None # type: ignore [assignment]
     _post_body: str = None # type: ignore [assignment]

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class BookReplyServerPacket(Packet):
+    """
+    Reply to requesting a book
+    """
     _byte_size: int = 0
     _details: CharacterDetails = None # type: ignore [assignment]
     _icon: CharacterIcon = None # type: ignore [assignment]

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CastAcceptServerPacket(Packet):
+    """
+    Nearby NPC killed by player spell and you leveled up
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
     _npc_killed_data: NpcKilledData = None # type: ignore [assignment]

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

@@ -15,6 +15,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CastReplyServerPacket(Packet):
+    """
+    Nearby NPC hit by a spell from a player
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
     _caster_id: int = None # type: ignore [assignment]

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CastSpecServerPacket(Packet):
+    """
+    Nearby NPC killed by player spell
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
     _npc_killed_data: NpcKilledData = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChairCloseServerPacket(Packet):
+    """
+    Your character standing up from a chair
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _coords: Coords = None # type: ignore [assignment]

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChairPlayerServerPacket(Packet):
+    """
+    Nearby player sitting on a chair
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _coords: Coords = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChairRemoveServerPacket(Packet):
+    """
+    Nearby player standing up from a chair
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _coords: Coords = None # type: ignore [assignment]

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChairReplyServerPacket(Packet):
+    """
+    Your character sitting on a chair
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
     _coords: Coords = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class CharacterPlayerServerPacket(Packet):
+    """
+    Reply to client request to delete a character from the account (Character_Take)
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _character_id: int = None # type: ignore [assignment]

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

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

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestAgreeServerPacket(Packet):
+    """
+    Chest contents updating
+    """
     _byte_size: int = 0
     _items: list[ThreeItem] = None # type: ignore [assignment]
 

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

@@ -12,6 +12,10 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestCloseServerPacket(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.
+    """
     _byte_size: int = 0
     _key: Optional[int] = None # type: ignore [assignment]
 

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

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

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestOpenServerPacket(Packet):
+    """
+    Reply to opening a chest
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
     _items: list[ThreeItem] = None # type: ignore [assignment]

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ChestReplyServerPacket(Packet):
+    """
+    Reply to placing an item in to a chest
+    """
     _byte_size: int = 0
     _added_item_id: int = None # type: ignore [assignment]
     _remaining_amount: int = None # type: ignore [assignment]