|
wavelength 1.0.0
|
Hints shown to a player who needs help with the controls. More...
#include <helptext.h>
Public Member Functions | |
| HelpText () | |
| Allow the hints. | |
| ~HelpText () | |
| Release the command that ends the attention cue. | |
| void | SetEnabled (bool bEnabled) |
| Allow or forbid the hints. | |
| void | Reset () |
| Allow the hints and forget when the last one was shown. | |
| bool | ShowEnergyLow () |
| Warn that the energy is low. | |
| bool | ShowAutocatcherFailed () |
| Explain why the autocatcher power-up failed. | |
| bool | ShowBumperFailed () |
| Explain why the bumper power-up failed. | |
| bool | ShowCripplerFailed () |
| Explain why the crippler power-up failed. | |
| bool | ShowNotesAreEnergized () |
| Explain that the notes ahead are energised, in the tutorial wording during the tutorial. | |
| bool | ShowCatchBehind (int nPlayer) |
| Explain that a player fell behind on a track. | |
| 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. | |
| bool | Show (const char *pszFirst, const char *pszSecond, bool bBeginnerOnly, bool bOnePadOnly, int nPlayer, bool bLocalize) |
| Show a hint when the hints are allowed. | |
| void | PlayAttentionCue () |
| Highlight the controller buttons for two seconds. | |
| void | StopAttentionCue () |
| End the highlight of the controller buttons. | |
Static Public Member Functions | |
| static HelpText * | shared () |
| Report the one instance, constructing it on the first call. | |
Hints shown to a player who needs help with the controls.
The class is not polymorphic and has no RTTI. The name is inferred. The one instance is the function-local static of shared(), and TheHelpText addresses it. A hint appears only in a game with the hints option on, and never sooner than a second after the previous hint.
| HelpText::HelpText | ( | ) |
Allow the hints.
| HelpText::~HelpText | ( | ) |
Release the command that ends the attention cue.
|
static |
Report the one instance, constructing it on the first call.
| void HelpText::SetEnabled | ( | bool | bEnabled | ) |
Allow or forbid the hints.
| bEnabled | Whether hints are shown. |
| void HelpText::Reset | ( | ) |
Allow the hints and forget when the last one was shown.
| bool HelpText::ShowEnergyLow | ( | ) |
Warn that the energy is low.
| bool HelpText::ShowAutocatcherFailed | ( | ) |
Explain why the autocatcher power-up failed.
| bool HelpText::ShowBumperFailed | ( | ) |
Explain why the bumper power-up failed.
| bool HelpText::ShowCripplerFailed | ( | ) |
Explain why the crippler power-up failed.
| bool HelpText::ShowNotesAreEnergized | ( | ) |
Explain that the notes ahead are energised, in the tutorial wording during the tutorial.
| bool HelpText::ShowCatchBehind | ( | int | nPlayer | ) |
Explain that a player fell behind on a track.
| nPlayer | The player, used only when the players share one console. |
| void HelpText::ShowEnergizeNotes | ( | bool | bCatchable | ) |
Explain how to energise the notes, in a single-player game outside practice mode.
| bCatchable | Whether the gems of the current bar can be caught, which picks the second line and adds the attention cue. |
| bool HelpText::ShowDeployAutocatcher | ( | ) |
Explain how to deploy the autocatcher power-up.
| bool HelpText::Show | ( | const char * | pszFirst, |
| const char * | pszSecond, | ||
| bool | bBeginnerOnly, | ||
| bool | bOnePadOnly, | ||
| int | nPlayer, | ||
| bool | bLocalize ) |
Show a hint when the hints are allowed.
| pszFirst | The first line, or its token. |
| pszSecond | The second line, its token, or null. |
| bBeginnerOnly | Whether to show the hint only at the two easiest skill levels. |
| bOnePadOnly | Whether to show the hint only when one controller plays. |
| nPlayer | The player the hint is for, or -1 for every player. |
| bLocalize | Whether the lines are tokens to look up in the locale. |
| void HelpText::PlayAttentionCue | ( | ) |
Highlight the controller buttons for two seconds.
| void HelpText::StopAttentionCue | ( | ) |
End the highlight of the controller buttons.