fsCUserSavedData.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        28/3/2014   10:55
*
*       File:           fsCUserSavedData.h
*
*       Author:         Mick Waites
*       
*       Purpose:        User settings
*
*********************************************************************/
 
#ifndef fsCUserSavedDatahdr
#define fsCUserSavedDatahdr
 
#include <memory>
 
#include <fsCore/fsStr.h>
#include <fsCore/src/debug/fsAssert.h>
 
#include <fsCore/fsISavedData.h>
 
 
class fsCUserSavedData : public fsISavedData
{
        friend class fsCProfileManager;
 
public:
 
        enum class eDIFFICULTY
        {
                eCASUAL,
                eCHALLENGE,
                eEXTREME
        };
 
        enum class eCHEAT_MODE
        {
                eRELEASE,
                eDEV
        };
 
 
        static const fsStr mGameChapter;
 
        static const fsStr mFacebookLoggedIn;
        static const fsStr mVirtualCurrency;
 
        static const fsStr mMusicVolumeKey;
        static const fsStr mEffectsVolumeKey;
        static const fsStr mMuteAllKey;
        static const fsStr mFullScreenKey;
        static const fsStr mCustomCursorsKey;
        static const fsStr mLeftHandCursorsKey;
 
        static const fsStr mCurrentLocation;
        static const fsStr mMapLocation;
 
        static const fsStr mLevelDataPrefix;
        static const fsStr mLevelStatePrefix;
 
        static const fsStr mLastMainMenuGui;
 
 
#if defined fsInAppPurchaseProcess
        fsS32 levelsVisitedCountGet() const;
#endif
 
        fsBool cheatModeGet(eCHEAT_MODE pMode) const;
 
        fsBool levelHasBeenVisitedGet(const fsStr& pLevel) const;
        fsBool gameHasBeenStartedGet() const;
 
        eDIFFICULTY difficultyGet() const;
        void difficultySet(eDIFFICULTY pDifficulty);
 
        fsS32 countGet(const fsStr& pKey) const;
        void countInc(const fsStr& pKey);
 
        void s32Inc(const fsStr& pKey);
 
        void resetForNewPlayer();
        void resetGameProgress();
 
        virtual ~fsCUserSavedData();
 
        template <typename T>
        static std::unique_ptr<T> create();
 
protected:
 
        virtual void resetForNewPlayerDo();
        virtual void resetGameProgressDo();
 
        void resetToDefaultsDo() override;
 
        fsCUserSavedData();
 
private:
 
        static const fsStr mCheatModeKey;
 
        static const fsStr mGamelDifficulty;
 
#if !defined fsRELEASE
        fsBool mHierarchyCheckSuccess;
#endif
};
 
template <typename T>
std::unique_ptr<T> fsCUserSavedData::create()
{
        static fsBool created = false;
        if (!created)
        {
                created = true;
                std::unique_ptr<T> userData(new T());
                userData->resetToDefaults();
                userData->resetGameProgress();
                return userData;
        }
        fsAssert(false, "Only one instance of hog user saved data!");
        return nullptr;
}
 
#endif