gfIAutoTestUserInputComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfIAutoTestLevelUserInputComponent.h
*
*       Purpose:        Shared testing code
*
*********************************************************************/
 
#ifndef gfIAutoTestLevelUserInputComponenthdr
#define gfIAutoTestLevelUserInputComponenthdr
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
class fsINode;
 
 
class gfIAutoTestLevelUserInputComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        virtual void clearUp();
 
        void autoQuitDisable();
 
        fsBool userInputReplicate();
 
        // Paused, the test sends no input and the player has the game.
        void pausedSet(fsBool pPaused);
        fsBool pausedGet() const { return mPaused; }
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        // Final - pausing is gated here, so tests override testUpdateDo() instead.
        void updateDo(fsS32 pDeltaMs) final;
        virtual void testUpdateDo(fsS32 pDeltaMs);
        virtual void pausedSetDo(fsBool pPaused)
        {
        }
 
        virtual void clearUpDo()
        {
        }
 
        virtual fsBool doUserInputReplicate() { return false; }
 
        fsBool continueButtonPress(fsINode* pLevel);
        fsBool userGuiAdvanceInputReplicate();
 
        // Completes one pending tutorial, else they queue up on the map.
        fsBool tutorialsConsume();
    fsBool blockedByAdTransitionGet() const;
 
        // Call from updateDo. Reports a level that never resolves and moves on.
        void watchdogUpdate(fsS32 pDeltaMs);
 
        gfIAutoTestLevelUserInputComponent(fsCEntity* pParent);
        virtual ~gfIAutoTestLevelUserInputComponent();
 
        fsS32 mDelay;
 
        // Gap between poll attempts - pure waiting, so it can be short.
        fsS32 mPollMs;
        // Gap after a level change. Too short races the mini-game setup.
        fsS32 mSettleMs;
 
private:
 
        fsBool mAutoQuit;
        fsBool mPaused;
 
        fsS32 mWatchdogMs;
        fsS32 mWatchdogLimitMs;
};
 
#endif