sonolus.script.ui

EaseType

Bases: StrEnum

The easing function to use.

UiAnimation dataclass

Animation configuration for UI elements.

Parameters:

Name	Type	Description	Default
scale	UiAnimationTween	The animation applied to scale.	required
alpha	UiAnimationTween	The animation applied to alpha.	required

UiAnimationTween dataclass

Tween animation configuration for UI elements.

Parameters:

Name	Type	Description	Default
start	float	The initial value.	required
end	float	The final value.	required
duration	float	The duration of the animation.	required
ease	EaseType	The easing function to use.	required

UiConfig dataclass

Configuration for UI elements.

Parameters:

Name	Type	Description	Default
scope	str | None	The scope of the configuration.	None
primary_metric	UiMetric	The primary metric to display.	ARCADE
secondary_metric	UiMetric	The secondary metric to display.	LIFE
menu_visibility	UiVisibility	The visibility configuration for the menu.	UiVisibility()
judgment_visibility	UiVisibility	The visibility configuration for judgments.	UiVisibility()
combo_visibility	UiVisibility	The visibility configuration for the combo.	UiVisibility()
primary_metric_visibility	UiVisibility	The visibility configuration for the primary metric.	UiVisibility()
secondary_metric_visibility	UiVisibility	The visibility configuration for the secondary metric.	UiVisibility()
progress_visibility	UiVisibility	The visibility configuration for progress.	UiVisibility()
tutorial_navigation_visibility	UiVisibility	The visibility configuration for tutorial navigation.	UiVisibility()
tutorial_instruction_visibility	UiVisibility	The visibility configuration for tutorial instructions.	UiVisibility()
judgment_animation	UiAnimation	The animation configuration for judgments.	lambda: UiAnimation(scale=UiAnimationTween(0, 1, 0.1, OUT_CUBIC), alpha=UiAnimationTween(1, 0, 0.3, NONE))()
combo_animation	UiAnimation	The animation configuration for the combo.	lambda: UiAnimation(scale=UiAnimationTween(1.2, 1, 0.2, IN_CUBIC), alpha=UiAnimationTween(1, 1, 0, NONE))()
judgment_error_style	UiJudgmentErrorStyle	The style of the judgment error.	LATE
judgment_error_placement	UiJudgmentErrorPlacement	The placement of the judgment error.	TOP
judgment_error_min	float	The minimum judgment error.	0.0

UiJudgmentErrorPlacement

Bases: StrEnum

The placement of the judgment error.

UiJudgmentErrorStyle

Bases: StrEnum

The style of the judgment error.

The name of each member refers to what's used for positive (late) judgment errors.

UiMetric

Bases: StrEnum

A metric to display on the UI.

UiVisibility dataclass

Visibility configuration for UI elements.

Parameters:

Name	Type	Description	Default
scale	float	The scale of the element.	1.0
alpha	float	The alpha of the element.	1.0