eolib 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

eolib/protocol/_generated/pub/server/talk_message_record.py

@@ -0,0 +1,90 @@
+# Generated from the eo-protocol XML specification.
+#
+# This file should not be modified.
+# Changes will be lost when code is regenerated.
+
+from ....serialization_error import SerializationError
+from .....data.eo_writer import EoWriter
+from .....data.eo_reader import EoReader
+
+class TalkMessageRecord:
+    """
+    Record of a message that an NPC can say
+    """
+    _byte_size: int = 0
+    _message_length: int = None # type: ignore [assignment]
+    _message: str = None # type: ignore [assignment]
+
+    @property
+    def byte_size(self) -> int:
+        """
+        Returns the size of the data that this was deserialized from.
+
+        Returns:
+            int: The size of the data that this was deserialized from.
+        """
+        return self._byte_size
+
+    @property
+    def message(self) -> str:
+        """
+        Note:
+          - Length must be 252 or less.
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message: str) -> None:
+        """
+        Note:
+          - Length must be 252 or less.
+        """
+        self._message = message
+        self._message_length = len(self._message)
+
+    @staticmethod
+    def serialize(writer: EoWriter, data: "TalkMessageRecord") -> None:
+        """
+        Serializes an instance of `TalkMessageRecord` to the provided `EoWriter`.
+
+        Args:
+            writer (EoWriter): The writer that the data will be serialized to.
+            data (TalkMessageRecord): The data to serialize.
+        """
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._message_length is None:
+                raise SerializationError("message_length must be provided.")
+            writer.add_char(data._message_length)
+            if data._message is None:
+                raise SerializationError("message must be provided.")
+            if len(data._message) > 252:
+                raise SerializationError(f"Expected length of message to be 252 or less, got {len(data._message)}.")
+            writer.add_fixed_string(data._message, data._message_length, False)
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
+
+    @staticmethod
+    def deserialize(reader: EoReader) -> "TalkMessageRecord":
+        """
+        Deserializes an instance of `TalkMessageRecord` from the provided `EoReader`.
+
+        Args:
+            reader (EoReader): The writer that the data will be serialized to.
+
+        Returns:
+            TalkMessageRecord: The data to serialize.
+        """
+        data: TalkMessageRecord = TalkMessageRecord()
+        old_chunked_reading_mode: bool = reader.chunked_reading_mode
+        try:
+            reader_start_position: int = reader.position
+            data._message_length = reader.get_char()
+            data._message = reader.get_fixed_string(data._message_length, False)
+            data._byte_size = reader.position - reader_start_position
+            return data
+        finally:
+            reader.chunked_reading_mode = old_chunked_reading_mode
+
+    def __repr__(self):
+        return f"TalkMessageRecord(byte_size={repr(self._byte_size)}, message={repr(self._message)})"

eolib/protocol/_generated/pub/server/talk_record.py

@@ -0,0 +1,145 @@
+# Generated from the eo-protocol XML specification.
+#
+# This file should not be modified.
+# Changes will be lost when code is regenerated.
+
+from __future__ import annotations
+from .talk_message_record import TalkMessageRecord
+from ....serialization_error import SerializationError
+from .....data.eo_writer import EoWriter
+from .....data.eo_reader import EoReader
+
+class TalkRecord:
+    """
+    Record of Talk data in an Endless Talk File
+    """
+    _byte_size: int = 0
+    _npc_id: int = None # type: ignore [assignment]
+    _rate: int = None # type: ignore [assignment]
+    _messages_count: int = None # type: ignore [assignment]
+    _messages: list[TalkMessageRecord] = None # type: ignore [assignment]
+
+    @property
+    def byte_size(self) -> int:
+        """
+        Returns the size of the data that this was deserialized from.
+
+        Returns:
+            int: The size of the data that this was deserialized from.
+        """
+        return self._byte_size
+
+    @property
+    def npc_id(self) -> int:
+        """
+        ID of the NPC that will talk
+
+        Note:
+          - Value range is 0-64008.
+        """
+        return self._npc_id
+
+    @npc_id.setter
+    def npc_id(self, npc_id: int) -> None:
+        """
+        ID of the NPC that will talk
+
+        Note:
+          - Value range is 0-64008.
+        """
+        self._npc_id = npc_id
+
+    @property
+    def rate(self) -> int:
+        """
+        Chance that the NPC will talk (0-100)
+
+        Note:
+          - Value range is 0-252.
+        """
+        return self._rate
+
+    @rate.setter
+    def rate(self, rate: int) -> None:
+        """
+        Chance that the NPC will talk (0-100)
+
+        Note:
+          - Value range is 0-252.
+        """
+        self._rate = rate
+
+    @property
+    def messages(self) -> list[TalkMessageRecord]:
+        """
+        Note:
+          - Length must be 252 or less.
+        """
+        return self._messages
+
+    @messages.setter
+    def messages(self, messages: list[TalkMessageRecord]) -> None:
+        """
+        Note:
+          - Length must be 252 or less.
+        """
+        self._messages = messages
+        self._messages_count = len(self._messages)
+
+    @staticmethod
+    def serialize(writer: EoWriter, data: "TalkRecord") -> None:
+        """
+        Serializes an instance of `TalkRecord` to the provided `EoWriter`.
+
+        Args:
+            writer (EoWriter): The writer that the data will be serialized to.
+            data (TalkRecord): The data to serialize.
+        """
+        old_string_sanitization_mode: bool = writer.string_sanitization_mode
+        try:
+            if data._npc_id is None:
+                raise SerializationError("npc_id must be provided.")
+            writer.add_short(data._npc_id)
+            if data._rate is None:
+                raise SerializationError("rate must be provided.")
+            writer.add_char(data._rate)
+            if data._messages_count is None:
+                raise SerializationError("messages_count must be provided.")
+            writer.add_char(data._messages_count)
+            if data._messages is None:
+                raise SerializationError("messages must be provided.")
+            if len(data._messages) > 252:
+                raise SerializationError(f"Expected length of messages to be 252 or less, got {len(data._messages)}.")
+            for i in range(data._messages_count):
+                TalkMessageRecord.serialize(writer, data._messages[i])
+        finally:
+            writer.string_sanitization_mode = old_string_sanitization_mode
+
+    @staticmethod
+    def deserialize(reader: EoReader) -> "TalkRecord":
+        """
+        Deserializes an instance of `TalkRecord` from the provided `EoReader`.
+
+        Args:
+            reader (EoReader): The writer that the data will be serialized to.
+
+        Returns:
+            TalkRecord: The data to serialize.
+        """
+        data: TalkRecord = TalkRecord()
+        old_chunked_reading_mode: bool = reader.chunked_reading_mode
+        try:
+            reader_start_position: int = reader.position
+            data._npc_id = reader.get_short()
+            data._rate = reader.get_char()
+            data._messages_count = reader.get_char()
+            data._messages = []
+            for i in range(data._messages_count):
+                data._messages.append(TalkMessageRecord.deserialize(reader))
+            data._byte_size = reader.position - reader_start_position
+            return data
+        finally:
+            reader.chunked_reading_mode = old_chunked_reading_mode
+
+    def __repr__(self):
+        return f"TalkRecord(byte_size={repr(self._byte_size)}, npc_id={repr(self._npc_id)}, rate={repr(self._rate)}, messages={repr(self._messages)})"

eolib/protocol/protocol_enum_meta.py

@@ -8,9 +8,7 @@ class ProtocolEnumMeta(EnumMeta):
                 value, names=names, module=module, qualname=qualname, type=type, start=start
             )
         try:
-            return super().__call__(
-                value, names=names, module=module, qualname=qualname, type=type, start=start
-            )
+            return super().__call__(value, module=module, qualname=qualname, type=type, start=start)
         except ValueError:
             unrecognized = int.__new__(cls, value)
             unrecognized._name_ = f"Unrecognized({int(value)})"

eolib/protocol/pub/server/__init__.py

@@ -0,0 +1,8 @@
+"""
+EO server pub file data structures.
+
+See Also:
+  - [eolib.protocol._generated.pub.server][]
+"""
+
+from ..._generated.pub.server import *

{eolib-1.1.0.dist-info → eolib-1.2.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: eolib
-Version: 1.1.0
+Version: 1.2.0
 Summary: Core library for writing applications related to Endless Online.
-Project-URL: Documentation, https://github.com/Cirras/eolib#readme
-Project-URL: Issues, https://github.com/Cirras/eolib/issues
-Project-URL: Source, https://github.com/Cirras/eolib
+Project-URL: Documentation, https://cirras.github.io/eolib-python
+Project-URL: Issues, https://github.com/Cirras/eolib-python/issues
+Project-URL: Source, https://github.com/Cirras/eolib-python
 Author-email: Jonah Jeleniewski <cirrasbu@hotmail.com>
 License-Expression: MIT
 License-File: LICENSE.txt
@@ -16,6 +16,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Games/Entertainment
@@ -79,4 +81,4 @@ Utilities:
 | `hatch run docs:build`      | Build documentation using `mkdocs`                     |
 | `hatch run docs:serve`      | Build and serve documentation using `mkdocs`           |
 | `hatch run docs:deploy`     | Build and deploy documentation using `mkdocs` & `mike` |
-| `hatch run prepare:release` | Prepare and tag a new release                          |
+| `hatch run release:prepare` | Prepare and tag a new release                          |