gfCGuestAgentSim.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCGuestAgentSim.h
*
*       Purpose:        Headless visitor state machine. A visitor arrives, wanders
*                               the park, may satisfy several secondary service needs, then
*                               leaves. See gfCSlotSim.h.
*
*********************************************************************/
 
#ifndef gfCGuestAgentSimhdr
#define gfCGuestAgentSimhdr
 
#include <vector>
 
#include <fsCore/fsStr.h>
#include <fsCore/fsBaseTypes.h>
 
enum class eGuestSimState
{
        eARRIVING,
        // Exploring is the primary park activity. Need and visit timers advance
        // here; neither advances while walking to or using a service.
        eWANDERING,
        // Assigned a slot but not there yet - just a duration; presentation paces
        // the sprite to match. Without it, service started before arrival.
        eWALKING,
        eQUEUEING,
        eBEING_SERVED,
        eLEAVING_HAPPY,
        eLEAVING_UNHAPPY
};
 
class gfCGuestAgentSim
{
public:
 
        gfCGuestAgentSim(const fsStr& pName, const std::vector<fsStr>& pNeedSlotTypes,
                         fsS32 pSpend, fsS32 pPatienceMs, fsS32 pVisitMs,
                         fsS32 pNeedIntervalMs, const fsStr& pType = "",
                         fsS32 pWalkingSatisfactionPercent = 60,
                         fsS32 pPartySize = 1);
 
        const fsStr& nameGet() const { return mName; }
 
        // The catalogue guest-type name (e.g. "familyGuest"). Identity only - the
        // sim never interprets it; presentation maps it to character art.
        const fsStr& typeGet() const { return mType; }
        fsS32 partySizeGet() const { return mPartySize; }
 
        const fsStr& needSlotTypeGet() const;
        fsBool needReadyGet() const;
        fsS32 needsPlannedGet() const { return mNeedsPlanned; }
        fsS32 needsRemainingGet() const;
        fsS32 needsSatisfiedGet() const;
        // A complete walking visit is worthwhile on its own (60%). Each planned
        // secondary need fulfilled contributes an even share of the remaining 40%.
        fsS32 visitSatisfactionPercentGet() const;
        void walkingSatisfactionPercentSet(fsS32 pPercent);
        fsS32 walkingSatisfactionPercentGet() const { return mWalkingSatisfactionPercent; }
        void needSatisfied();
        void needDefer();
        fsS32 spendGet() const { return mSpend; }
 
        // The specific slot joined (empty while exploring).
        const fsStr& slotNameGet() const { return mSlotName; }
        void slotNameSet(const fsStr& pSlotName) { mSlotName = pSlotName; }
 
        fsS32 patienceRemainingMsGet() const { return mPatienceRemainingMs; }
        fsS32 visitRemainingMsGet() const { return mVisitRemainingMs; }
 
        eGuestSimState stateGet() const { return mState; }
        void stateSet(eGuestSimState pState) { mState = pState; }
 
        // Advances exploration and the timer before the next secondary need. Returns
        // true once the visitor has completed the time they planned to spend here.
        fsBool wanderTick(fsS32 pDeltaMs);
 
        // Counts patience down only after committing to a queue.
        fsBool patienceTick(fsS32 pDeltaMs);
 
        // Travel to the assigned slot; travelTick() returns true on arrival.
        // Presentation reads travelRemainingMsGet() to pace the walk.
        void travelSet(fsS32 pTravelMs) { mTravelRemainingMs = pTravelMs; }
        fsS32 travelRemainingMsGet() const { return mTravelRemainingMs; }
        fsBool travelTick(fsS32 pDeltaMs);
 
private:
 
        fsStr mName;
        fsStr mType;
        std::vector<fsStr> mNeedSlotTypes;
        fsS32 mNeedsPlanned;
        fsS32 mNeedIndex;
        fsStr mSlotName;
        fsS32 mSpend;
        fsS32 mPatienceMs;
        fsS32 mPatienceRemainingMs;
        fsS32 mVisitRemainingMs;
        fsS32 mNeedIntervalMs;
        fsS32 mNeedDelayRemainingMs;
        fsS32 mWalkingSatisfactionPercent;
        fsS32 mPartySize;
        fsS32 mTravelRemainingMs;
        eGuestSimState mState;
};
 
#endif