sonolus.py 0.6.4__py3-none-any.whl → 0.6.5__py3-none-any.whl

sonolus/script/archetype.py

@@ -1,4 +1,3 @@
-# type: ignore
 from __future__ import annotations
 
 import inspect
@@ -120,7 +119,7 @@ class _ArchetypeField(SonolusDescriptor):
         if ctx():
             return result._get_readonly_()
         else:
-            return result._as_py_()
+            return result._as_py_()  # type: ignore
 
     def __set__(self, instance: _BaseArchetype, value):
         if instance is None:
@@ -362,37 +361,6 @@ _annotation_defaults: dict[Callable, _ArchetypeFieldInfo] = {
 }
 
 
-class StandardImport:
-    """Standard import annotations for Archetype fields.
-
-    Usage:
-        ```python
-        class MyArchetype(WatchArchetype):
-            judgment: StandardImport.JUDGMENT
-        ```
-    """
-
-    BEAT = Annotated[float, imported(name="#BEAT")]
-    """The beat of the entity."""
-
-    BPM = Annotated[float, imported(name="#BPM")]
-    """The bpm, for bpm change markers."""
-
-    TIMESCALE = Annotated[float, imported(name="#TIMESCALE")]
-    """The timescale, for timescale change markers."""
-
-    JUDGMENT = Annotated[int, imported(name="#JUDGMENT")]
-    """The judgment of the entity.
-
-    Automatically supported in watch mode for archetypes with a corresponding scored play mode archetype.
-    """
-    ACCURACY = Annotated[float, imported(name="#ACCURACY")]
-    """The accuracy of the entity.
-
-    Automatically supported in watch mode for archetypes with a corresponding scored play mode archetype.
-    """
-
-
 def callback[T: Callable](*, order: int = 0) -> Callable[[T], T]:
     """Annotate a callback with its order.
 
@@ -844,12 +812,14 @@ class PlayArchetype(_BaseArchetype):
 
         Runs when the level is loaded after [`preprocess`][sonolus.script.archetype.PlayArchetype.preprocess].
         """
+        return 0.0
 
     def should_spawn(self) -> bool:
         """Return whether the entity should be spawned.
 
         Runs each frame while the entity is the first entity in the spawn queue.
         """
+        return True
 
     def initialize(self):
         """Initialize this entity.
@@ -997,9 +967,11 @@ class WatchArchetype(_BaseArchetype):
 
     def spawn_time(self) -> float:
         """Return the spawn time of the entity."""
+        return 0.0
 
     def despawn_time(self) -> float:
         """Return the despawn time of the entity."""
+        return 0.0
 
     def initialize(self):
         """Initialize this entity.
@@ -1136,16 +1108,16 @@ def get_archetype_by_name(name: str) -> AnyArchetype:
     """Return the archetype with the given name in the current mode."""
     if not ctx():
         raise RuntimeError("Archetypes by name are only available during compilation.")
-    name = validate_value(name)
-    if not name._is_py_():
+    name = validate_value(name)  # type: ignore
+    if not name._is_py_():  # type: ignore
         raise TypeError(f"Invalid name: '{name}'")
-    name = name._as_py_()
+    name = name._as_py_()  # type: ignore
     if not isinstance(name, str):
         raise TypeError(f"Invalid name: '{name}'")
     archetypes_by_name = ctx().global_state.archetypes_by_name
     if name not in archetypes_by_name:
         raise KeyError(f"Unknown archetype: '{name}'")
-    return archetypes_by_name[name]
+    return archetypes_by_name[name]  # type: ignore
 
 
 @meta_fn
@@ -1315,6 +1287,84 @@ class StandardArchetypeName(StrEnum):
     TIMESCALE_CHANGE = "#TIMESCALE_CHANGE"
     """Timescale change marker"""
 
+    TIMESCALE_GROUP = "#TIMESCALE_GROUP"
+    """Entity referenced by the timescale changes in a group"""
+
 
 type AnyArchetype = PlayArchetype | WatchArchetype | PreviewArchetype
 """Union of all archetype types."""
+
+
+class StandardImportName:
+    """Standard import names for Archetype fields.
+
+    Usage:
+        ```python
+        class MyArchetype(WatchArchetype):
+            judgment: int = imported(name=StandardImportName.JUDGMENT)
+        ```
+    """
+
+    BEAT = "#BEAT"
+    """The beat of the entity."""
+
+    BPM = "#BPM"
+    """The bpm, for bpm change markers."""
+
+    TIMESCALE = "#TIMESCALE"
+    """The timescale, for timescale change markers."""
+
+    TIMESCALE_SKIP = "#TIMESCALE_SKIP"
+    """The scaled time to skip, for timescale change markers."""
+
+    TIMESCALE_GROUP = "#TIMESCALE_GROUP"
+    """The timescale group, for timescale change markers."""
+
+    JUDGMENT = "#JUDGMENT"
+    """The judgment of the entity.
+
+    Automatically set in watch mode for archetypes with a corresponding scored play mode archetype.
+    """
+
+    ACCURACY = "#ACCURACY"
+    """The accuracy of the entity.
+
+    Automatically set in watch mode for archetypes with a corresponding scored play mode archetype.
+    """
+
+
+class StandardImport:
+    """Standard import annotations for Archetype fields.
+
+    Usage:
+        ```python
+        class MyArchetype(WatchArchetype):
+            judgment: StandardImport.JUDGMENT
+        ```
+    """
+
+    BEAT = Annotated[float, imported(name=StandardImportName.BEAT)]
+    """The beat of the entity."""
+
+    BPM = Annotated[float, imported(name=StandardImportName.BPM)]
+    """The bpm, for bpm change markers."""
+
+    TIMESCALE = Annotated[float, imported(name=StandardImportName.TIMESCALE)]
+    """The timescale, for timescale change markers."""
+
+    TIMESCALE_SKIP = Annotated[float, imported(name=StandardImportName.TIMESCALE_SKIP)]
+    """The scaled time to skip, for timescale change markers."""
+
+    TIMESCALE_GROUP = Annotated[EntityRef[Any], imported(name=StandardImportName.TIMESCALE_GROUP)]
+    """The timescale group, for timescale change markers."""
+
+    JUDGMENT = Annotated[int, imported(name=StandardImportName.JUDGMENT)]
+    """The judgment of the entity.
+
+    Automatically set in watch mode for archetypes with a corresponding scored play mode archetype.
+    """
+    ACCURACY = Annotated[float, imported(name=StandardImportName.ACCURACY)]
+    """The accuracy of the entity.
+
+    Automatically set in watch mode for archetypes with a corresponding scored play mode archetype.
+    """

{sonolus_py-0.6.4.dist-info → sonolus_py-0.6.5.dist-info}/METADATA

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

{sonolus_py-0.6.4.dist-info → sonolus_py-0.6.5.dist-info}/RECORD

@@ -34,7 +34,7 @@ sonolus/build/level.py,sha256=yXsQtnabkJK0vuVmZ_Wr1jx37jFLgInCS7lTlXjkv9Q,706
 sonolus/build/node.py,sha256=gnX71RYDUOK_gYMpinQi-bLWO4csqcfiG5gFmhxzSec,1330
 sonolus/build/project.py,sha256=eHh4ioOjaFtt26bcefUuDZhMhFw8NXnjRTYPiEInQV8,6505
 sonolus/script/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sonolus/script/archetype.py,sha256=sgPAbYD1jEPnQf2LhRaZn_ySVyzaogNEqGU-69teyIs,47331
+sonolus/script/archetype.py,sha256=HBg2cS6ZDy0zBbHH8Ieke5QOWR71PwFCmtJie8zDXiI,48957
 sonolus/script/array.py,sha256=9uOUHZIDMyMT9q3APcXJWXWt97yG-AZoRlxwrvSY6SU,12367
 sonolus/script/array_like.py,sha256=hUDdDaP306kflVv9YomdHIMXogrVjxsBXCrLvB9QpuE,9681
 sonolus/script/bucket.py,sha256=SNqnfLGpnO_u-3LFFazdgzNk332OdDUIlmZHsuoVZuE,7674
@@ -86,8 +86,8 @@ sonolus/script/internal/simulation_context.py,sha256=LGxLTvxbqBIhoe1R-SfwGajNIDw
 sonolus/script/internal/transient.py,sha256=y2AWABqF1aoaP6H4_2u4MMpNioC4OsZQCtPyNI0txqo,1634
 sonolus/script/internal/tuple_impl.py,sha256=DPNdmmRmupU8Ah4_XKq6-PdT336l4nt15_uCJKQGkkk,3587
 sonolus/script/internal/value.py,sha256=OngrCdmY_h6mV2Zgwqhuo4eYFad0kTk6263UAxctZcY,6963
-sonolus_py-0.6.4.dist-info/METADATA,sha256=0snzpKah3Osilgz5MfftDE9jFV6ydvWIJ4YroK54eBQ,302
-sonolus_py-0.6.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sonolus_py-0.6.4.dist-info/entry_points.txt,sha256=oTYspY_b7SA8TptEMTDxh4-Aj-ZVPnYC9f1lqH6s9G4,54
-sonolus_py-0.6.4.dist-info/licenses/LICENSE,sha256=JEKpqVhQYfEc7zg3Mj462sKbKYmO1K7WmvX1qvg9IJk,1067
-sonolus_py-0.6.4.dist-info/RECORD,,
+sonolus_py-0.6.5.dist-info/METADATA,sha256=cU1Ruyl2Nt__z5kalCBRw6jvSiIyq-WcShZvUyM8KgY,302
+sonolus_py-0.6.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sonolus_py-0.6.5.dist-info/entry_points.txt,sha256=oTYspY_b7SA8TptEMTDxh4-Aj-ZVPnYC9f1lqH6s9G4,54
+sonolus_py-0.6.5.dist-info/licenses/LICENSE,sha256=JEKpqVhQYfEc7zg3Mj462sKbKYmO1K7WmvX1qvg9IJk,1067
+sonolus_py-0.6.5.dist-info/RECORD,,