gfCTutorialProgressionComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCTutorialProgressionComponent.h
*
*       Purpose:        Keep generating particles to show the targeted
*                               tutorial entity
*
*********************************************************************/
 
#ifndef gfCTutorialProgressionComponenthdr
#define gfCTutorialProgressionComponenthdr
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
struct fsPoint;
class fsCEntity;
class fsCResourceName;
 
 
class gfCTutorialProgressionComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        fsBool clickOnMe(fsCEntity* pTarget) const;
 
        static const fsCUniqueId mTypeId;
        virtual ~gfCTutorialProgressionComponent();
 
protected:
 
        void deserialiseDo() override;
        void serialiseDo() override;
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        void updateDo(fsS32 pDeltaMs) override;
 
        static fsIComponent* create(fsCEntity* pParent);
        gfCTutorialProgressionComponent(fsCEntity* pParent);
 
private:
 
        struct fsSTutorial
        {
                enum eType
                {
                        eOBJECT,
                        eBUTTON
                };
 
                fsSTutorial(const fsStr& pCommand, const fsStr& pHint);
                fsStr mHint;
                fsStr mTargetEntityName;
                eType mType;
                fsBool mRun;
        };
 
        void clearTutorial(const fsCEntity* pEntity);
 
        fsCEntity* const itemTypeAlwaysCollectable(const fsStr& pItemType) const;
 
        void cleanUp();
        void particleEffectCreate(fsCEntity* pTutorialEntity, fsCEntity* pTutorialDialogueEntity);
        void nextTutorialActivate();
        fsCEntity* const targetEntityGet();
 
        fsCEntity* const tutorialDialogueCreate() const;
        fsCEntity* const tutorialTextSet(fsStr pTutorialHint) const;
        void tutorialDialogueDestroy() const;
 
        std::vector<fsSTutorial> mCommands;
        fsS32 mCurrentCommand;
 
        fsBool mCommandActive;
        fsS32 mRunningTime;
 
        fsCEntity* mTargetEntity;
};
 
#endif