gfIHogLevel.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        7/4/2014   13:32
*
*       File:           gfIHogLevel.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Create and control game entities.
*
*********************************************************************/
 
#ifndef gfIHogLevelhdr
#define gfIHogLevelhdr
 
#include <vector>
 
#include <fsCore/fsStr.h>
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
class gfIHogLevel : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
        friend class gfCDebugJustCollectablesView;
        friend class gfCHogCoreMain;
        friend class gfCSimpleCoreMain;
 
public:
 
        fsCEntity* const parentGet() const;
        fsStr levelNameGet() const;
 
        void skip();
        void skippedEntitiesForceCollect();
 
        // As skip(), but collects the optional bonuses and isn't flagged as a
        // skip, so achievements and star ratings see a played-out level.
        void complete();
 
        fsS32 bestLevelRunningTimeGet() const;
        fsS32 levelRunningTimeGet() const;
        fsS32 totalGameRunningTimeGet() const;
        fsStr nextLevelGet() const;
        const fsStr& levelNameFilenameGet() const { return mLevelName; }  
 
        void abort();
 
        void levelStateSave();
        void levelStateRestore(fsStr& pLoadStr);
 
        virtual ~gfIHogLevel();
 
        virtual fsStr sceneFolderGet() const;
        virtual fsStr saveStateKeyGet();
 
protected:
 
        void levelCreate(const fsStr& pLevelName);
 
        void bestRunningTimeSet();
 
        virtual void skipDo(fsBool pCountAsSkip) { (void)pCountAsSkip; }
 
        void bonusEntitiesForceCollect();
        virtual void guiInitDo();
 
        virtual void levelStateSaveDo();
 
        fsBool mapLevelGet() const;
 
        void listenersDeregisterDo() override;
        void listenersRegisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        void resetDo() override;
        void deserialiseDo() override;
        void serialiseDo() override;
        void updateDo(fsS32 pDeltaMs) override;
 
        std::vector<fsCEntity*> minigameEntitiesGet();
 
        void cheatMenuToggle();
 
        virtual void abortDo() {}
        virtual void doLevelCreate() {}
        virtual void doLevelStateRestore() {}
        virtual void doPostEntityCreation() {}
 
        gfIHogLevel(fsCEntity* pParent);
 
private:
 
        void jigsawEntitiesBorderSet();
        void cuttersCut(fsBool pFirstTime);
        void cuttersStencilCreate();
 
        void miniGameHelpSet();
        void guiInit();
        void guiLoad();
 
        void entitiesCreateFromCoordsFile();
 
 
        void tutorialGuiLinkToGui();
 
        fsStr mLevelName;
        fsS32 mLevelRunningTime; //total level running time - we can revisit a level
        fsS32 mRunningTime; //running time for this visit to this level
        fsS32 mBestTime; //best time to complete this level
 
        fsBool mSkippedMiniGame;
    fsBool mWaitingForInterstitialTransition;
 
        enum eRUN_STATE
        {
                eWAITING,
                eRUNNING,
                eDONE
        };
 
        eRUN_STATE mRunning;
};
 
#endif