fsILevelBasedAppCoreMain.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsILevelBasedAppCoreMain.h
*
*       Purpose:        Interface for level based apps
*
*********************************************************************/
 
#ifndef fsILevelBasedAppCoreMainhdr
#define fsILevelBasedAppCoreMainhdr
 
#include <memory>
#include <vector>
 
#include <fsAppCore/src/fsCAppCoreMain.h>
#include <fsCore/src/fsCUniqueId.h>
 
class fsIRunningOrder;
class fsCVariableTable;
class fsISubSceneComponent;
 
class fsILevelBasedAppCoreMain : public fsCAppCoreMain
{
        friend class gfCDebugJustCollectablesView;
 
public:
 
        static const fsCUniqueId mLevelInitialisedMsg;
        static const fsCUniqueId mLevelEntitiesCreatedMsg;
        static const fsCUniqueId mLevelPostResetMsg;
        void chapterEnable();
        static void chapterLoaderEnable();
 
        void chapterClear();
        static fsStr chapterFolderGet();
        std::vector<fsStr>      chaptersGet() const;
 
        static fsStr scenesFolderGet();
        fsStr sceneFolderGet() const;
 
        static fsBool collectorsEditionContent(const fsStr& pLevelName);
 
        static fsILevelBasedAppCoreMain* instanceGet();
 
        fsS32 levelCountGet() const;
        fsS32 currLevelPosGet() const;
 
        fsISubSceneComponent* currentSubSceneGet() const;
        void subScenesStore();
 
        fsCVariableTable* levelSettingsGet() const;
 
        void quitToMenuSet();
 
        fsStr currentLevelNameGet() const;
 
        void levelCompleteSet();
        void gameSingleLevel();
        void gameContinue();
        void newGameStart();
        void nextLocationSet(const fsStr& pNextLevelName);
        fsStr nextLocationGet() const;
        fsStr nextLocationGet(const fsStr& pCurrentLocation) const;
        const fsStr& firstLocationGet() const;
 
        const std::vector<fsStr>& rawSequenceGet() const;
        // True when the running order came from a consolidated runningOrder.gui.
        // Lets a level-discovery consumer (e.g. gfCLevelSequencerComponent) know
        // per-scene config no longer requires <name>.txt to exist on disk.
        fsBool runningOrderGuiModeGet() const;
 
        virtual void runningOrderCreate() = 0;
        virtual void runningOrderReplace(const std::vector<fsStr> pNewOrder) = 0;
 
protected:
 
        fsBool nextLocationReady() const;
 
        void postInitialiseDo() override;
 
        void nextLocationInitialise();
 
        virtual void nextLocationInitialiseDo(const fsStr& pLevelName)
        {
        }
 
        fsILevelBasedAppCoreMain();
        virtual ~fsILevelBasedAppCoreMain();
 
        void chaptersLocate();
 
        fsIRunningOrder* mRunningOrder;
        fsStr mCurrentLevelName;
        fsStr mCurrentChapter;
 
private:
 
        void cachesFlush();
 
        void currentSubSceneBackgroundVisiblityToggle(fsBool pRender);
 
        void levelSettingsLoad();
 
    static const fsStr mScenesFolder;
        static const fsStr mChaptersFolder;
 
        std::unique_ptr<fsCVariableTable> mLevelSettings;
 
        std::vector<fsISubSceneComponent*> mSubScenes;
 
        std::vector<fsStr> mChapters;
};
 
#endif