Resources

/**
 * @brief Define a skin sprite
 * @param name Sprite name
 * @param path Sprite image path
 * @return Sprite id
 */
SkinSprite defineSkinSprite(string name, string path = "");

SkinSprite RedNote = defineSkinSprite(SkinSpriteName.NoteHeadRed);
SkinSprite YellowNote = defineSkinSprite(SkinSpriteName.NoteHeadYellow, "./skins/YellowNote.png");
SkinSprite BlueNote = defineSkinSprite("Blue Note");
SkinSprite GreenNote = defineSkinSprite("Green Note", "./skins/GreenNote.png");

int main(int argc, char** argv) {
    // ...

    PackSkin();
}

/**
 * @brief Define a effect clip
 * @param name Clip name
 * @param path Clip audio path
 * @return Clip id
 */
EffectClip defineEffectClip(string name, string path = "");

EffectClip Perfect = defineEffectClip(EffectClipName.Perfect);
EffectClip Great = defineEffectClip(EffectClipName.Great, "./effects/Great.mp3");
EffectClip Good = defineEffectClip("Good");
EffectClip Miss = defineEffectClip("Miss", "./effects/Miss.mp3");

int main(int argc, char** argv) {
    // ...

    PackEffect();
}

/**
 * @brief Define a particle effect
 * @param name Effect name
 * @return Effect id
 */
ParticleEffect defineParticleEffect(string name);

ParticleEffect RedTap = defineParticleEffect(ParticleEffectName.NoteCircularTapRed);
ParticleEffect YellowTap = defineParticleEffect("Yellow Tap");

/**
 * @brief Create a bucket sprite
 * @param id Sprite id. You can use value with type SkinSprite.
 * @param fallbackId Unknown.
 * @param x X position.
 * @param y Y position.
 * @param w Width.
 * @param h Height.
 * @param rotation Counterclockwise rotation angle in degrees.
 */
class EngineDataBucketSprite(int id, int fallbackId, double x, double y, double w, double h, double rotation);

/**
 * @brief Define a bucket
 * @param sprites Bucket sprites.
 * @param unit Bucket unit. You need to use Texts.*Unit or empty string as its value.
 * @return Bucket id.
 */
Bucket defineBucket(vector<EngineDataBucketSprite> sprites, string unit);

Bucket NormalNoteBucket = defineBucket({
    EngineDataBucketSprite(NormalNote, 0, 0.0, 0.0, 2.0, 1.0, 270)
}, Text.MillisecondUnit);
Bucket CriticalNoteBucket = defineBucket({
	EngineDataBucketSprite(CriticalNote, 0, 0.0, 0.0, 2.0, 1.0, 270)
});

/**
 * @brief Define a instruction text
 * @param text Instruction text.
 * @return Instruction text id.
 */
InstructionText defineInstructionText(string text);

InstructionText NormalNote = defineInstructionText(Texts.Tap);
InstructionText CriticalNote = defineInstructionText("Tap");

/**
 * @brief Define a instruction icon
 * @param icon Instruction icon name.
 * @return Instruction icon id.
 */
InstructionIcon defineInstructionIcon(string name);

InstructionIcon Hand = defineInstructionIcon(InstructionIconName.Hand);
InstructionIcon Arrow = defineInstructionIcon("#ARROW");

/**
 * @brief Create a slider option.
 * @param name The name of this option.
 * @param description The description of this option.
 * @param standard Whether this option is considered as a standard option.
 * @param advanced Whether this option is considered as a advanced option.
 * @param scope The scope of this option.
 * @param def Default value of this option.
 * @param min Minimal value of this option.
 * @param max Maximal value of this option.
 * @param step Step value of this option.
 * @param unit Unit of this option.
 * @return Option value
 */
Variable SliderOption(
    string name = "",
    string description = "",
    bool standard = false,
    bool advanced = false,
    string scope = "",
    double def = 0,
    double min = 0,
    double max = 100,
    double step = 1,
    string unit = ""
);

/**
 * @brief Create a toggle option.
 * @param name The name of this option.
 * @param description The description of this option.
 * @param standard Whether this option is considered as a standard option.
 * @param advanced Whether this option is considered as a advanced option.
 * @param scope The scope of this option.
 * @param def Default value of this option.
 * @return Option value
 */
Variable ToggleOption(
    string name = "",
    string description = "",
    bool standard = false,
    bool advanced = false,
    string scope = "",
    bool def = false
);

/**
 * @brief Create a select option.
 * @param name The name of this option.
 * @param description The description of this option.
 * @param standard Whether this option is considered as a standard option.
 * @param advanced Whether this option is considered as a advanced option.
 * @param scope The scope of this option.
 * @param def Default value of this option.
 * @param values Option values of this option.
 * @return Option value
 */
Variable SelectOption(
    string name = "",
    string description = "",
    bool standard = false,
    bool advanced = false,
    string scope = "",
    int def = 0,
    vector<string> values = {}
)

var Mirror = ToggleOption(Texts.Mirror, "", false, false, "", false);
var NoteSpeed = SliderOption(Texts.NoteSpeed, "", false, false, "sirius", 5.0, 1.0, 25.0, 0.1, "");
var JudgeType = SelectOption("Show FAST/SLOW", "", false, false, "sirius", 2, {
    "PERFECT and below",
    "GREAT and below",
    "OFF"
});

/**
 * @brief Visibility class
 * @param scale The scale size of the item.
 * @param alpha The alpha value of the item.
 */
class Visibility(double scale = 1, double alpha = 0);

/**
 * @brief AnimationTween class
 * @param from Start value of current animation tween.
 * @param to End value of current animation tween.
 * @param duration Duration of current animation tween.
 * @param ease Easing type of current animation tween. Only members of `EngineConfigurationAnimationTweenEase` are accepted.
 */
class AnimationTween(double from = 0, double to = 1, double duration = 1, string ease = EngineConfigurationAnimationTweenEase.None);

/**
 * @brief Animation class
 * @param scale The scale animation tween of the item
 * @param alpha The alpha animation tween of the item
 */
class Animation(AnimationTween scale = AnimationTween(), AnimationTween alpha = AnimationTween());

class UI {
    public:

    /**
     * @brief Set UI scope.
     * @param scope UI scope.
     */
    void SetScope(string scope);

    /**
     * @brief Set UI primary metric and secondary metric.
     * 
     * @param primary Primary metric to show. Only members of `EngineConfigurationMetric` are accepted.
     * @param primaryVisibility Visibility property of primary metric.
     * @param secondary Secondary metric to show. Only members of `EngineConfigurationMetric` are accepted.
     * @param secondaryVisibility Visibility property of secondary metric.
     */
    void SetMetric(
        string primary = EngineConfigurationMetric.Arcade, 
        Visibility primaryVisibility = Visibility(),
        string secondary = EngineConfigurationMetric.Life, 
        Visibility secondaryVisibility = Visibility()
    );

    /**
     * @brief Set UI menu.
     * @param visibility Visibility property of menu.
     */
    void SetMenu(Visibility visibility = Visibility());

    /**
     * @brief Set UI judgment.
     * 
     * @param visibility Visibility property of judgment.
     * @param animation Animation of judgment.
     * @param errorStyle Style of positive judgment error. Only members of `EngineConfigurationJudgmentErrorStyle` are accepted.
     * @param errorPlacement Placement of judgment error. Only members of `EngineConfigurationJudgmentErrorPlacement` are accepted.
     * @param errorMin Minimum judgment error. Only judgment errors larger than this will be shown.
     */
    void SetJudgment(
        Visibility visibility = Visibility(), 
        Animation animation = Animation(),
        string errorStyle = EngineConfigurationJudgmentErrorStyle.None,
        string errorPlacement = EngineConfigurationJudgmentErrorPlacement.LeftRight,
        double errorMin = 0
    );

    /**
     * @brief Set UI combo.
     * @param visibility Visibility property of combo.
     * @param animation Animation of combo.
     */
    void SetCombo(Visibility visibility = Visibility(), Animation animation = Animation());

    /**
     * @brief Set UI progress.
     * @param visibility Visibility property of progress.
     */
    void SetProgress(Visibility visibility = Visibility());

    /**
     * @brief Set UI in tutorial mode.
     * @param navigation Visibility property of navigation in tutorial mode.
     * @param instruction Visibility property of instruction in tutorial mode.
     */
    void SetTutorial(Visibility navigation = Visibility(), Visibility instruction = Visibility());
}UI;