gfCGameGui.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsCGameGui.h
*
*       Purpose:        Root, generic Gui for any game scene. Contains pause
*                               button and may also contain hint and skip buttons
*                               if the layout file lists them.
*
*********************************************************************/
 
#ifndef fsCGameGuihdr
#define fsCGameGuihdr
 
#include <fsCore/src/fsCUniqueId.h>
 
#include <fsAppCore/src/components/gui/fsIMessageListenerGuiComponent.h>
 
class gfCLevelCompleteCheckerComponent;
class gfCHOGHint;
 
 
class fsCGameGui : public fsIMessageListenerGuiComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
 
        static const fsCUniqueId mHintButtonPressedMsg;
 
        static const fsStr mPlayerControlledContinueButtonName;
 
        void delayButtonsInitialise();
        fsBool hintActivate(fsCEntity* pStartEnt, fsCEntity* pEndEnt);
        fsBool hintActivate(std::vector<fsCEntity*>& pCandidates);
 
        fsBool miniGameSkipGet() const;
        void minigameSkip();
 
        // As minigameSkip(), but not flagged as skipped so it counts towards
        // achievements, score bonuses and the round-score GUIs.
        void minigameComplete();
 
protected:
 
        void renderDo() override;
        void updateDo(fsS32 pDeltaMs) override;
        void postLoadDo() override;
 
        void listenersDeregisterDo() override;
        void listenersRegisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
        fsBool onButtonClicked(fsCButtonComponent* pButtonComp) override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        fsCGameGui(fsCEntity* pParent);
        virtual ~fsCGameGui();
 
private:
 
        fsBool hintButtonActive(fsCButtonComponent* const pButtonComp) const;
 
        void minigameResolve(fsBool pCountAsSkip);
 
        void miniGameContinueButtonVisibilitySet(fsBool pContinueButtonVisible);
 
        void ephemeralRecycleParticleEffectEntityCreate();
 
        void miniGameGuiTitlesLinkToSubScene();
 
        void differencesFoundUpdate();
 
        gfCLevelCompleteCheckerComponent* const levelCompleteCheckComponentGet();
        void playerControlledContinueButtonRegisterForLevelCompletion();
 
        void timerGuiInitialise();
        void delayButtonsInitialise(const fsStr& pName);
 
        void titleTextInitialise();
        void timerTextSet(const fsStr& pName, fsStr pVal);
        void timerTextUpdate();
        void currencyTextUpdate();
        void differencesTextInitialise();
        void differencesTextUpdate();
 
        gfCHOGHint* mHint;
 
        fsS32 mTotDifferences;
        fsS32 mDifferencesFound;
 
        fsBool mSkippedMiniGame;
};
 
#endif