The settings of an online game that the host publishes with its session.
More...
#include <netgameparams.h>
|
| 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.
|
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.
◆ 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.
◆ GetCommunity()
| int NetGameParams::GetCommunity |
( |
| ) |
const |
|
inline |
- Returns
- The community of the game.
◆ SetCommunity()
| void NetGameParams::SetCommunity |
( |
int | nCommunity | ) |
|
|
inline |
- Parameters
-
| nCommunity | The 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
-
| nLoadRemix | Whether 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
-
| nMaxPlayers | The 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
-
| nPowerupLevel | The power-up level. |
◆ GetPracticeMode()
| int NetGameParams::GetPracticeMode |
( |
| ) |
const |
|
inline |
- Returns
- The practice mode.
◆ SetPracticeMode()
| void NetGameParams::SetPracticeMode |
( |
int | nPracticeMode | ) |
|
|
inline |
- Parameters
-
| nPracticeMode | The 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
-
| remixName | The 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
-
| nRemixReadOnly | Whether the remix of the game cannot be changed. |
◆ GetRuleSet()
| int NetGameParams::GetRuleSet |
( |
| ) |
const |
|
inline |
◆ SetRuleSet()
| void NetGameParams::SetRuleSet |
( |
int | nRuleSet | ) |
|
|
inline |
◆ GetSkillLevel()
| int NetGameParams::GetSkillLevel |
( |
| ) |
const |
|
inline |
◆ SetSkillLevel()
| void NetGameParams::SetSkillLevel |
( |
int | nSkillLevel | ) |
|
|
inline |
- Parameters
-
| nSkillLevel | The 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
-
| song | The song of the game. |
◆ GetTutorial()
| int NetGameParams::GetTutorial |
( |
| ) |
const |
|
inline |
- Returns
- Whether the tutorial is played.
◆ SetTutorial()
| void NetGameParams::SetTutorial |
( |
int | nTutorial | ) |
|
|
inline |
- Parameters
-
| nTutorial | Whether the tutorial is played. |
◆ 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: