sonolus.py 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

sonolus/script/sprite.py

@@ -2,39 +2,111 @@ from dataclasses import dataclass
 from typing import Annotated, Any, NewType, dataclass_transform, get_origin
 
 from sonolus.backend.ops import Op
-from sonolus.script.graphics import QuadLike, flatten_quad
 from sonolus.script.internal.introspection import get_field_specifiers
 from sonolus.script.internal.native import native_function
+from sonolus.script.quad import QuadLike, flatten_quad
 from sonolus.script.record import Record
 from sonolus.script.vec import Vec2
 
 
 class Sprite(Record):
+    """Skin sprite.
+
+    Usage:
+        ```python
+        Sprite(id: int)
+        ```
+    """
+
     id: int
 
     @property
     def is_available(self) -> bool:
+        """Check if the sprite is available."""
         return _has_skin_sprite(self.id)
 
     def draw(self, quad: QuadLike, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw(self.id, *flatten_quad(quad), z, a)
 
     def draw_curved_b(self, quad: QuadLike, cp: Vec2, n: float, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite with a curved bottom with a quadratic Bézier curve.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            cp: The control point of the curve.
+            n: The number of segments to approximate the curve (higher is smoother but more expensive).
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw_curved_b(self.id, *flatten_quad(quad), z, a, n, *cp.tuple)
 
     def draw_curved_t(self, quad: QuadLike, cp: Vec2, n: float, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite with a curved top with a quadratic Bézier curve.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            cp: The control point of the curve.
+            n: The number of segments to approximate the curve (higher is smoother but more expensive).
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw_curved_t(self.id, *flatten_quad(quad), z, a, n, *cp.tuple)
 
     def draw_curved_l(self, quad: QuadLike, cp: Vec2, n: float, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite with a curved left side with a quadratic Bézier curve.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            cp: The control point of the curve.
+            n: The number of segments to approximate the curve (higher is smoother but more expensive).
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw_curved_l(self.id, *flatten_quad(quad), z, a, n, *cp.tuple)
 
     def draw_curved_r(self, quad: QuadLike, cp: Vec2, n: float, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite with a curved right side with a quadratic Bézier curve.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            cp: The control point of the curve.
+            n: The number of segments to approximate the curve (higher is smoother but more expensive).
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw_curved_r(self.id, *flatten_quad(quad), z, a, n, *cp.tuple)
 
     def draw_curved_bt(self, quad: QuadLike, cp1: Vec2, cp2: Vec2, n: float, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite with a curved bottom and top with a cubic Bézier curve.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            cp1: The control point of the bottom curve.
+            cp2: The control point of the top curve.
+            n: The number of segments to approximate the curve (higher is smoother but more expensive).
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw_curved_bt(self.id, *flatten_quad(quad), z, a, n, *cp1.tuple, *cp2.tuple)
 
     def draw_curved_lr(self, quad: QuadLike, cp1: Vec2, cp2: Vec2, n: float, z: float = 0.0, a: float = 1.0):
+        """Draw the sprite with a curved left and right side with a cubic Bézier curve.
+
+        Arguments:
+            quad: The quad to draw the sprite on.
+            cp1: The control point of the left curve.
+            cp2: The control point of the right curve.
+            n: The number of segments to approximate the curve (higher is smoother but more expensive).
+            z: The z-index of the sprite.
+            a: The alpha of the sprite.
+        """
         _draw_curved_lr(self.id, *flatten_quad(quad), z, a, n, *cp1.tuple, *cp2.tuple)
 
 
@@ -56,7 +128,7 @@ def _draw(
     y4: float,
     z: float,
     a: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -76,7 +148,7 @@ def _draw_curved_b(
     n: int,
     p: float,
     q: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -96,7 +168,7 @@ def _draw_curved_t(
     n: int,
     p: float,
     q: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -116,7 +188,7 @@ def _draw_curved_l(
     n: int,
     p: float,
     q: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -136,7 +208,7 @@ def _draw_curved_r(
     n: int,
     p: float,
     q: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -158,7 +230,7 @@ def _draw_curved_bt(
     q1: float,
     p2: float,
     q2: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -180,7 +252,7 @@ def _draw_curved_lr(
     q1: float,
     p2: float,
     q2: float,
-):
+) -> None:
     raise NotImplementedError
 
 
@@ -189,7 +261,8 @@ class SkinSprite:
     name: str
 
 
-def skin_sprite(name: str) -> Any:
+def sprite(name: str) -> Any:
+    """Define a sprite with the given name."""
     return SkinSprite(name)
 
 
@@ -198,6 +271,16 @@ type Skin = NewType("Skin", Any)
 
 @dataclass_transform()
 def skin[T](cls: type[T]) -> T | Skin:
+    """Decorator to define a skin.
+
+    Usage:
+        ```python
+        @skin
+        class Skin:
+            note: StandardSprite.NOTE_HEAD_RED
+            other: Sprite = skin_sprite("other")
+        ```
+    """
     if len(cls.__bases__) != 1:
         raise ValueError("Skin class must not inherit from any class (except object)")
     instance = cls()
@@ -220,112 +303,112 @@ def skin[T](cls: type[T]) -> T | Skin:
 
 
 class StandardSprite:
-    NOTE_HEAD_NEUTRAL = Annotated[Sprite, skin_sprite("#NOTE_HEAD_NEUTRAL")]
-    NOTE_HEAD_RED = Annotated[Sprite, skin_sprite("#NOTE_HEAD_RED")]
-    NOTE_HEAD_GREEN = Annotated[Sprite, skin_sprite("#NOTE_HEAD_GREEN")]
-    NOTE_HEAD_BLUE = Annotated[Sprite, skin_sprite("#NOTE_HEAD_BLUE")]
-    NOTE_HEAD_YELLOW = Annotated[Sprite, skin_sprite("#NOTE_HEAD_YELLOW")]
-    NOTE_HEAD_PURPLE = Annotated[Sprite, skin_sprite("#NOTE_HEAD_PURPLE")]
-    NOTE_HEAD_CYAN = Annotated[Sprite, skin_sprite("#NOTE_HEAD_CYAN")]
-
-    NOTE_TICK_NEUTRAL = Annotated[Sprite, skin_sprite("#NOTE_TICK_NEUTRAL")]
-    NOTE_TICK_RED = Annotated[Sprite, skin_sprite("#NOTE_TICK_RED")]
-    NOTE_TICK_GREEN = Annotated[Sprite, skin_sprite("#NOTE_TICK_GREEN")]
-    NOTE_TICK_BLUE = Annotated[Sprite, skin_sprite("#NOTE_TICK_BLUE")]
-    NOTE_TICK_YELLOW = Annotated[Sprite, skin_sprite("#NOTE_TICK_YELLOW")]
-    NOTE_TICK_PURPLE = Annotated[Sprite, skin_sprite("#NOTE_TICK_PURPLE")]
-    NOTE_TICK_CYAN = Annotated[Sprite, skin_sprite("#NOTE_TICK_CYAN")]
-
-    NOTE_TAIL_NEUTRAL = Annotated[Sprite, skin_sprite("#NOTE_TAIL_NEUTRAL")]
-    NOTE_TAIL_RED = Annotated[Sprite, skin_sprite("#NOTE_TAIL_RED")]
-    NOTE_TAIL_GREEN = Annotated[Sprite, skin_sprite("#NOTE_TAIL_GREEN")]
-    NOTE_TAIL_BLUE = Annotated[Sprite, skin_sprite("#NOTE_TAIL_BLUE")]
-    NOTE_TAIL_YELLOW = Annotated[Sprite, skin_sprite("#NOTE_TAIL_YELLOW")]
-    NOTE_TAIL_PURPLE = Annotated[Sprite, skin_sprite("#NOTE_TAIL_PURPLE")]
-    NOTE_TAIL_CYAN = Annotated[Sprite, skin_sprite("#NOTE_TAIL_CYAN")]
-
-    NOTE_CONNECTION_NEUTRAL = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_NEUTRAL")]
-    NOTE_CONNECTION_RED = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_RED")]
-    NOTE_CONNECTION_GREEN = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_GREEN")]
-    NOTE_CONNECTION_BLUE = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_BLUE")]
-    NOTE_CONNECTION_YELLOW = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_YELLOW")]
-    NOTE_CONNECTION_PURPLE = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_PURPLE")]
-    NOTE_CONNECTION_CYAN = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_CYAN")]
-
-    NOTE_CONNECTION_NEUTRAL_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_NEUTRAL_SEAMLESS")]
-    NOTE_CONNECTION_RED_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_RED_SEAMLESS")]
-    NOTE_CONNECTION_GREEN_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_GREEN_SEAMLESS")]
-    NOTE_CONNECTION_BLUE_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_BLUE_SEAMLESS")]
-    NOTE_CONNECTION_YELLOW_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_YELLOW_SEAMLESS")]
-    NOTE_CONNECTION_PURPLE_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_PURPLE_SEAMLESS")]
-    NOTE_CONNECTION_CYAN_SEAMLESS = Annotated[Sprite, skin_sprite("#NOTE_CONNECTION_CYAN_SEAMLESS")]
-
-    SIMULTANEOUS_CONNECTION_NEUTRAL = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_NEUTRAL")]
-    SIMULTANEOUS_CONNECTION_RED = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_RED")]
-    SIMULTANEOUS_CONNECTION_GREEN = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_GREEN")]
-    SIMULTANEOUS_CONNECTION_BLUE = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_BLUE")]
-    SIMULTANEOUS_CONNECTION_YELLOW = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_YELLOW")]
-    SIMULTANEOUS_CONNECTION_PURPLE = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_PURPLE")]
-    SIMULTANEOUS_CONNECTION_CYAN = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_CYAN")]
-
-    SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS = Annotated[
-        Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS")
-    ]
-    SIMULTANEOUS_CONNECTION_RED_SEAMLESS = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_RED_SEAMLESS")]
-    SIMULTANEOUS_CONNECTION_GREEN_SEAMLESS = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_GREEN_SEAMLESS")]
-    SIMULTANEOUS_CONNECTION_BLUE_SEAMLESS = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_BLUE_SEAMLESS")]
-    SIMULTANEOUS_CONNECTION_YELLOW_SEAMLESS = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_YELLOW_SEAMLESS")]
-    SIMULTANEOUS_CONNECTION_PURPLE_SEAMLESS = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_PURPLE_SEAMLESS")]
-    SIMULTANEOUS_CONNECTION_CYAN_SEAMLESS = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_CONNECTION_CYAN_SEAMLESS")]
-
-    DIRECTIONAL_MARKER_NEUTRAL = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_NEUTRAL")]
-    DIRECTIONAL_MARKER_RED = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_RED")]
-    DIRECTIONAL_MARKER_GREEN = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_GREEN")]
-    DIRECTIONAL_MARKER_BLUE = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_BLUE")]
-    DIRECTIONAL_MARKER_YELLOW = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_YELLOW")]
-    DIRECTIONAL_MARKER_PURPLE = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_PURPLE")]
-    DIRECTIONAL_MARKER_CYAN = Annotated[Sprite, skin_sprite("#DIRECTIONAL_MARKER_CYAN")]
-
-    SIMULTANEOUS_MARKER_NEUTRAL = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_NEUTRAL")]
-    SIMULTANEOUS_MARKER_RED = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_RED")]
-    SIMULTANEOUS_MARKER_GREEN = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_GREEN")]
-    SIMULTANEOUS_MARKER_BLUE = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_BLUE")]
-    SIMULTANEOUS_MARKER_YELLOW = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_YELLOW")]
-    SIMULTANEOUS_MARKER_PURPLE = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_PURPLE")]
-    SIMULTANEOUS_MARKER_CYAN = Annotated[Sprite, skin_sprite("#SIMULTANEOUS_MARKER_CYAN")]
-
-    STAGE_MIDDLE = Annotated[Sprite, skin_sprite("#STAGE_MIDDLE")]
-    STAGE_LEFT_BORDER = Annotated[Sprite, skin_sprite("#STAGE_LEFT_BORDER")]
-    STAGE_RIGHT_BORDER = Annotated[Sprite, skin_sprite("#STAGE_RIGHT_BORDER")]
-    STAGE_TOP_BORDER = Annotated[Sprite, skin_sprite("#STAGE_TOP_BORDER")]
-    STAGE_BOTTOM_BORDER = Annotated[Sprite, skin_sprite("#STAGE_BOTTOM_BORDER")]
-
-    STAGE_LEFT_BORDER_SEAMLESS = Annotated[Sprite, skin_sprite("#STAGE_LEFT_BORDER_SEAMLESS")]
-    STAGE_RIGHT_BORDER_SEAMLESS = Annotated[Sprite, skin_sprite("#STAGE_RIGHT_BORDER_SEAMLESS")]
-    STAGE_TOP_BORDER_SEAMLESS = Annotated[Sprite, skin_sprite("#STAGE_TOP_BORDER_SEAMLESS")]
-    STAGE_BOTTOM_BORDER_SEAMLESS = Annotated[Sprite, skin_sprite("#STAGE_BOTTOM_BORDER_SEAMLESS")]
-
-    STAGE_TOP_LEFT_CORNER = Annotated[Sprite, skin_sprite("#STAGE_TOP_LEFT_CORNER")]
-    STAGE_TOP_RIGHT_CORNER = Annotated[Sprite, skin_sprite("#STAGE_TOP_RIGHT_CORNER")]
-    STAGE_BOTTOM_LEFT_CORNER = Annotated[Sprite, skin_sprite("#STAGE_BOTTOM_LEFT_CORNER")]
-    STAGE_BOTTOM_RIGHT_CORNER = Annotated[Sprite, skin_sprite("#STAGE_BOTTOM_RIGHT_CORNER")]
-
-    LANE = Annotated[Sprite, skin_sprite("#LANE")]
-    LANE_SEAMLESS = Annotated[Sprite, skin_sprite("#LANE_SEAMLESS")]
-    LANE_ALTERNATIVE = Annotated[Sprite, skin_sprite("#LANE_ALTERNATIVE")]
-    LANE_ALTERNATIVE_SEAMLESS = Annotated[Sprite, skin_sprite("#LANE_ALTERNATIVE_SEAMLESS")]
-
-    JUDGMENT_LINE = Annotated[Sprite, skin_sprite("#JUDGMENT_LINE")]
-    NOTE_SLOT = Annotated[Sprite, skin_sprite("#NOTE_SLOT")]
-    STAGE_COVER = Annotated[Sprite, skin_sprite("#STAGE_COVER")]
-
-    GRID_NEUTRAL = Annotated[Sprite, skin_sprite("#GRID_NEUTRAL")]
-    GRID_RED = Annotated[Sprite, skin_sprite("#GRID_RED")]
-    GRID_GREEN = Annotated[Sprite, skin_sprite("#GRID_GREEN")]
-    GRID_BLUE = Annotated[Sprite, skin_sprite("#GRID_BLUE")]
-    GRID_YELLOW = Annotated[Sprite, skin_sprite("#GRID_YELLOW")]
-    GRID_PURPLE = Annotated[Sprite, skin_sprite("#GRID_PURPLE")]
-    GRID_CYAN = Annotated[Sprite, skin_sprite("#GRID_CYAN")]
+    """Standard skin sprites."""
+
+    NOTE_HEAD_NEUTRAL = Annotated[Sprite, sprite("#NOTE_HEAD_NEUTRAL")]
+    NOTE_HEAD_RED = Annotated[Sprite, sprite("#NOTE_HEAD_RED")]
+    NOTE_HEAD_GREEN = Annotated[Sprite, sprite("#NOTE_HEAD_GREEN")]
+    NOTE_HEAD_BLUE = Annotated[Sprite, sprite("#NOTE_HEAD_BLUE")]
+    NOTE_HEAD_YELLOW = Annotated[Sprite, sprite("#NOTE_HEAD_YELLOW")]
+    NOTE_HEAD_PURPLE = Annotated[Sprite, sprite("#NOTE_HEAD_PURPLE")]
+    NOTE_HEAD_CYAN = Annotated[Sprite, sprite("#NOTE_HEAD_CYAN")]
+
+    NOTE_TICK_NEUTRAL = Annotated[Sprite, sprite("#NOTE_TICK_NEUTRAL")]
+    NOTE_TICK_RED = Annotated[Sprite, sprite("#NOTE_TICK_RED")]
+    NOTE_TICK_GREEN = Annotated[Sprite, sprite("#NOTE_TICK_GREEN")]
+    NOTE_TICK_BLUE = Annotated[Sprite, sprite("#NOTE_TICK_BLUE")]
+    NOTE_TICK_YELLOW = Annotated[Sprite, sprite("#NOTE_TICK_YELLOW")]
+    NOTE_TICK_PURPLE = Annotated[Sprite, sprite("#NOTE_TICK_PURPLE")]
+    NOTE_TICK_CYAN = Annotated[Sprite, sprite("#NOTE_TICK_CYAN")]
+
+    NOTE_TAIL_NEUTRAL = Annotated[Sprite, sprite("#NOTE_TAIL_NEUTRAL")]
+    NOTE_TAIL_RED = Annotated[Sprite, sprite("#NOTE_TAIL_RED")]
+    NOTE_TAIL_GREEN = Annotated[Sprite, sprite("#NOTE_TAIL_GREEN")]
+    NOTE_TAIL_BLUE = Annotated[Sprite, sprite("#NOTE_TAIL_BLUE")]
+    NOTE_TAIL_YELLOW = Annotated[Sprite, sprite("#NOTE_TAIL_YELLOW")]
+    NOTE_TAIL_PURPLE = Annotated[Sprite, sprite("#NOTE_TAIL_PURPLE")]
+    NOTE_TAIL_CYAN = Annotated[Sprite, sprite("#NOTE_TAIL_CYAN")]
+
+    NOTE_CONNECTION_NEUTRAL = Annotated[Sprite, sprite("#NOTE_CONNECTION_NEUTRAL")]
+    NOTE_CONNECTION_RED = Annotated[Sprite, sprite("#NOTE_CONNECTION_RED")]
+    NOTE_CONNECTION_GREEN = Annotated[Sprite, sprite("#NOTE_CONNECTION_GREEN")]
+    NOTE_CONNECTION_BLUE = Annotated[Sprite, sprite("#NOTE_CONNECTION_BLUE")]
+    NOTE_CONNECTION_YELLOW = Annotated[Sprite, sprite("#NOTE_CONNECTION_YELLOW")]
+    NOTE_CONNECTION_PURPLE = Annotated[Sprite, sprite("#NOTE_CONNECTION_PURPLE")]
+    NOTE_CONNECTION_CYAN = Annotated[Sprite, sprite("#NOTE_CONNECTION_CYAN")]
+
+    NOTE_CONNECTION_NEUTRAL_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_NEUTRAL_SEAMLESS")]
+    NOTE_CONNECTION_RED_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_RED_SEAMLESS")]
+    NOTE_CONNECTION_GREEN_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_GREEN_SEAMLESS")]
+    NOTE_CONNECTION_BLUE_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_BLUE_SEAMLESS")]
+    NOTE_CONNECTION_YELLOW_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_YELLOW_SEAMLESS")]
+    NOTE_CONNECTION_PURPLE_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_PURPLE_SEAMLESS")]
+    NOTE_CONNECTION_CYAN_SEAMLESS = Annotated[Sprite, sprite("#NOTE_CONNECTION_CYAN_SEAMLESS")]
+
+    SIMULTANEOUS_CONNECTION_NEUTRAL = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_NEUTRAL")]
+    SIMULTANEOUS_CONNECTION_RED = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_RED")]
+    SIMULTANEOUS_CONNECTION_GREEN = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_GREEN")]
+    SIMULTANEOUS_CONNECTION_BLUE = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_BLUE")]
+    SIMULTANEOUS_CONNECTION_YELLOW = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_YELLOW")]
+    SIMULTANEOUS_CONNECTION_PURPLE = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_PURPLE")]
+    SIMULTANEOUS_CONNECTION_CYAN = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_CYAN")]
+
+    SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS")]
+    SIMULTANEOUS_CONNECTION_RED_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_RED_SEAMLESS")]
+    SIMULTANEOUS_CONNECTION_GREEN_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_GREEN_SEAMLESS")]
+    SIMULTANEOUS_CONNECTION_BLUE_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_BLUE_SEAMLESS")]
+    SIMULTANEOUS_CONNECTION_YELLOW_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_YELLOW_SEAMLESS")]
+    SIMULTANEOUS_CONNECTION_PURPLE_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_PURPLE_SEAMLESS")]
+    SIMULTANEOUS_CONNECTION_CYAN_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_CYAN_SEAMLESS")]
+
+    DIRECTIONAL_MARKER_NEUTRAL = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_NEUTRAL")]
+    DIRECTIONAL_MARKER_RED = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_RED")]
+    DIRECTIONAL_MARKER_GREEN = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_GREEN")]
+    DIRECTIONAL_MARKER_BLUE = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_BLUE")]
+    DIRECTIONAL_MARKER_YELLOW = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_YELLOW")]
+    DIRECTIONAL_MARKER_PURPLE = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_PURPLE")]
+    DIRECTIONAL_MARKER_CYAN = Annotated[Sprite, sprite("#DIRECTIONAL_MARKER_CYAN")]
+
+    SIMULTANEOUS_MARKER_NEUTRAL = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_NEUTRAL")]
+    SIMULTANEOUS_MARKER_RED = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_RED")]
+    SIMULTANEOUS_MARKER_GREEN = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_GREEN")]
+    SIMULTANEOUS_MARKER_BLUE = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_BLUE")]
+    SIMULTANEOUS_MARKER_YELLOW = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_YELLOW")]
+    SIMULTANEOUS_MARKER_PURPLE = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_PURPLE")]
+    SIMULTANEOUS_MARKER_CYAN = Annotated[Sprite, sprite("#SIMULTANEOUS_MARKER_CYAN")]
+
+    STAGE_MIDDLE = Annotated[Sprite, sprite("#STAGE_MIDDLE")]
+    STAGE_LEFT_BORDER = Annotated[Sprite, sprite("#STAGE_LEFT_BORDER")]
+    STAGE_RIGHT_BORDER = Annotated[Sprite, sprite("#STAGE_RIGHT_BORDER")]
+    STAGE_TOP_BORDER = Annotated[Sprite, sprite("#STAGE_TOP_BORDER")]
+    STAGE_BOTTOM_BORDER = Annotated[Sprite, sprite("#STAGE_BOTTOM_BORDER")]
+
+    STAGE_LEFT_BORDER_SEAMLESS = Annotated[Sprite, sprite("#STAGE_LEFT_BORDER_SEAMLESS")]
+    STAGE_RIGHT_BORDER_SEAMLESS = Annotated[Sprite, sprite("#STAGE_RIGHT_BORDER_SEAMLESS")]
+    STAGE_TOP_BORDER_SEAMLESS = Annotated[Sprite, sprite("#STAGE_TOP_BORDER_SEAMLESS")]
+    STAGE_BOTTOM_BORDER_SEAMLESS = Annotated[Sprite, sprite("#STAGE_BOTTOM_BORDER_SEAMLESS")]
+
+    STAGE_TOP_LEFT_CORNER = Annotated[Sprite, sprite("#STAGE_TOP_LEFT_CORNER")]
+    STAGE_TOP_RIGHT_CORNER = Annotated[Sprite, sprite("#STAGE_TOP_RIGHT_CORNER")]
+    STAGE_BOTTOM_LEFT_CORNER = Annotated[Sprite, sprite("#STAGE_BOTTOM_LEFT_CORNER")]
+    STAGE_BOTTOM_RIGHT_CORNER = Annotated[Sprite, sprite("#STAGE_BOTTOM_RIGHT_CORNER")]
+
+    LANE = Annotated[Sprite, sprite("#LANE")]
+    LANE_SEAMLESS = Annotated[Sprite, sprite("#LANE_SEAMLESS")]
+    LANE_ALTERNATIVE = Annotated[Sprite, sprite("#LANE_ALTERNATIVE")]
+    LANE_ALTERNATIVE_SEAMLESS = Annotated[Sprite, sprite("#LANE_ALTERNATIVE_SEAMLESS")]
+
+    JUDGMENT_LINE = Annotated[Sprite, sprite("#JUDGMENT_LINE")]
+    NOTE_SLOT = Annotated[Sprite, sprite("#NOTE_SLOT")]
+    STAGE_COVER = Annotated[Sprite, sprite("#STAGE_COVER")]
+
+    GRID_NEUTRAL = Annotated[Sprite, sprite("#GRID_NEUTRAL")]
+    GRID_RED = Annotated[Sprite, sprite("#GRID_RED")]
+    GRID_GREEN = Annotated[Sprite, sprite("#GRID_GREEN")]
+    GRID_BLUE = Annotated[Sprite, sprite("#GRID_BLUE")]
+    GRID_YELLOW = Annotated[Sprite, sprite("#GRID_YELLOW")]
+    GRID_PURPLE = Annotated[Sprite, sprite("#GRID_PURPLE")]
+    GRID_CYAN = Annotated[Sprite, sprite("#GRID_CYAN")]
 
 
 @skin

sonolus/script/text.py

@@ -2,6 +2,8 @@ from enum import StrEnum
 
 
 class StandardText(StrEnum):
+    """Standard text constants."""
+
     POST = "#POST"
     PLAYLIST = "#PLAYLIST"
     LEVEL = "#LEVEL"

sonolus/script/timing.py

@@ -4,39 +4,111 @@ from sonolus.script.internal.native import native_function
 
 @native_function(Op.BeatToBPM)
 def beat_to_bpm(beat: float) -> float:
+    """Get the bpm at the given beat.
+
+    Args:
+        beat: The beat to get the bpm at.
+
+    Returns:
+        The bpm at the given beat.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.BeatToTime)
 def beat_to_time(beat: float) -> float:
+    """Get the time at the given beat.
+
+    Args:
+        beat: The beat to get the time at.
+
+    Returns:
+        The time at the given beat.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.BeatToStartingBeat)
 def beat_to_starting_beat(beat: float) -> float:
+    """Get the starting beat of the bpm section at the given beat.
+
+    I.e. the beat of the bpm change at or immediately before the given beat.
+
+    Args:
+        beat: The beat to get the starting beat of the bpm section at.
+
+    Returns:
+        The starting beat of the bpm section at the given beat.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.BeatToStartingTime)
 def beat_to_starting_time(beat: float) -> float:
+    """Get the starting time of the bpm section at the given beat.
+
+    I.e. the time of the bpm change at or immediately before the given beat.
+
+    Args:
+        beat: The beat to get the starting time of the bpm section at.
+
+    Returns:
+        The starting time of the bpm section at the given beat.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.TimeToScaledTime)
 def time_to_scaled_time(time: float) -> float:
+    """Get the scaled (timescale adjusted) time at the given time.
+
+    Args:
+        time: The time to get the scaled time at.
+
+    Returns:
+        The scaled (timescale adjusted) time at the given time.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.TimeToStartingScaledTime)
 def time_to_starting_scaled_time(time: float) -> float:
+    """Get the starting scaled (timescale adjusted) time at the given time.
+
+    I.e. the scaled time of the timescale change at or immediately before the given time.
+
+    Args:
+        time: The time to get the starting scaled time at.
+
+    Returns:
+        The starting scaled time at the given time.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.TimeToStartingTime)
 def time_to_starting_time(time: float) -> float:
+    """Get the starting time of the timescale section at the given time.
+
+    I.e. the time of the timescale change at or immediately before the given time.
+
+    Args:
+        time: The time to get the starting time of the timescale section at.
+
+    Returns:
+        The starting time of the timescale section at the given time.
+    """
     raise NotImplementedError
 
 
 @native_function(Op.TimeToTimeScale)
 def time_to_timescale(time: float) -> float:
+    """Get the timescale at the given time.
+
+    Args:
+        time: The time to get the timescale at.
+
+    Returns:
+        The timescale at the given time.
+    """
     raise NotImplementedError