sonolus.py 0.5.1__tar.gz → 0.5.2__tar.gz

{sonolus_py-0.5.1 → sonolus_py-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sonolus.py
-Version: 0.5.1
+Version: 0.5.2
 Summary: Sonolus engine development in Python
 License-File: LICENSE
 Requires-Python: >=3.12

{sonolus_py-0.5.1 → sonolus_py-0.5.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sonolus.py"
-version = "0.5.1"
+version = "0.5.2"
 description = "Sonolus engine development in Python"
 readme = "README.md"
 requires-python = ">=3.12"

{sonolus_py-0.5.1 → sonolus_py-0.5.2}/sonolus/script/archetype.py

@@ -459,7 +459,7 @@ class _BaseArchetype:
     still be the id of `A`.
     """
 
-    key: int = -1
+    key: int | float = -1
     """An optional key for the archetype.
 
     May be useful to identify an archetype in an inheritance hierarchy without needing to check id.
@@ -467,7 +467,7 @@ class _BaseArchetype:
     If accessed on an entity, always returns the runtime key of the entity, even if it doesn't match the type
     that was used to access it.
 
-    E.g. if an entity of archetype `A` is accessed via [`EntityRef[B]`][sonolus.script.archetype.EntityRef], the key 
+    E.g. if an entity of archetype `A` is accessed via [`EntityRef[B]`][sonolus.script.archetype.EntityRef], the key
     will still be the key of `A`.
     """
 
@@ -751,8 +751,17 @@ class _BaseArchetype:
     def derive[T](cls: type[T], name: str, is_scored: bool, key: int | float | None = None) -> type[T]:
         """Derive a new archetype class from this archetype.
 
+        Roughly equivalent to returning:
+        ```python
+        class Derived(cls):
+            name = <name>
+            is_scored = <is_scored>
+            key = <key>  # Only set if key is not None
+        ```
+
         This is used to create a new archetype with the same fields and callbacks, but with a different name and
-        whether it is scored.
+        whether it is scored. Compared to manually subclassing, this method also enables faster compilation when
+        the same base archetype has multiple derived archetypes by compiling callbacks only once for the base archetype.
 
         Args:
             name: The name of the new archetype.
@@ -943,6 +952,26 @@ class PlayArchetype(_BaseArchetype):
             case _:
                 raise RuntimeError("Result is only accessible from the entity itself")
 
+    @classmethod
+    def update_life(
+        cls,
+        perfect_increment: int | None = None,
+        great_increment: int | None = None,
+        good_increment: int | None = None,
+        miss_increment: int | None = None,
+    ):
+        """Update the life of this archetype.
+
+        Values default to 0.
+
+        Args:
+            perfect_increment: The increment for perfect life.
+            great_increment: The increment for great life.
+            good_increment: The increment for good life.
+            miss_increment: The increment for miss life.
+        """
+        archetype_life_of(cls).update(perfect_increment, great_increment, good_increment, miss_increment)
+
 
 class WatchArchetype(_BaseArchetype):
     """Base class for watch mode archetypes.
@@ -1061,6 +1090,26 @@ class WatchArchetype(_BaseArchetype):
         if cls._exported_fields_:
             raise RuntimeError("Watch archetypes cannot have exported fields")
 
+    @classmethod
+    def update_life(
+        cls,
+        perfect_increment: int | None = None,
+        great_increment: int | None = None,
+        good_increment: int | None = None,
+        miss_increment: int | None = None,
+    ):
+        """Update the life of this archetype.
+
+        Values default to 0.
+
+        Args:
+            perfect_increment: The increment for perfect life.
+            great_increment: The increment for great life.
+            good_increment: The increment for good life.
+            miss_increment: The increment for miss life.
+        """
+        archetype_life_of(cls).update(perfect_increment, great_increment, good_increment, miss_increment)
+
 
 class PreviewArchetype(_BaseArchetype):
     """Base class for preview mode archetypes.
@@ -1301,3 +1350,7 @@ class StandardArchetypeName(StrEnum):
 
     TIMESCALE_CHANGE = "#TIMESCALE_CHANGE"
     """Timescale change marker"""
+
+
+type AnyArchetype = PlayArchetype | WatchArchetype | PreviewArchetype
+"""Union of all archetype types."""

{sonolus_py-0.5.1 → sonolus_py-0.5.2}/uv.lock

@@ -694,7 +694,7 @@ wheels = [
 
 [[package]]
 name = "sonolus-py"
-version = "0.5.1"
+version = "0.5.2"
 source = { editable = "." }
 
 [package.dev-dependencies]