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

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

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

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

@@ -12,6 +12,10 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class InitInitClientPacket(Packet):
+    """
+    Connection initialization request.
+    This packet is unencrypted.
+    """
     _byte_size: int = 0
     _challenge: int = None # type: ignore [assignment]
     _version: Version = None # type: ignore [assignment]

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ItemDropClientPacket(Packet):
+    """
+    Dropping items on the ground
+    """
     _byte_size: int = 0
     _item: ThreeItem = None # type: ignore [assignment]
     _coords: ByteCoords = None # type: ignore [assignment]

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

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

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

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

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

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

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

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

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxOpenClientPacket(Packet):
+    """
+    Opening the jukebox listing
+    """
     _byte_size: int = 0
     _coords: Coords = None # type: ignore [assignment]
 

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class JukeboxUseClientPacket(Packet):
+    """
+    Playing a note with the bard skill
+    """
     _byte_size: int = 0
     _instrument_id: int = None # type: ignore [assignment]
     _note_id: int = None # type: ignore [assignment]

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

@@ -13,6 +13,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerAddClientPacket(Packet):
+    """
+    Adding an item to a bank locker
+    """
     _byte_size: int = 0
     _locker_coords: Coords = None # type: ignore [assignment]
     _deposit_item: ThreeItem = None # type: ignore [assignment]

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerBuyClientPacket(Packet):
+    """
+    Buying a locker space upgrade from a banker NPC
+    """
     _byte_size: int = 0
 
     @property

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

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

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LockerTakeClientPacket(Packet):
+    """
+    Taking an item from a bank locker
+    """
     _byte_size: int = 0
     _locker_coords: Coords = None # type: ignore [assignment]
     _take_item_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class LoginRequestClientPacket(Packet):
+    """
+    Login request
+    """
     _byte_size: int = 0
     _username: str = None # type: ignore [assignment]
     _password: str = None # type: ignore [assignment]

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

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

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class MarriageRequestClientPacket(Packet):
+    """
+    Requesting marriage approval
+    """
     _byte_size: int = 0
     _request_type: MarriageRequestType = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class MessagePingClientPacket(Packet):
+    """
+    #ping command request
+    """
     _byte_size: int = 0
 
     @property

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class NpcRangeRequestClientPacket(Packet):
+    """
+    Requesting info about nearby NPCs
+    """
     _byte_size: int = 0
     _npc_indexes_length: int = None # type: ignore [assignment]
     _npc_indexes: list[int] = None # type: ignore [assignment]

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

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

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

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

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PaperdollRequestClientPacket(Packet):
+    """
+    Request for a player's paperdoll
+    """
     _byte_size: int = 0
     _player_id: int = None # type: ignore [assignment]
 

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PartyAcceptClientPacket(Packet):
+    """
+    Accept party invite / join request
+    """
     _byte_size: int = 0
     _request_type: PartyRequestType = None # type: ignore [assignment]
     _inviter_player_id: int = None # type: ignore [assignment]

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

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

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PartyRequestClientPacket(Packet):
+    """
+    Send party invite / join request
+    """
     _byte_size: int = 0
     _request_type: PartyRequestType = None # type: ignore [assignment]
     _player_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PartyTakeClientPacket(Packet):
+    """
+    Request updated party info
+    """
     _byte_size: int = 0
     _members_count: int = None # type: ignore [assignment]
 

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PlayerRangeRequestClientPacket(Packet):
+    """
+    Requesting info about nearby players
+    """
     _byte_size: int = 0
     _player_ids: list[int] = None # type: ignore [assignment]
 

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PlayersAcceptClientPacket(Packet):
+    """
+    #find command request
+    """
     _byte_size: int = 0
     _name: str = None # type: ignore [assignment]
 

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PlayersListClientPacket(Packet):
+    """
+    Requesting a list of online friends
+    """
     _byte_size: int = 0
 
     @property

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PlayersRequestClientPacket(Packet):
+    """
+    Requesting a list of online players
+    """
     _byte_size: int = 0
 
     @property

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

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

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PriestOpenClientPacket(Packet):
+    """
+    Talking to a priest NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PriestRequestClientPacket(Packet):
+    """
+    Requesting marriage at a priest
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _name: str = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class PriestUseClientPacket(Packet):
+    """
+    Saying "I do" at a wedding
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
 

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

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

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class QuestListClientPacket(Packet):
+    """
+    Quest history / progress request
+    """
     _byte_size: int = 0
     _page: QuestPage = None # type: ignore [assignment]
 

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class QuestUseClientPacket(Packet):
+    """
+    Talking to a quest NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
     _quest_id: int = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class RangeRequestClientPacket(Packet):
+    """
+    Requesting info about nearby players and NPCs
+    """
     _byte_size: int = 0
     _player_ids: list[int] = None # type: ignore [assignment]
     _npc_indexes: list[int] = None # type: ignore [assignment]

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

@@ -10,6 +10,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class RefreshRequestClientPacket(Packet):
+    """
+    Requesting new info about nearby objects
+    """
     _byte_size: int = 0
 
     @property

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ShopBuyClientPacket(Packet):
+    """
+    Purchasing an item from a shop
+    """
     _byte_size: int = 0
     _buy_item: Item = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ShopCreateClientPacket(Packet):
+    """
+    Crafting an item from a shop
+    """
     _byte_size: int = 0
     _craft_item_id: int = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ShopOpenClientPacket(Packet):
+    """
+    Talking to a shop NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class ShopSellClientPacket(Packet):
+    """
+    Selling an item to a shop
+    """
     _byte_size: int = 0
     _sell_item: Item = None # type: ignore [assignment]
     _session_id: int = None # type: ignore [assignment]

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class SitRequestClientPacket(Packet):
+    """
+    Sit/stand request
+    """
     _byte_size: int = 0
     _sit_action: SitAction = None # type: ignore [assignment]
     _sit_action_data: 'SitRequestClientPacket.SitActionData' = None

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class SpellRequestClientPacket(Packet):
+    """
+    Begin spell chanting
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
     _timestamp: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class SpellTargetGroupClientPacket(Packet):
+    """
+    Group spell cast
+    """
     _byte_size: int = 0
     _spell_id: int = None # type: ignore [assignment]
     _timestamp: int = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class SpellTargetOtherClientPacket(Packet):
+    """
+    Targeted spell cast
+    """
     _byte_size: int = 0
     _target_type: SpellTargetType = None # type: ignore [assignment]
     _previous_timestamp: int = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class SpellTargetSelfClientPacket(Packet):
+    """
+    Self-targeted spell cast
+    """
     _byte_size: int = 0
     _direction: Direction = None # type: ignore [assignment]
     _spell_id: int = None # type: ignore [assignment]

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

@@ -12,6 +12,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class SpellUseClientPacket(Packet):
+    """
+    Raise arm to cast a spell (vestigial)
+    """
     _byte_size: int = 0
     _direction: Direction = None # type: ignore [assignment]
 

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

@@ -14,6 +14,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillAddClientPacket(Packet):
+    """
+    Spending a stat point on a stat or skill
+    """
     _byte_size: int = 0
     _action_type: TrainType = None # type: ignore [assignment]
     _action_type_data: 'StatSkillAddClientPacket.ActionTypeData' = None

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillJunkClientPacket(Packet):
+    """
+    Resetting stats at a skill master
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
 

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillOpenClientPacket(Packet):
+    """
+    Talking to a skill master NPC
+    """
     _byte_size: int = 0
     _npc_index: int = None # type: ignore [assignment]
 

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillRemoveClientPacket(Packet):
+    """
+    Forgetting a skill at a skill master NPC
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _spell_id: int = None # type: ignore [assignment]

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

@@ -11,6 +11,9 @@ from .....data.eo_writer import EoWriter
 from .....data.eo_reader import EoReader
 
 class StatSkillTakeClientPacket(Packet):
+    """
+    Learning a skill from a skill master NPC
+    """
     _byte_size: int = 0
     _session_id: int = None # type: ignore [assignment]
     _spell_id: int = None # type: ignore [assignment]

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

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

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

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

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

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

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

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

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

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