wavelength 1.0.0
Loading...
Searching...
No Matches
helptext.h
Go to the documentation of this file.
1#pragma once
2
3#include "os/command.h"
4#include "os/ptr.h"
5
13class HelpText {
14public:
22
30
38 static HelpText *shared();
39
47 void SetEnabled(bool bEnabled);
48
55 void Reset();
56
65
74
83
92
101
110 bool ShowCatchBehind(int nPlayer);
111
120 void ShowEnergizeNotes(bool bCatchable);
121
130
144 bool Show(const char *pszFirst,
145 const char *pszSecond,
146 bool bBeginnerOnly,
147 bool bOnePadOnly,
148 int nPlayer,
149 bool bLocalize);
150
158
166
167private:
168 int mEnabled;
169 float mLastShownMs;
170 Ptr<Command> mStopCueCmd;
171};
172
178extern HelpText *TheHelpText;
Hints shown to a player who needs help with the controls.
Definition helptext.h:13
static HelpText * shared()
Report the one instance, constructing it on the first call.
bool ShowNotesAreEnergized()
Explain that the notes ahead are energised, in the tutorial wording during the tutorial.
bool Show(const char *pszFirst, const char *pszSecond, bool bBeginnerOnly, bool bOnePadOnly, int nPlayer, bool bLocalize)
Show a hint when the hints are allowed.
bool ShowCatchBehind(int nPlayer)
Explain that a player fell behind on a track.
bool ShowBumperFailed()
Explain why the bumper power-up failed.
void ShowEnergizeNotes(bool bCatchable)
Explain how to energise the notes, in a single-player game outside practice mode.
bool ShowDeployAutocatcher()
Explain how to deploy the autocatcher power-up.
~HelpText()
Release the command that ends the attention cue.
void SetEnabled(bool bEnabled)
Allow or forbid the hints.
void PlayAttentionCue()
Highlight the controller buttons for two seconds.
HelpText()
Allow the hints.
bool ShowCripplerFailed()
Explain why the crippler power-up failed.
bool ShowAutocatcherFailed()
Explain why the autocatcher power-up failed.
void StopAttentionCue()
End the highlight of the controller buttons.
void Reset()
Allow the hints and forget when the last one was shown.
bool ShowEnergyLow()
Warn that the energy is low.
Owner of one reference to an Attachment.
Definition ptr.h:16
HelpText * TheHelpText
The hints.