SongOptions.h

/* SongOptions - Options that apply to an entire song (not per-player). */
 
#ifndef SONG_OPTIONS_H
#define SONG_OPTIONS_H
 
#include "Etterna/Models/Misc/EnumHelper.h"
 
enum AutosyncType
{
    AutosyncType_Off,
    AutosyncType_Song,
    AutosyncType_Machine,
    NUM_AutosyncType,
    AutosyncType_Invalid
};
auto
AutosyncTypeToString(AutosyncType cat) -> const std::string&;
auto
AutosyncTypeToLocalizedString(AutosyncType cat) -> const std::string&;
LuaDeclareType(AutosyncType);
 
enum SoundEffectType
{
    SoundEffectType_Off,
    SoundEffectType_Speed,
    SoundEffectType_Pitch,
    NUM_SoundEffectType,
    SoundEffectType_Invalid
};
auto
SoundEffectTypeToString(SoundEffectType cat) -> const std::string&;
auto
SoundEffectTypeToLocalizedString(SoundEffectType cat) -> const std::string&;
LuaDeclareType(SoundEffectType);
 
class SongOptions
{
  public:
    bool m_bAssistClap{ false };
    bool m_bAssistMetronome{ false };
    float m_fMusicRate{ 1.0F }, m_SpeedfMusicRate{ 1.0F };
    AutosyncType m_AutosyncType{ AutosyncType_Off };
    SoundEffectType m_SoundEffectType{ SoundEffectType_Off };
    bool m_bStaticBackground{ false };
    bool m_bRandomBGOnly{ false };
    bool m_bSaveScore{ true };
 
    SongOptions() = default;
    void Init();
    void Approach(const SongOptions& other, float fDeltaSeconds);
    void GetMods(std::vector<std::string>& AddTo) const;
    void GetLocalizedMods(std::vector<std::string>& AddTo) const;
    [[nodiscard]] auto GetString() const -> std::string;
    [[nodiscard]] auto GetLocalizedString() const -> std::string;
    void FromString(const std::string& sOptions);
    auto FromOneModString(const std::string& sOneMod,
                          std::string& sErrorDetailOut)
      -> bool; // On error, return
               // false and optionally
               // set sErrorDetailOut
 
    auto operator==(const SongOptions& other) const -> bool;
    auto operator!=(const SongOptions& other) const -> bool
    {
        return !operator==(other);
    }
 
    // Lua
    void PushSelf(lua_State* L);
};
 
#endif