fsCAppSettings.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        3/3/2014   11:49
*
*       File:           fsCAppSettings.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Globally accessible application settings as set in
*                               assets/appSettings.txt VariableTable.
*
*********************************************************************/
 
#ifndef fsCAppSettingshdr
#define fsCAppSettingshdr
 
#include <fsCore/src/fsCVariableTable.h>
 
#include <fsCore/src/fsCGlobalSavedData.h>
 
class fsCAppSettings : public fsCVariableTable
{
        friend class fsCAppCoreMain;
 
public:
 
        // Fallback sfx paths used when a title's appSettings.txt doesn't override the
        // corresponding sfx* key. Centralised here so every strGetWithDefault() call
        // site shares one definition instead of retyping the literal.
        static const fsStr kSfxNotFoundDefault;
        static const fsStr kSfxButtonClickDefault;
        static const fsStr kSfxLevelCompleteDefault;
        static const fsStr kParticleMiniGameCollectDefault;
        static const fsStr kParticlePhotoCollectDefault;
        static const fsStr kCaretFileDefault;
 
        fsStr publisherGet() const;
        fsStr buildFlavourGet() const;
        fsBool buildLocaleMultiLingualGet() const;
        fsStr buildLocaleGet() const;
 
#if !defined fsRELEASE
        fsCVariableTable* debugSettingsGet() { return mDebugSettings; }
#endif
 
        virtual ~fsCAppSettings();
 
protected:
 
        static std::unique_ptr<fsCAppSettings> create();
        fsCAppSettings();
 
private:
 
        fsStr versionStrPartGet(fsS32 pPart) const;
 
#if !defined fsRELEASE
        fsCVariableTable* mDebugSettings;
#endif
};
 
#endif