wavelength 1.0.0
Loading...
Searching...
No Matches
HelpText Class Reference

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.

Detailed Description

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.

Constructor & Destructor Documentation

◆ HelpText()

HelpText::HelpText ( )

Allow the hints.

Ghidra address:
NTSC-U/C: 0x00117968
Ghidra address:
PAL: 0x00119100

◆ ~HelpText()

HelpText::~HelpText ( )

Release the command that ends the attention cue.

Ghidra address:
NTSC-U/C: 0x001179c0
Ghidra address:
PAL: 0x00119158

Member Function Documentation

◆ shared()

HelpText * HelpText::shared ( )
static

Report the one instance, constructing it on the first call.

Returns
The instance.
Ghidra address:
NTSC-U/C: 0x00117a38
Ghidra address:
PAL: 0x001191d0

◆ SetEnabled()

void HelpText::SetEnabled ( bool bEnabled)

Allow or forbid the hints.

Parameters
bEnabledWhether hints are shown.
Ghidra address:
NTSC-U/C: 0x00117a90
Ghidra address:
PAL: 0x00119228

◆ Reset()

void HelpText::Reset ( )

Allow the hints and forget when the last one was shown.

Ghidra address:
NTSC-U/C: 0x00117a98
Ghidra address:
PAL: 0x00119230

◆ ShowEnergyLow()

bool HelpText::ShowEnergyLow ( )

Warn that the energy is low.

Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117aa8
Ghidra address:
PAL: 0x00119240

◆ ShowAutocatcherFailed()

bool HelpText::ShowAutocatcherFailed ( )

Explain why the autocatcher power-up failed.

Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117ae0
Ghidra address:
PAL: 0x00119278

◆ ShowBumperFailed()

bool HelpText::ShowBumperFailed ( )

Explain why the bumper power-up failed.

Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117b18
Ghidra address:
PAL: 0x001192b0

◆ ShowCripplerFailed()

bool HelpText::ShowCripplerFailed ( )

Explain why the crippler power-up failed.

Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117b50
Ghidra address:
PAL: 0x001192e8

◆ ShowNotesAreEnergized()

bool HelpText::ShowNotesAreEnergized ( )

Explain that the notes ahead are energised, in the tutorial wording during the tutorial.

Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117b88
Ghidra address:
PAL: 0x00119320

◆ ShowCatchBehind()

bool HelpText::ShowCatchBehind ( int nPlayer)

Explain that a player fell behind on a track.

Parameters
nPlayerThe player, used only when the players share one console.
Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117c00
Ghidra address:
PAL: 0x00119398

◆ ShowEnergizeNotes()

void HelpText::ShowEnergizeNotes ( bool bCatchable)

Explain how to energise the notes, in a single-player game outside practice mode.

Parameters
bCatchableWhether the gems of the current bar can be caught, which picks the second line and adds the attention cue.
Ghidra address:
NTSC-U/C: 0x00117cb0
Ghidra address:
PAL: 0x00119448

◆ ShowDeployAutocatcher()

bool HelpText::ShowDeployAutocatcher ( )

Explain how to deploy the autocatcher power-up.

Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117d58
Ghidra address:
PAL: 0x001194f0

◆ Show()

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.

Parameters
pszFirstThe first line, or its token.
pszSecondThe second line, its token, or null.
bBeginnerOnlyWhether to show the hint only at the two easiest skill levels.
bOnePadOnlyWhether to show the hint only when one controller plays.
nPlayerThe player the hint is for, or -1 for every player.
bLocalizeWhether the lines are tokens to look up in the locale.
Returns
Whether the hint was shown.
Ghidra address:
NTSC-U/C: 0x00117d90
Ghidra address:
PAL: 0x00119528

◆ PlayAttentionCue()

void HelpText::PlayAttentionCue ( )

Highlight the controller buttons for two seconds.

Ghidra address:
NTSC-U/C: 0x00117f50
Ghidra address:
PAL: 0x001196e8

◆ StopAttentionCue()

void HelpText::StopAttentionCue ( )

End the highlight of the controller buttons.

Ghidra address:
NTSC-U/C: 0x00117fd8
Ghidra address:
PAL: 0x00119770

The documentation for this class was generated from the following file: