gfCLevelCompleteCheckerComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsCLevelCompleteCheckerComponent.h
*
*       Purpose:        Creates and tracks flags for level completion sending
*                               out a message when they are all set.
*
*********************************************************************/
 
#ifndef gfCLevelCompleteCheckerComponenthdr
#define gfCLevelCompleteCheckerComponenthdr
 
#include <map>
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
 
class gfCLevelCompleteCheckerComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        struct sRequirementParam : public fsIMessageDispatcher::sMessageParameters
        {
                explicit sRequirementParam(const fsStr& pName) : mRequirementName(pName) {}
                fsStr mRequirementName;
        };
 
        void congratulationsGuiRegister();
 
        fsBool playerControlledLevelCompleteKeyPressed();
        void playerControlledLevelCompleteKeyRegister();
 
        static const fsCUniqueId mTypeId;
 
        static const fsCUniqueId mLevelCompleteWaitingMsg;
        static const fsCUniqueId mLevelCompleterMsg;
        static const fsCUniqueId mLevelCompleteWaitingCongratsMsg;
        static const fsCUniqueId mLevelCompleterCongratsMsg;
 
        static const fsCUniqueId mRequirementRegisterMsg;
        static const fsCUniqueId mRequirementMetMsg;
        static const fsCUniqueId mRequirementClearMsg;
        static const fsCUniqueId mRequirementRemoveMsg;
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCLevelCompleteCheckerComponent(fsCEntity* pParent);
        virtual ~gfCLevelCompleteCheckerComponent();
 
private:
 
        void requirementRemove(const fsStr& pRequirementName);
        void requirementClear(const fsStr& pRequirementName);
        void requirementRegister(const fsStr& pRequirementName);
        void requirementStatusProcess(const fsStr& pRequirementName, fsBool pRequirementMet);
        fsBool allRequirementsMetCheck();
 
        std::map<fsStr, fsBool> mCompletionList;
 
        fsBool mPlayerControlledLevelCompleteKey;
        fsBool mCongratulationsGui;
};
 
#endif