gfICollectableComponent.h

Go to the documentation of this file.

/********************************************************************
**
*       File:           gfICollectableComponent.h
*
*       Purpose:        Entities which can be collected by various methods.
*
*********************************************************************/
 
#ifndef gfICollectableComponenthdr
#define gfICollectableComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
#include <fsAppCore/src/components/fsITutorialEnabledComponent.h>
 
 
class gfICollectableComponent : public fsIMessageListenerComponent, public fsITutorialEnabledComponent
{
        friend class fsCComponentFactory;
 
public:
 
        fsBool playCollectedSFX();
        void collectionShortCircuit();
 
        void collectionProcessTrigger();
 
        void visiblePostCollectionSet(const fsStr& pPostCollectionMarkerFile);
 
        void deactivate();
        void activate();
 
        fsBool collectionEffectPlayingGet() const;
        fsBool isInactivatedGet() const;
        fsBool hasBeenCollectedGet() const;
 
        static const fsCUniqueId mCollectionStartMsg;
        static const fsCUniqueId mCollectionEndMsg;
        static const fsCUniqueId mLevelSkipForceCollectMsg;
 
        struct sEntityCollectedParam : public fsIMessageDispatcher::sMessageParameters
        {
                explicit sEntityCollectedParam(fsCEntity* pEnt) : mEnt(pEnt) {}
                fsCEntity* mEnt;
        };
 
        // Extension point for a consuming genre core (e.g. gfHogCore) to add its
        // own extra "this entity is persistent" tag checks without this generic
        // component needing to know about that genre's entity-tag prefixes.
        static void extraPersistentTagCheckProviderSet(fsBool (*pProvider)(fsCEntity* const pEntity));
 
protected:
 
        enum struct eCOLLECTION_STATE
        {
                eINACTIVE = 0,
                eCOLLECTIBLE,
                eCOLLECTED_EFFECT_PLAYING,
                eCOLLECTED_EFFECT_FINISHED
        };
 
        void stateSet(eCOLLECTION_STATE pState);
        eCOLLECTION_STATE stateGet() const;
 
        virtual void midCollectionHandle();
        virtual fsBool inInactivatedGetDo() const;
        virtual void onCollectionEffectCompleteDo();
        virtual void collectionProcessTriggerDo();
 
        void tutorialCompletedDo(const fsPoint& pPos) override;
 
        void serialiseDo() override;
        void deserialiseDo() override;
        void resetDo() override;
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        gfICollectableComponent(fsCEntity* pParent);
        virtual ~gfICollectableComponent();
 
private:
 
        fsBool instantCollection(std::vector<fsCEntity*> pCollectionEnts) const;
        fsBool collectionProcessComplete() const;
 
        fsBool persistentParentEntity() const;
 
        fsStr postCollectionMarkerNameGet() const;
        void postCollectionMarkerAdd();
 
        fsBool parentContainsNoMandatedCollectableComponents();
        void onCollectionEffectComplete();
 
        fsStr postCollectionLayerParticleEffectFileNameGet() const;
        void postCollectionParticleEffectEnable() const;
        void createdEffectDisable(const fsStr& pEntName);
        fsCEntity* const createdEffectEntGet(const fsStr& pEntName);
 
        virtual void activateDo() {}
        virtual void deactivateDo()     {}
 
        eCOLLECTION_STATE mState;
        fsS32 mNumActiveCollectionEffects;
 
        fsBool mCollectionProcessShortCircuited;
        fsBool mPostCollectionEffectHide;
        fsBool mVisiblePostCollection;
        fsStr mPostCollectionMarkerFile;
};
 
#endif