gfCLockComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCLockComponent.h
*
*       Purpose:        An entity which is collected by dragging key entities
*                               onto it.
*
*********************************************************************/
 
#ifndef gfCLockComponenthdr
#define gfCLockComponenthdr
 
#include <vector>
 
#include <fsCore/src/fsCUniqueId.h>
 
#include <gfComponents/components/gfCTappableCollectableComponent.h>
 
class fsISpriteComponent;
 
 
class gfCLockComponent : public gfCTappableCollectableComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
        static const fsStr mEntityPrefix;
 
        void smash();
        fsBool lockedGet() const;
 
        fsBool keyConsumed(fsCEntity* pKeyEnt, fsCEntity* pDragDropEnt);
        fsBool keyUsable(fsCEntity* pKeyEnt);
        fsBool keyConsumable(fsCEntity* pKeyEnt, fsCEntity* pDragDropEnt);
        fsBool keyOver(fsCEntity* pDragDropEnt);
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        void midCollectionHandle() override;
 
        void serialiseDo() override;
        void deserialiseDo() override;
 
        void deactivateDo() override;
 
        void collectionProcessTriggerDo() override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCLockComponent(fsCEntity* pParent);
        virtual ~gfCLockComponent();
 
private:
 
        void hintStringExistsCheck() const;
 
        void lockKeysStateSave();
        void lockKeysStateLoad();
 
        void onCollectionEffectCompleteDo() override;
 
        void initialiseFromName();
 
        static const fsStr mInOrderPrefix;
 
        std::vector<std::pair<fsStr, fsBool>>::iterator keyLocate(const fsStr& pKeyName);
 
        std::vector<std::pair<fsStr, fsBool>> mKeys;
        fsStr mTaskName;
 
        fsBool mInOrderLock;
};
 
#endif