2018-10-07 03:42:33 +00:00
|
|
|
#pragma once
|
2015-08-17 20:33:58 +00:00
|
|
|
|
2019-08-14 06:49:40 +00:00
|
|
|
#include <array>
|
2020-03-14 23:59:58 +00:00
|
|
|
#include <string_view>
|
2019-09-22 21:52:05 +00:00
|
|
|
#include <vector>
|
|
|
|
|
|
|
|
#include "Runtime/CSaveWorld.hpp"
|
|
|
|
#include "Runtime/RetroTypes.hpp"
|
|
|
|
#include "Runtime/Audio/CAudioSys.hpp"
|
2015-08-31 03:44:42 +00:00
|
|
|
|
2018-12-08 05:30:43 +00:00
|
|
|
namespace urde {
|
2018-02-04 06:46:47 +00:00
|
|
|
struct CFinalInput;
|
2017-03-24 05:30:16 +00:00
|
|
|
class CStateManager;
|
2017-01-10 07:15:49 +00:00
|
|
|
|
|
|
|
/** Options presented in UI */
|
2018-12-08 05:30:43 +00:00
|
|
|
enum class EGameOption {
|
|
|
|
VisorOpacity,
|
|
|
|
HelmetOpacity,
|
|
|
|
HUDLag,
|
|
|
|
HintSystem,
|
|
|
|
ScreenBrightness,
|
|
|
|
ScreenOffsetX,
|
|
|
|
ScreenOffsetY,
|
|
|
|
ScreenStretch,
|
|
|
|
SFXVolume,
|
|
|
|
MusicVolume,
|
|
|
|
SoundMode,
|
|
|
|
ReverseYAxis,
|
|
|
|
Rumble,
|
|
|
|
SwapBeamControls,
|
|
|
|
RestoreDefaults
|
2017-01-10 07:15:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/** Option UI type */
|
2018-12-08 05:30:43 +00:00
|
|
|
enum class EOptionType { Float, DoubleEnum, TripleEnum, RestoreDefaults };
|
2017-01-10 07:15:49 +00:00
|
|
|
|
|
|
|
/** Option UI presentation information */
|
2018-12-08 05:30:43 +00:00
|
|
|
struct SGameOption {
|
|
|
|
EGameOption option;
|
|
|
|
u32 stringId;
|
|
|
|
float minVal, maxVal, increment;
|
|
|
|
EOptionType type;
|
2017-01-10 07:15:49 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/** Static registry of Option UI presentation information */
|
2019-08-14 06:49:40 +00:00
|
|
|
extern const std::array<std::pair<size_t, const SGameOption*>, 5> GameOptionsRegistry;
|
2015-08-17 22:05:00 +00:00
|
|
|
|
2016-09-25 01:58:20 +00:00
|
|
|
/** Options tracked persistently between game sessions */
|
2018-12-08 05:30:43 +00:00
|
|
|
class CPersistentOptions {
|
|
|
|
friend class CGameState;
|
2019-08-14 06:49:40 +00:00
|
|
|
std::array<u8, 98> x0_nesState{};
|
|
|
|
std::array<bool, 64> x68_{};
|
2018-12-08 05:30:43 +00:00
|
|
|
std::vector<std::pair<CAssetId, TEditorId>> xac_cinematicStates; /* (MLVL, Cinematic) */
|
|
|
|
u32 xbc_autoMapperKeyState = 0;
|
|
|
|
u32 xc0_frozenFpsCount = 0;
|
|
|
|
u32 xc4_frozenBallCount = 0;
|
|
|
|
u32 xc8_powerBombAmmoCount = 0;
|
|
|
|
u32 xcc_logScanPercent = 0;
|
|
|
|
|
|
|
|
union {
|
|
|
|
struct {
|
|
|
|
bool xd0_24_fusionLinked : 1;
|
|
|
|
bool xd0_25_normalModeBeat : 1;
|
|
|
|
bool xd0_26_hardModeBeat : 1;
|
|
|
|
bool xd0_27_fusionBeat : 1;
|
|
|
|
bool xd0_28_fusionSuitActive : 1;
|
|
|
|
bool xd0_29_allItemsCollected : 1;
|
2016-09-25 01:58:20 +00:00
|
|
|
};
|
2018-12-08 05:30:43 +00:00
|
|
|
u16 _dummy = 0;
|
|
|
|
};
|
2016-09-25 01:58:20 +00:00
|
|
|
|
|
|
|
public:
|
2018-12-08 05:30:43 +00:00
|
|
|
CPersistentOptions() = default;
|
|
|
|
CPersistentOptions(CBitStreamReader& stream);
|
|
|
|
|
|
|
|
bool GetCinematicState(CAssetId mlvlId, TEditorId cineId) const;
|
|
|
|
void SetCinematicState(CAssetId mlvlId, TEditorId cineId, bool state);
|
|
|
|
u32 GetAutoMapperKeyState() const { return xbc_autoMapperKeyState; }
|
|
|
|
void SetAutoMapperKeyState(u32 s) { xbc_autoMapperKeyState = s; }
|
|
|
|
bool GetPlayerLinkedFusion() const { return xd0_24_fusionLinked; }
|
|
|
|
void SetPlayerLinkedFusion(bool v) { xd0_24_fusionLinked = v; }
|
|
|
|
bool GetPlayerBeatNormalMode() const { return xd0_25_normalModeBeat; }
|
|
|
|
void SetPlayerBeatNormalMode(bool v) { xd0_25_normalModeBeat = v; }
|
|
|
|
bool GetPlayerBeatHardMode() const { return xd0_26_hardModeBeat; }
|
|
|
|
void SetPlayerBeatHardMode(bool v) { xd0_26_hardModeBeat = v; }
|
|
|
|
bool GetPlayerBeatFusion() const { return xd0_27_fusionBeat; }
|
|
|
|
void SetPlayerBeatFusion(bool v) { xd0_27_fusionBeat = v; }
|
|
|
|
bool GetPlayerFusionSuitActive() const { return xd0_28_fusionSuitActive; }
|
|
|
|
void SetPlayerFusionSuitActive(bool v) { xd0_28_fusionSuitActive = v; }
|
|
|
|
bool GetAllItemsCollected() const { return xd0_29_allItemsCollected; }
|
|
|
|
void SetAllItemsCollected(bool v) { xd0_29_allItemsCollected = v; }
|
|
|
|
u32 GetLogScanPercent() const { return xcc_logScanPercent; }
|
|
|
|
void SetLogScanPercent(u32 v) { xcc_logScanPercent = v; }
|
|
|
|
void IncrementFrozenFpsCount() { xc0_frozenFpsCount = std::min(int(xc0_frozenFpsCount + 1), 3); }
|
|
|
|
bool GetShowFrozenFpsMessage() const { return xc0_frozenFpsCount != 3; }
|
|
|
|
void IncrementFrozenBallCount() { xc4_frozenBallCount = std::min(int(xc4_frozenBallCount + 1), 3); }
|
|
|
|
bool GetShowFrozenBallMessage() const { return xc4_frozenBallCount != 3; }
|
|
|
|
bool GetShowPowerBombAmmoMessage() const { return xc8_powerBombAmmoCount != 1; }
|
|
|
|
void IncrementPowerBombAmmoCount() { xc8_powerBombAmmoCount = std::min<u32>(1, xc8_powerBombAmmoCount + 1); }
|
|
|
|
|
|
|
|
void PutTo(CBitStreamWriter& w) const;
|
|
|
|
|
2019-08-14 06:49:40 +00:00
|
|
|
u8* GetNESState() { return x0_nesState.data(); }
|
|
|
|
const u8* GetNESState() const { return x0_nesState.data(); }
|
2016-09-25 01:58:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/** Options tracked per game session */
|
2018-12-08 05:30:43 +00:00
|
|
|
class CGameOptions {
|
2019-08-14 06:49:40 +00:00
|
|
|
std::array<u8, 64> x0_{};
|
2018-12-08 05:30:43 +00:00
|
|
|
CAudioSys::ESurroundModes x44_soundMode = CAudioSys::ESurroundModes::Stereo;
|
|
|
|
u32 x48_screenBrightness = 4;
|
|
|
|
s32 x4c_screenXOffset = 0;
|
|
|
|
s32 x50_screenYOffset = 0;
|
|
|
|
s32 x54_screenStretch = 0;
|
|
|
|
u32 x58_sfxVol = 0x7f;
|
|
|
|
u32 x5c_musicVol = 0x7f;
|
|
|
|
u32 x60_hudAlpha = 0xff;
|
|
|
|
u32 x64_helmetAlpha = 0xff;
|
|
|
|
|
|
|
|
s32 m_gamma = 0;
|
|
|
|
|
|
|
|
union {
|
|
|
|
struct {
|
|
|
|
bool x68_24_hudLag : 1;
|
|
|
|
bool x68_25_invertY : 1;
|
|
|
|
bool x68_26_rumble : 1;
|
|
|
|
bool x68_27_swapBeamsControls : 1;
|
|
|
|
bool x68_28_hintSystem : 1;
|
2016-09-25 01:58:20 +00:00
|
|
|
};
|
2018-12-08 05:30:43 +00:00
|
|
|
u16 _dummy = 0;
|
|
|
|
};
|
2016-09-25 01:58:20 +00:00
|
|
|
|
2018-12-08 05:30:43 +00:00
|
|
|
std::vector<std::pair<CAssetId, CAssetId>> x6c_controlTxtrMap;
|
2016-09-25 01:58:20 +00:00
|
|
|
|
|
|
|
public:
|
2018-12-08 05:30:43 +00:00
|
|
|
CGameOptions();
|
|
|
|
CGameOptions(CBitStreamReader& stream);
|
|
|
|
void ResetToDefaults();
|
|
|
|
void InitSoundMode();
|
|
|
|
void EnsureSettings();
|
|
|
|
void PutTo(CBitStreamWriter& writer) const;
|
|
|
|
|
|
|
|
float TuneScreenBrightness();
|
|
|
|
void SetScreenBrightness(s32, bool);
|
|
|
|
s32 GetScreenBrightness() const { return x48_screenBrightness; }
|
|
|
|
void ApplyGamma();
|
|
|
|
void SetGamma(s32, bool);
|
|
|
|
s32 GetGamma() const { return m_gamma; }
|
|
|
|
void SetScreenPositionX(s32, bool);
|
|
|
|
s32 GetScreenPositionX() const { return x4c_screenXOffset; }
|
|
|
|
void SetScreenPositionY(s32, bool);
|
|
|
|
s32 GetScreenPositionY() const { return x50_screenYOffset; }
|
|
|
|
void SetScreenStretch(s32, bool);
|
|
|
|
s32 GetScreenStretch() const { return x54_screenStretch; }
|
|
|
|
void SetSfxVolume(s32, bool);
|
|
|
|
s32 GetSfxVolume() const { return x58_sfxVol; }
|
|
|
|
void SetMusicVolume(s32, bool);
|
|
|
|
s32 GetMusicVolume() const { return x5c_musicVol; }
|
|
|
|
void SetHUDAlpha(u32);
|
|
|
|
u32 GetHUDAlpha() const { return x60_hudAlpha; }
|
|
|
|
void SetHelmetAlpha(u32);
|
|
|
|
u32 GetHelmetAlpha() const { return x64_helmetAlpha; }
|
|
|
|
void SetHUDLag(bool);
|
|
|
|
bool GetHUDLag() const { return x68_24_hudLag; }
|
|
|
|
void SetSurroundMode(int mode, bool apply);
|
|
|
|
CAudioSys::ESurroundModes GetSurroundMode() const;
|
|
|
|
void SetInvertYAxis(bool);
|
|
|
|
bool GetInvertYAxis() const { return x68_25_invertY; }
|
|
|
|
void SetIsRumbleEnabled(bool);
|
|
|
|
bool GetIsRumbleEnabled() const { return x68_26_rumble; }
|
|
|
|
void SetSwapBeamControls(bool);
|
|
|
|
bool GetSwapBeamControls() const { return x68_27_swapBeamsControls; }
|
|
|
|
void SetIsHintSystemEnabled(bool);
|
|
|
|
bool GetIsHintSystemEnabled() const { return x68_28_hintSystem; }
|
|
|
|
void SetControls(int controls);
|
|
|
|
void ResetControllerAssets(int controls);
|
|
|
|
const std::vector<std::pair<CAssetId, CAssetId>>& GetControlTXTRMap() const { return x6c_controlTxtrMap; }
|
|
|
|
|
|
|
|
static void TryRestoreDefaults(const CFinalInput& input, int category, int option, bool frontend, bool forceRestore);
|
|
|
|
static void SetOption(EGameOption option, int value);
|
|
|
|
static int GetOption(EGameOption option);
|
2016-09-25 01:58:20 +00:00
|
|
|
};
|
|
|
|
|
2018-12-08 05:30:43 +00:00
|
|
|
class CHintOptions {
|
2016-09-25 01:58:20 +00:00
|
|
|
public:
|
2018-12-08 05:30:43 +00:00
|
|
|
enum class EHintState { Zero, Waiting, Displaying, Delayed };
|
|
|
|
struct SHintState {
|
|
|
|
EHintState x0_state = EHintState::Zero;
|
|
|
|
float x4_time = 0.f;
|
|
|
|
bool x8_dismissed = false;
|
2016-09-25 01:58:20 +00:00
|
|
|
|
2018-12-08 05:30:43 +00:00
|
|
|
SHintState() = default;
|
|
|
|
SHintState(EHintState state, float time, bool flag) : x0_state(state), x4_time(time), x8_dismissed(flag) {}
|
|
|
|
|
|
|
|
bool CanContinue() const { return x4_time / 3.f <= 1.f; }
|
|
|
|
};
|
2017-02-18 02:19:50 +00:00
|
|
|
|
2016-09-25 01:58:20 +00:00
|
|
|
private:
|
2018-12-08 05:30:43 +00:00
|
|
|
std::vector<SHintState> x0_hintStates;
|
|
|
|
u32 x10_nextHintIdx = -1;
|
|
|
|
|
2016-09-25 01:58:20 +00:00
|
|
|
public:
|
2018-12-08 05:30:43 +00:00
|
|
|
CHintOptions() = default;
|
|
|
|
CHintOptions(CBitStreamReader& stream);
|
|
|
|
void PutTo(CBitStreamWriter& writer) const;
|
|
|
|
void SetNextHintTime();
|
|
|
|
void InitializeMemoryState();
|
|
|
|
const SHintState* GetCurrentDisplayedHint() const;
|
2020-03-14 23:59:58 +00:00
|
|
|
void DelayHint(std::string_view name);
|
|
|
|
void ActivateImmediateHintTimer(std::string_view name);
|
|
|
|
void ActivateContinueDelayHintTimer(std::string_view name);
|
2018-12-08 05:30:43 +00:00
|
|
|
void DismissDisplayedHint();
|
|
|
|
u32 GetNextHintIdx() const;
|
|
|
|
const std::vector<SHintState>& GetHintStates() const { return x0_hintStates; }
|
|
|
|
void Update(float dt, const CStateManager& stateMgr);
|
2015-08-17 20:33:58 +00:00
|
|
|
};
|
|
|
|
|
2018-12-08 05:30:43 +00:00
|
|
|
} // namespace urde
|