fsIRunningOrder.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsIRunningOrder.h
*
*       Purpose:        Interface for level running order
*
*********************************************************************/
 
#ifndef fsIRunningOrderhdr
#define fsIRunningOrderhdr
 
#include <map>
#include <vector>
 
#include <fsCore/fsBaseTypes.h>
#include <fsCore/src/fsCResourceName.h>
#include <fsCore/src/fsCVariableTable.h> // VarTableMap
 
 
class fsIRunningOrder
{
public:
 
        // The navigation token a HOG running order puts before map-first scenes;
        // shared here (not just in gfCHogRunningOrder) because the `.gui` path
        // re-derives it into mSequence to reproduce the legacy list exactly.
        static const fsStr mMapDestinationPrefix;
 
        void replace(const std::vector<fsStr>& pNewOrder);
        const std::vector<fsStr>& rawSequenceGet() const { return mSequence; }
 
        // True when the sequence came from a consolidated runningOrder.gui (so
        // per-scene config is served from the resolved subtree, not <scene>.txt).
        fsBool guiModeGet() const { return mGuiMode; }
        // Resolved config for a scene by its bare name, or nullptr if the scene
        // isn't part of the `.gui` running order (legacy mode always returns null).
        const VarTableMap* resolvedSceneConfigGet(const fsStr& pSceneName) const;
 
        fsS32 levelCountGet() const;
        fsS32 currLevelPosGet() const;
 
        const fsStr& firstLocationGet() const;
        void gameContinue();
        void newGameStart();
        void singleLevel();
 
        const fsStr& nextLocationGet() const;
        void levelCompleteSet();
        void nextLocationSet(const fsStr& pNextLocation);
        fsStr nextLocationGet(const fsStr& pCurrentLocation) const;
        fsBool nextLocationReady() const;
        void nextLocationClear();
 
        // pMapNavigationUsed: HOG genres re-derive the `map->` prefix into the
        // sequence when reading a `.gui`; the park/time genre leaves scenes bare.
        fsIRunningOrder(const fsCResourceName& pFilename, fsBool pMapNavigationUsed = false);
        virtual ~fsIRunningOrder();
 
protected:
 
        fsBool loopsCheck() const;
        void sequenceCheck();
 
        virtual void sequenceCheckDo() const;
        virtual std::vector<fsStr>::const_iterator currentLevelIteratorGetDo(const fsStr& pCurrentLocation) const;
        virtual void nextLocationSetDo(const fsStr& pNextLocation);
        virtual void newGameStartDo();
        virtual fsStr nextLocationGetDo(const fsStr& pCurrentLocation) const;
        virtual void gameContinueDo() = 0;
        virtual void replaceDo(const std::vector<fsStr>& pNewOrder) = 0;
 
        std::vector<fsStr>::const_iterator currentLevelIteratorGet(const fsStr& pCurrentLocation) const;
 
        std::vector<fsStr> mSequence;
        fsStr mCurrentLocation;
        fsStr mNextLocation;
        fsBool mHasLoops = false;
 
private:
 
        // Read+resolve a runningOrder.gui into mSequence (map-first scenes carry
        // mMapDestinationPrefix when pMapNavigationUsed) and mResolvedConfigs.
        void guiSequenceLoad(const fsCResourceName& pResolvedFile, fsBool pMapNavigationUsed);
 
        fsBool mGuiMode = false;
        std::map<fsStr, VarTableMap> mResolvedConfigs; // keyed by bare scene name
};
 
#endif