Fission FSN
Loading...
Searching...
No Matches
gfIAutoTestUserInputComponent.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: gfIAutoTestLevelUserInputComponent.h
4*
5* Purpose: Shared testing code
6*
7*********************************************************************/
8
9#ifndef gfIAutoTestLevelUserInputComponenthdr
10#define gfIAutoTestLevelUserInputComponenthdr
11
13
14class fsINode;
16
17
19{
20 friend class fsCComponentFactory;
21
22public:
23
24 virtual void clearUp();
25
26 void autoQuitDisable();
27
29
30 // True when the test collects by tapping, as a player would. Then how much it
31 // collects measures how well the input path works, rather than being right or wrong;
32 // a test that forces collection should get everything, so a shortfall is a bug.
33 virtual fsBool collectionByInputGet() const { return false; }
34
35 // Paused, the test sends no input and the player has the game.
36 void pausedSet(fsBool pPaused);
37 fsBool pausedGet() const { return mPaused; }
38
39protected:
40
41 void listenersRegisterDo() override;
42 void listenersDeregisterDo() override;
43 fsBool messageProcessDo(const fsCUniqueId& pMessageType,
44 const fsIMessageDispatcher::sMessageParameters& pParam) override;
45
46 // Final - pausing is gated here, so tests override testUpdateDo() instead.
47 void updateDo(fsS32 pDeltaMs) final;
48 virtual void testUpdateDo(fsS32 pDeltaMs);
49 virtual void pausedSetDo(fsBool pPaused)
50 {
51 }
52
53 virtual void clearUpDo()
54 {
55 }
56
57 virtual fsBool doUserInputReplicate() { return false; }
58
60
61 // Presses a button as a tap would; the button only befriends this class, not its derived tests.
62 static void buttonActionPerform(fsCButtonComponent* pButton);
63
64 // Ends the run as reaching the main menu's quit button does: quits the app, or
65 // reports the test complete when auto quit is off.
66 void runEnd();
68
69 // Completes one pending tutorial, else they queue up on the map.
72
73 // Call from updateDo. Reports a level that never resolves and moves on.
74 void watchdogUpdate(fsS32 pDeltaMs);
75
78
80
81 // Gap between poll attempts - pure waiting, so it can be short.
83 // Gap after a level change. Too short races the mini-game setup.
85
86private:
87
88 fsBool mAutoQuit;
89 fsBool mPaused;
90
91 fsS32 mWatchdogMs;
92 fsS32 mWatchdogLimitMs;
93
94 // skip() isn't safe to call more than once per minigame instance - guard against
95 // re-issuing it while its own completion is still propagating.
96 fsBool mMinigameSkipIssued;
97 // New Game starts a fade-out; pressing again every poll restarts the game each time.
98 fsBool mNewGameIssued;
99 fsBool mRoundScoreIssued;
100};
101
102#endif
Definition fsCButtonComponent.h:27
Definition fsCEntity.h:39
Definition fsCUniqueId.h:21
fsIMessageListenerComponent(fsCEntity *pParent)
Definition fsIMessageListenerComponent.cpp:9
Definition fsINode.h:30
fsBool tutorialsConsume()
Definition gfIAutoTestUserInputComponent.cpp:136
virtual void clearUpDo()
Definition gfIAutoTestUserInputComponent.h:53
virtual void testUpdateDo(fsS32 pDeltaMs)
Definition gfIAutoTestUserInputComponent.cpp:109
gfIAutoTestLevelUserInputComponent(fsCEntity *pParent)
Definition gfIAutoTestUserInputComponent.cpp:440
fsBool userInputReplicate()
Definition gfIAutoTestUserInputComponent.cpp:45
virtual ~gfIAutoTestLevelUserInputComponent()
Definition gfIAutoTestUserInputComponent.cpp:456
void updateDo(fsS32 pDeltaMs) final
Definition gfIAutoTestUserInputComponent.cpp:101
fsS32 mPollMs
Definition gfIAutoTestUserInputComponent.h:82
fsBool continueButtonPress(fsINode *pLevel)
Definition gfIAutoTestUserInputComponent.cpp:349
friend class fsCComponentFactory
Definition gfIAutoTestUserInputComponent.h:20
virtual fsBool collectionByInputGet() const
Definition gfIAutoTestUserInputComponent.h:33
virtual void clearUp()
Definition gfIAutoTestUserInputComponent.cpp:35
static void buttonActionPerform(fsCButtonComponent *pButton)
Definition gfIAutoTestUserInputComponent.cpp:331
fsBool pausedGet() const
Definition gfIAutoTestUserInputComponent.h:37
void watchdogUpdate(fsS32 pDeltaMs)
Definition gfIAutoTestUserInputComponent.cpp:63
void pausedSet(fsBool pPaused)
Definition gfIAutoTestUserInputComponent.cpp:50
fsS32 mSettleMs
Definition gfIAutoTestUserInputComponent.h:84
fsS32 mDelay
Definition gfIAutoTestUserInputComponent.h:79
virtual void pausedSetDo(fsBool pPaused)
Definition gfIAutoTestUserInputComponent.h:49
fsBool blockedByAdTransitionGet() const
Definition gfIAutoTestUserInputComponent.cpp:92
fsBool userGuiAdvanceInputReplicate()
Definition gfIAutoTestUserInputComponent.cpp:197
void runEnd()
Definition gfIAutoTestUserInputComponent.cpp:336
void listenersRegisterDo() override
Definition gfIAutoTestUserInputComponent.cpp:396
fsBool messageProcessDo(const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
Definition gfIAutoTestUserInputComponent.cpp:415
void listenersDeregisterDo() override
Definition gfIAutoTestUserInputComponent.cpp:406
void autoQuitDisable()
Definition gfIAutoTestUserInputComponent.cpp:40
virtual fsBool doUserInputReplicate()
Definition gfIAutoTestUserInputComponent.h:57
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
Definition fsIMessageDispatcher.h:32