gfCAchievementsTriggerComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCAchievementsTriggerComponent.h
*
*       Purpose:        Generic control for what happens when an achievement
*                               might unlock: perfect-game tracking, mini-game and
*                               hint-free-level bonuses, the achievement-effect popup
*                               callback, and the per-collectible/per-purchase counters.
*                               Was CGameSpecificAchievementsComponent — turned out
*                               identical in every title sampled, including
*                               bonusBonusCount: its achievement name isn't hardcoded
*                               anywhere, it's read from whichever entry in the title's
*                               own achievementsMap.txt has SaveKey=bonusBonusCount — the
*                               same file already drives everything else here. No-op if
*                               a title's map has no such entry.
*
*********************************************************************/
 
#ifndef gfCAchievementsTriggerComponenthdr
#define gfCAchievementsTriggerComponenthdr
 
#include <vector>
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
class fsStr;
struct fsPoint;
 
class gfCAchievementsTriggerComponent : public fsIMessageListenerComponent
{
public:
 
        static const fsCUniqueId mTypeId;
        static const fsStr mAchievementKey;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        static void callback(const fsStr& pAchievment, const fsPoint& pPos);
 
        gfCAchievementsTriggerComponent(fsCEntity* pParent);
        virtual ~gfCAchievementsTriggerComponent();
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        // External achievement-service id for hintsFreeLevelUpdate(); empty by default.
        virtual fsStr platformHintAchievementIdGet() const;
 
        void perfectGameUpdate();
        fsBool perfectThisLevel() const;
 
        fsBool perfectGameGet() const;
 
        void completedGameUpdate();
        void completedMiniGamesUpdate();
        void hintsFreeLevelUpdate();
 
        fsBool achievementAward(const fsStr& pAchievment, const fsPoint& pPos);
 
        void achievementsRegister();
 
        void photoCount(fsCEntity* pEnt);
        void souvenirCount(fsCEntity* pEnt);
        void birdCount(fsCEntity* pEnt);
        void insectCount(fsCEntity* pEnt);
        void endangeredCount(fsCEntity* pEnt);
 
        void bonusBonusCount(fsCEntity* pEnt);
 
        fsS32 mSprinterGameTime;
        fsS32 mMiniGameTime;
 
        static gfCAchievementsTriggerComponent* mInstance;
 
        std::vector<fsStr> mAchievmentNames;
 
        // Achievement name whose achievementsMap.txt entry has
        // SaveKey=bonusBonusCount, filled in by achievementsRegister(). Empty if
        // the title's map has no such entry.
        fsStr mBonusBonusAchievementKey;
};
 
#endif