wavelength 1.0.0
Loading...
Searching...
No Matches
GameLogic::PlayerData Class Reference

Per-player record of the phrase each player should play next. More...

#include <gamelogic.h>

Public Member Functions

 PlayerData (Command *pEndFreestyle)
 Construct the record around the command that ends the freestyle of the player.
Ptr< Command > & GetEndFreestyleCmd ()
int GetNextPhraseBar () const
void SetNextPhraseBar (int nBar)
 Set the first bar of the phrase to play next.
int GetLastNextPhraseBar () const
void SetLastNextPhraseBar (int nBar)
 Set the previous first bar of the phrase to play next.
int GetMissedBar () const
void SetMissedBar (int nBar)
 Set the bar the player last missed a phrase in.
int GetSavedStreak () const
void SetSavedStreak (int nStreak)
 Set the streak of the player when the phrase was found.
int GetCapturedTrack () const
void SetCapturedTrack (int nTrack)
 Set the track the search for the next phrase skipped.

Detailed Description

Per-player record of the phrase each player should play next.

The RTTI records the class as nested in GameLogic. The structure is not polymorphic.

Constructor & Destructor Documentation

◆ PlayerData()

GameLogic::PlayerData::PlayerData ( Command * pEndFreestyle)
explicit

Construct the record around the command that ends the freestyle of the player.

Parameters
pEndFreestyleThe command.
Ghidra address:
NTSC-U/C: 0x00110440
Ghidra address:
PAL: 0x00111bd8

Member Function Documentation

◆ GetEndFreestyleCmd()

Ptr< Command > & GameLogic::PlayerData::GetEndFreestyleCmd ( )
inline
Returns
The command that runs EndFreestyle() for the player.

◆ GetNextPhraseBar()

int GameLogic::PlayerData::GetNextPhraseBar ( ) const
inline
Returns
First bar of the phrase to play next, or -1.

◆ SetNextPhraseBar()

void GameLogic::PlayerData::SetNextPhraseBar ( int nBar)
inline

Set the first bar of the phrase to play next.

Parameters
nBarThe bar, or -1.

◆ GetLastNextPhraseBar()

int GameLogic::PlayerData::GetLastNextPhraseBar ( ) const
inline
Returns
The previous GetNextPhraseBar().

◆ SetLastNextPhraseBar()

void GameLogic::PlayerData::SetLastNextPhraseBar ( int nBar)
inline

Set the previous first bar of the phrase to play next.

Parameters
nBarThe bar.

◆ GetMissedBar()

int GameLogic::PlayerData::GetMissedBar ( ) const
inline
Returns
The bar the player last missed a phrase in.

◆ SetMissedBar()

void GameLogic::PlayerData::SetMissedBar ( int nBar)
inline

Set the bar the player last missed a phrase in.

Parameters
nBarThe bar.

◆ GetSavedStreak()

int GameLogic::PlayerData::GetSavedStreak ( ) const
inline
Returns
The streak of the player when the phrase was found.

◆ SetSavedStreak()

void GameLogic::PlayerData::SetSavedStreak ( int nStreak)
inline

Set the streak of the player when the phrase was found.

Parameters
nStreakThe streak.

◆ GetCapturedTrack()

int GameLogic::PlayerData::GetCapturedTrack ( ) const
inline
Returns
The track the search for the next phrase skipped.

◆ SetCapturedTrack()

void GameLogic::PlayerData::SetCapturedTrack ( int nTrack)
inline

Set the track the search for the next phrase skipped.

Parameters
nTrackThe track.

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