gfICollectionEffectComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        8/4/2014   12:33
*
*       File:           fsICollectionEffectComponent.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Base of all collection effects with helper function
*                               to create appropriate derived versions based on the
*                               entity type.
*
*********************************************************************/
 
#ifndef fsICollectionEffectComponenthdr
#define fsICollectionEffectComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
 
#include <fsAppCore/src/components/fsIComponent.h>
#include <fsAppCore/fsIMessageDispatcher.h>
 
 
class fsICollectionEffectComponent : public fsIComponent
{
public:
 
        static const fsCUniqueId mEffectCompleteMsg;
 
        struct sEffectCompleteParam : public fsIMessageDispatcher::sMessageParameters
        {
                sEffectCompleteParam() = default;
                sEffectCompleteParam(const fsStr& pName, fsS32 pScore) : mCollectedEntityName(pName), mScore(pScore) {}
                fsStr mCollectedEntityName;
                fsS32 mScore;
        };
 
protected:
 
        void onEffectComplete();
 
        fsICollectionEffectComponent(fsCEntity* pParent);
        virtual ~fsICollectionEffectComponent();
 
private:
 
        sEffectCompleteParam mMsgParams;
};
 
#endif