sonolus.py 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

sonolus/script/engine.py

@@ -4,7 +4,7 @@ from collections.abc import Callable
 from typing import Any
 
 from sonolus.build.collection import Asset
-from sonolus.script.archetype import BaseArchetype, PlayArchetype, PreviewArchetype, WatchArchetype
+from sonolus.script.archetype import PlayArchetype, PreviewArchetype, WatchArchetype, _BaseArchetype
 from sonolus.script.bucket import Buckets, EmptyBuckets
 from sonolus.script.effect import Effects, EmptyEffects
 from sonolus.script.instruction import (
@@ -20,6 +20,21 @@ from sonolus.script.ui import UiConfig
 
 
 class Engine:
+    """A Sonolus.py engine.
+
+    Args:
+        name: The name of the engine.
+        title: The title of the engine.
+        subtitle: The subtitle of the engine.
+        author: The author of the engine.
+        skin: The default skin for the engine.
+        background: The default background for the engine.
+        effect: The default effect for the engine.
+        particle: The default particle for the engine.
+        thumbnail: The thumbnail for the engine.
+        data: The engine's modes and configurations.
+    """
+
     version = 12
 
     def __init__(
@@ -53,10 +68,20 @@ def default_callback() -> Any:
 
 
 class PlayMode:
+    """A play mode definition.
+
+    Args:
+        archetypes: A list of play archetypes.
+        skin: The skin for the play mode.
+        effects: The effects for the play mode.
+        particles: The particles for the play mode.
+        buckets: The buckets for the play mode.
+    """
+
     def __init__(
         self,
         *,
-        archetypes: list[type[BaseArchetype]] | None = None,
+        archetypes: list[type[_BaseArchetype]] | None = None,
         skin: Skin = EmptySkin,
         effects: Effects = EmptyEffects,
         particles: Particles = EmptyParticles,
@@ -74,10 +99,21 @@ class PlayMode:
 
 
 class WatchMode:
+    """A watch mode definition.
+
+    Args:
+        archetypes: A list of watch archetypes.
+        skin: The skin for the watch mode.
+        effects: The effects for the watch mode.
+        particles: The particles for the watch mode.
+        buckets: The buckets for the watch mode.
+        update_spawn: A callback returning the spawn time used by archetypes.
+    """
+
     def __init__(
         self,
         *,
-        archetypes: list[type[BaseArchetype]] | None = None,
+        archetypes: list[type[_BaseArchetype]] | None = None,
         skin: Skin = EmptySkin,
         effects: Effects = EmptyEffects,
         particles: Particles = EmptyParticles,
@@ -97,10 +133,17 @@ class WatchMode:
 
 
 class PreviewMode:
+    """A preview mode definition.
+
+    Args:
+        archetypes: A list of preview archetypes.
+        skin: The skin for the preview mode.
+    """
+
     def __init__(
         self,
         *,
-        archetypes: list[type[BaseArchetype]] | None = None,
+        archetypes: list[type[_BaseArchetype]] | None = None,
         skin: Skin = EmptySkin,
     ) -> None:
         self.archetypes = archetypes or []
@@ -112,6 +155,19 @@ class PreviewMode:
 
 
 class TutorialMode:
+    """A tutorial mode definition.
+
+    Args:
+        skin: The skin for the tutorial mode.
+        effects: The effects for the tutorial mode.
+        particles: The particles for the tutorial mode.
+        instructions: The instructions for the tutorial mode.
+        instruction_icons: The instruction icons for the tutorial mode.
+        preprocess: A callback to be called before the tutorial starts.
+        navigate: A callback to be called when the user navigates.
+        update: A callback to be called each frame.
+    """
+
     def __init__(
         self,
         *,
@@ -135,6 +191,17 @@ class TutorialMode:
 
 
 class EngineData:
+    """A Sonolus.py engine's modes and configurations.
+
+    Args:
+        ui: The UI configuration.
+        options: The options for the engine.
+        play: The play mode configuration.
+        watch: The watch mode configuration.
+        preview: The preview mode configuration.
+        tutorial: The tutorial mode configuration.
+    """
+
     def __init__(
         self,
         *,