gfCDayEconomySim.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCDayEconomySim.h
*
*       Purpose:        Headless day economy/scoring: coins earned from service
*                               purchases, visitor outcomes, and a coin-goal-based star
*                               rating. Real currency types, catalogue unlock-level
*                               feed-through and running-order integration are later
*                               design work.
*
*********************************************************************/
 
#ifndef gfCDayEconomySimhdr
#define gfCDayEconomySimhdr
 
#include <fsCore/fsBaseTypes.h>
 
class gfCDayEconomySim
{
public:
 
        gfCDayEconomySim(fsS32 pCoinGoal);
 
        // A purchase and the visitor's final opinion are separate events. This lets
        // an empty park host happy walkers without creating phantom income, and lets
        // one visitor use several services without being counted several times.
        void servicePurchasedHandle(fsS32 pSpend);
        void guestLeftHappyHandle(fsS32 pSatisfactionPercent = 100);
        void guestLeftUnhappyHandle(fsS32 pSatisfactionPercent = 0);
 
        // Restores a coin total from a save (mid-progress save/restore, Phase
        // 6) - not part of the normal guest-served flow above.
        void coinsSet(fsS32 pCoins) { mCoins = pCoins; }
        void progressSet(fsS32 pCoins, fsS32 pHappyCount, fsS32 pUnhappyCount,
                         fsS32 pServicesPurchasedCount, fsS32 pSatisfactionTotal);
 
        fsS32 coinsGet() const { return mCoins; }
        fsS32 happyCountGet() const { return mHappyCount; }
        fsS32 unhappyCountGet() const { return mUnhappyCount; }
        fsS32 servicesPurchasedCountGet() const { return mServicesPurchasedCount; }
        fsS32 satisfactionTotalGet() const { return mSatisfactionTotal; }
        fsS32 satisfactionAveragePercentGet() const;
        // Reputation changes gradually, so one poor day cannot erase a developed
        // park and one good day cannot instantly create a five-star destination.
        fsS32 reputationAfterDayGet(fsS32 pCurrentReputation) const;
 
        // 0-3 stars based on coins earned vs the day's coin goal.
        fsS32 starsGet() const;
 
private:
 
        fsS32 mCoins;
        fsS32 mCoinGoal;
        fsS32 mHappyCount;
        fsS32 mUnhappyCount;
        fsS32 mServicesPurchasedCount;
        fsS32 mSatisfactionTotal;
};
 
#endif