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

The settings of an online game that the host publishes with its session. More...

#include <netgameparams.h>

Public Member Functions

 NetGameParams ()
 Construct the settings of a game of the first rule set, for four players.
int GetCommunity () const
void SetCommunity (int nCommunity)
int GetLoadRemix () const
void SetLoadRemix (int nLoadRemix)
int GetMaxPlayers () const
void SetMaxPlayers (int nMaxPlayers)
int GetPowerupLevel () const
void SetPowerupLevel (int nPowerupLevel)
int GetPracticeMode () const
void SetPracticeMode (int nPracticeMode)
const String & GetRemixName () const
String & GetRemixName ()
void SetRemixName (const char *pszRemixName)
int GetRemixReadOnly () const
void SetRemixReadOnly (int nRemixReadOnly)
int GetRuleSet () const
void SetRuleSet (int nRuleSet)
int GetSkillLevel () const
void SetSkillLevel (int nSkillLevel)
const String & GetSong () const
String & GetSong ()
void SetSong (const char *pszSong)
int GetTutorial () const
void SetTutorial (int nTutorial)

Static Public Attributes

static constexpr int kDefaultSelection = 1
 The power-up level, the rule set, and the community of default settings.
static constexpr int kDefaultMaxPlayers = 4
 The number of players default settings take.

Detailed Description

The settings of an online game that the host publishes with its session.

The record is 0x4c bytes. GameDb::SetGameParams() copies it member by member into the members of the game database from mSong onwards.

Constructor & Destructor Documentation

◆ NetGameParams()

NetGameParams::NetGameParams ( )
inline

Construct the settings of a game of the first rule set, for four players.

The constructor has no out-of-line copy. The defaults match those of GameDb.

Member Function Documentation

◆ GetCommunity()

int NetGameParams::GetCommunity ( ) const
inline
Returns
The community of the game.

◆ SetCommunity()

void NetGameParams::SetCommunity ( int nCommunity)
inline
Parameters
nCommunityThe community of the game.

◆ GetLoadRemix()

int NetGameParams::GetLoadRemix ( ) const
inline
Returns
Whether a saved remix is played.

◆ SetLoadRemix()

void NetGameParams::SetLoadRemix ( int nLoadRemix)
inline
Parameters
nLoadRemixWhether a saved remix is played.

◆ GetMaxPlayers()

int NetGameParams::GetMaxPlayers ( ) const
inline
Returns
The number of players the session takes.

◆ SetMaxPlayers()

void NetGameParams::SetMaxPlayers ( int nMaxPlayers)
inline
Parameters
nMaxPlayersThe number of players the session takes.

◆ GetPowerupLevel()

int NetGameParams::GetPowerupLevel ( ) const
inline
Returns
The power-up level.

◆ SetPowerupLevel()

void NetGameParams::SetPowerupLevel ( int nPowerupLevel)
inline
Parameters
nPowerupLevelThe power-up level.

◆ GetPracticeMode()

int NetGameParams::GetPracticeMode ( ) const
inline
Returns
The practice mode.

◆ SetPracticeMode()

void NetGameParams::SetPracticeMode ( int nPracticeMode)
inline
Parameters
nPracticeModeThe practice mode.

◆ GetRemixName() [1/2]

const String & NetGameParams::GetRemixName ( ) const
inline
Returns
The name of the remix the game plays.

◆ GetRemixName() [2/2]

String & NetGameParams::GetRemixName ( )
inline
Returns
The name of the remix the game plays, for filling.

◆ SetRemixName()

void NetGameParams::SetRemixName ( const char * pszRemixName)
inline
Parameters
remixNameThe name of the remix the game plays.

◆ GetRemixReadOnly()

int NetGameParams::GetRemixReadOnly ( ) const
inline
Returns
Whether the remix of the game cannot be changed.

◆ SetRemixReadOnly()

void NetGameParams::SetRemixReadOnly ( int nRemixReadOnly)
inline
Parameters
nRemixReadOnlyWhether the remix of the game cannot be changed.

◆ GetRuleSet()

int NetGameParams::GetRuleSet ( ) const
inline
Returns
The game mode.

◆ SetRuleSet()

void NetGameParams::SetRuleSet ( int nRuleSet)
inline
Parameters
nRuleSetThe game mode.

◆ GetSkillLevel()

int NetGameParams::GetSkillLevel ( ) const
inline
Returns
The skill level.

◆ SetSkillLevel()

void NetGameParams::SetSkillLevel ( int nSkillLevel)
inline
Parameters
nSkillLevelThe skill level.

◆ GetSong() [1/2]

const String & NetGameParams::GetSong ( ) const
inline
Returns
The song of the game.

◆ GetSong() [2/2]

String & NetGameParams::GetSong ( )
inline
Returns
The song of the game, for filling.

◆ SetSong()

void NetGameParams::SetSong ( const char * pszSong)
inline
Parameters
songThe song of the game.

◆ GetTutorial()

int NetGameParams::GetTutorial ( ) const
inline
Returns
Whether the tutorial is played.

◆ SetTutorial()

void NetGameParams::SetTutorial ( int nTutorial)
inline
Parameters
nTutorialWhether the tutorial is played.

Member Data Documentation

◆ kDefaultSelection

int NetGameParams::kDefaultSelection = 1
staticconstexpr

The power-up level, the rule set, and the community of default settings.

◆ kDefaultMaxPlayers

int NetGameParams::kDefaultMaxPlayers = 4
staticconstexpr

The number of players default settings take.


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