ScreenGameplay.h

#ifndef SCREEN_GAMEPLAY_H
#define SCREEN_GAMEPLAY_H
 
#include "Etterna/Models/Misc/AutoKeysounds.h"
#include "Etterna/Actor/Base/BitmapText.h"
#include "Etterna/Models/Misc/GameplayAssist.h"
#include "Etterna/Models/Misc/InputEventPlus.h"
#include "Etterna/Models/Misc/LocalizedString.h"
#include "Etterna/Actor/Gameplay/LyricDisplay.h"
#include "RageUtil/Sound/RageSound.h"
#include "Etterna/Screen/Others/ScreenWithMenuElements.h"
#include "Etterna/Models/Misc/ThemeMetric.h"
#include "Etterna/Actor/GameplayAndMenus/Transition.h"
#include "Etterna/Models/Misc/PlayerInfo.h"
 
class LifeMeter;
class Background;
class Foreground;
 
AutoScreenMessage(SM_NotesEnded);
AutoScreenMessage(SM_BeginFailed);
AutoScreenMessage(SM_LeaveGameplay);
 
class ScreenGameplay : public ScreenWithMenuElements
{
  public:
    ScreenGameplay();
    void Init() override;
    ~ScreenGameplay() override;
    void BeginScreen() override;
 
    void Update(float fDeltaTime) override;
    bool Input(const InputEventPlus& input) override;
    void HandleScreenMessage(const ScreenMessage& SM) override;
    void HandleMessage(const Message& msg) override;
    void Cancel(ScreenMessage smSendWhenDone) override;
 
    void DrawPrimitives() override;
 
    ScreenType GetScreenType() const override { return gameplay; }
 
    static bool Center1Player();
 
    // Lua
    void PushSelf(lua_State* L) override;
    PlayerInfo* GetPlayerInfo();
 
    void FailFadeRemovePlayer(PlayerInfo* pi);
    void BeginBackingOutFromGameplay();
 
    void RestartGameplayForLua() { RestartGameplay(); }
 
    // Get current position of the song during gameplay
    const float GetSongPosition();
 
  protected:
    virtual void UpdateStageStats(
      MultiPlayer /* mp */){}; // overridden for multiplayer
 
    virtual bool UseSongBackgroundAndForeground() const { return true; }
    virtual void LoadPlayer();
    virtual void ReloadPlayer();
    virtual void LoadScoreKeeper();
    virtual void RestartGameplay();
 
    ThemeMetric<std::string> PLAYER_TYPE;
    ThemeMetric<std::string> SCORE_DISPLAY_TYPE;
    ThemeMetric<apActorCommands> PLAYER_INIT_COMMAND;
    LocalizedString GIVE_UP_START_TEXT;
    LocalizedString GIVE_UP_BACK_TEXT;
    LocalizedString GIVE_UP_ABORTED_TEXT;
    LocalizedString SKIP_SONG_TEXT;
    ThemeMetric<float> GIVE_UP_SECONDS;
    ThemeMetric<float> MUSIC_FADE_OUT_SECONDS;
    ThemeMetric<float> OUT_TRANSITION_LENGTH;
    ThemeMetric<float> BEGIN_FAILED_DELAY;
    ThemeMetric<float> MIN_SECONDS_TO_STEP;
    ThemeMetric<float> MIN_SECONDS_TO_MUSIC;
    ThemeMetric<float> MIN_SECONDS_TO_STEP_NEXT_SONG;
    ThemeMetric<std::string> SONG_NUMBER_FORMAT;
 
    void SetupSong(int iSongIndex);
    void ReloadCurrentSong();
    virtual void LoadNextSong();
    void StartPlayingSong(float fMinTimeToNotes, float fMinTimeToMusic);
    void GetMusicEndTiming(float& fSecondsToStartFadingOutMusic,
                           float& fSecondsToStartTransitioningOut);
    void PlayAnnouncer(const std::string& type,
                       float fSeconds,
                       float* fDeltaSeconds);
    void PlayAnnouncer(const std::string& type, float fSeconds)
    {
        PlayAnnouncer(type, fSeconds, &m_fTimeSinceLastDancingComment);
    }
    void SendCrossedMessages();
 
    void PlayTicks();
    // Used to update some pointers
    void UpdateSongPosition();
    void SongFinished();
    virtual void SaveStats();
    virtual void StageFinished(bool bBackedOut);
    bool AllAreFailing();
 
    virtual void SetupNoteDataFromRow(Steps* pSteps, int minRow = 0,
                              int maxrow = MAX_NOTE_ROW);
 
    virtual void InitSongQueues();
 
    enum DancingState
    {
        STATE_INTRO =
          0, 
        STATE_DANCING, 
        STATE_OUTRO, 
        NUM_DANCING_STATES
    } m_DancingState;
 
    std::vector<Song*> m_apSongsQueue;
    std::vector<float> ratesqueue;
    std::vector<std::string> playlistscorekeys;
 
    // this counter is only running while
    // STATE_DANCING
    float m_fTimeSinceLastDancingComment;
 
    LyricDisplay m_LyricDisplay;
 
    Background* m_pSongBackground;
    Foreground* m_pSongForeground;
    RageTimer m_initTimer;
 
    Transition m_NextSong;
 
    bool m_bShowScoreboard;
 
    BitmapText m_textDebug;
 
    RageTimer m_GiveUpTimer;
    bool m_gave_up;
    void AbortGiveUpText(bool show_abort_text);
    void AbortGiveUp(bool bShowText);
    void ResetGiveUpTimers(bool show_text);
 
    RageTimer m_DiscordRPCCheckTimer;
    void CheckDiscordRPCTimer();
    void TriggerDiscordRPCUpdate();
 
    Transition m_Ready;
    Transition m_Go;
    Transition m_Failed;
    Transition m_Toasty;
 
    AutoKeysounds m_AutoKeysounds;
 
    bool m_bZeroDeltaOnNextUpdate;
 
    GameplayAssist m_GameplayAssist;
    RageSound* m_pSoundMusic;
 
    // filled by SGameplay derivatives in FillPlayerInfo
    std::vector<PlayerInfo> m_vPlayerInfo{};
    virtual void FillPlayerInfo(std::vector<PlayerInfo>& vPlayerInfoOut) = 0;
 
    RageTimer m_timerGameplaySeconds;
 
    // m_delaying_ready_announce is for handling a case where the ready
    // announcer sound needs to be delayed.  See HandleScreenMessage for more.
    // -Kyz
    bool m_delaying_ready_announce;
 
    // True when the player hit RestartGameplay
    bool m_bRestarted = false;
};
#endif