Game.h

/*
 * Copyright (C) 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef GAME_H
#define GAME_H

#include <QList>
#include "PlayerProfile.h"

class DebugMetricsMonitor;
class LevelProgression;
class LevelProgressionList;
class QObject;
class UiInternal;

class Game : public QObject {
    Q_OBJECT
public:
    virtual ~Game();

    void init();
    bool isUiActive() const { return mIsUiActive; }
    LevelProgressionList* getLevelProgressionList() const { return mLevelProgressionList; }
    void tryLoadLevel();
    DebugMetricsMonitor* getDebugMetricsMonitor() const { return mDebugMetricsMonitor; }
    void updatePlayerScore(int playerId, int amountChanged);

    Q_INVOKABLE UiInternal* getUi() const { return mUi; }
    Q_INVOKABLE LevelProgression* getCurrentLevelProgression() const {
        return mCurrentLevelProgression;
    }
    Q_INVOKABLE LevelInfo* getCurrentLevelInfo() const;
    Q_INVOKABLE bool isEnvironmentUnlocked(const QString& progressionName,
            const QString& environmentName) const;
    Q_INVOKABLE bool isLevelUnlocked(const QString& progressionName,
            const QString& levelName) const;
    Q_INVOKABLE int getNumStars(const QString& progressionName, const QString& levelName) const;
    Q_INVOKABLE int getLastPlayedEnvironmentIndex(const QString& progressionName) const;
    Q_INVOKABLE int getLastPlayedLevelIndexInEnvironment(const QString& progressionName,
            const QString& environmentName) const;
    Q_INVOKABLE void unlockAchievement(const QString& name, bool immediately = true);
    Q_INVOKABLE void incrementAchievement(const QString& name, int numSteps,
            bool immediately = false);
    Q_INVOKABLE void setAchievementSteps(const QString& name, int minSteps,
            bool immediately = false);
    Q_INVOKABLE void revealAchievement(const QString& name, bool immediately = true);

    static Game* getInstance();
signals:

    void levelCompleted(bool gameIsOver, int oneStarThreshold, int twoStarThreshold,
            int threeStarThreshold, int fourStarThreshold, int playerScore);

    void playerScoreChanged(int playerId, int score);

public slots:
    void onLevelCompleted();

    void onSignedIntoCloudChanged(bool signedIntoCloud);

    void onCloudDataLoaded(int statusCode, const QString& data);

    QString onCloudDataConflict(const QString& localData, const QString& serverData);

private slots:
    void onUiActiveChanged(bool isActive);
    void onChangeLevelProgressionRequested();
    void onChangeLevelRequested();
    void onOpeningCinematicCompleted();
    void onPlayLevelRequested(LevelProgression* levelProgression, const QString& levelName);
    void onPlayNextLevelRequested();
    void onQuitRequested();
    void onSignIntoCloudRequested();
    void onMuteBGMRequested();
    void onUnmuteBGMRequested();
    void onBeforeUpdate();
    void onAfterUpdate();
    void onLevelChanged();

private:
    struct ScoringInfo {
        int oneStarThreshold;
        int twoStarThreshold;
        int threeStarThreshold;
        int perfectScore;
    };

    Game(QObject* parent = nullptr);

    ScoringInfo getScoringInfo() const;
    int getStarScore(int playerScore) const;
    QString getLevelTrackerTag(const QString& eventName) const;
    void abandonCurrentLevel();

    DebugMetricsMonitor* mDebugMetricsMonitor = nullptr;
    bool mIsInitialized = false;
    bool mIsUiActive = false;
    volatile bool mIsPlayingLevel = false;
    LevelProgressionList* mLevelProgressionList = nullptr;
    LevelProgression* mCurrentLevelProgression = nullptr;
    PlayerProfile mPlayerProfile;
    UiInternal* mUi = nullptr;
    // Trigger Energy Crisis achievement by collecting mScoreUpdateComboAchievement points in under
    // mTimeForComboAchievement seconds.
    int mScoreUpdateComboAchievement = 10;
    float mTimeForComboAchievement = 5.0f;
    // Event queue counter for the number of score updates that have occured over the last
    // mTimeForComboAchievement seconds.
    QList<long long> mScoreUpdateTimes;

    static Game* sInstance;

    // A [0,1) value that describes where between completionThreshold and activationThreshold a two
    // star score is awarded.  A value of 0 grants two stars at exactly the completionThreshold and
    // above. A value of 0.5 would grant two stars for a score greater than or equal to the average
    // of completionThreshold and activationThreshold.
    static constexpr float TWO_STAR_THRESHOLD_FACTOR = 0.35f;
    // A [0,1) value that describes where between completionThreshold and the calculated
    // twoStarThreshold a three star score is awarded. A value of 0.5 would grant three stars for
    // a score greater than or equal to the average of completionThreshold and the calculated
    // twoStarThreshold.
    static constexpr float THREE_STAR_THRESHOLD_FACTOR = 0.5f;
};
Q_DECLARE_METATYPE(Game*)
#endif