|
wavelength 1.0.0
|
The settings of the game options screen, which are saved apart from the players to the settings file of the Freq directory. More...
#include <gameoptions.h>
Public Types | |
| enum | FreqSize { kFreqSizeLarge = 0 , kFreqSizeSmall = 1 , kFreqSizeHidden = 2 } |
| Values of mFreqSize. More... | |
| enum | OutputMode { kOutputMono = 0 , kOutputStereo = 1 , kOutputSurround = 2 } |
| Values of mOutputMode. More... | |
Public Member Functions | |
| GameOptions () | |
| Construct the default settings, unmodified. | |
| void | SetFreqSize (int nFreqSize) |
| Set the size of the display of the tracks. | |
| void | SetOutputMode (int nOutputMode) |
| Set the speaker output mode. | |
| void | SetHelpText (int nHelpText) |
| Show or hide the hints. | |
| void | SetForceFeedback (int nForceFeedback) |
| Turn controller vibration on or off. | |
| void | ApplyOutputMode () |
| Apply the speaker output mode to the synthesiser. | |
| void | RecordUpload () |
| Record today as the day of the last remix upload, and mark the settings modified. | |
| bool | UploadedToday () const |
| Report whether the last remix upload was today. | |
| void | Save (BinStream &stream) const |
| Write the settings after version byte 3. | |
| void | Load (BinStream &stream) |
| Read the settings Save() wrote, or an older version of them. | |
| int | GetOutputMode () const |
| int | GetModified () const |
| void | SetModified (int nModified) |
| int | GetHelpText () const |
| int | GetFreqSize () const |
| int | GetForceFeedback () const |
The settings of the game options screen, which are saved apart from the players to the settings file of the Freq directory.
The class is not polymorphic and has no RTTI. The name is inferred from the screen that sets the members. The object is 0x1c bytes. Every setter marks the settings modified.
| GameOptions::GameOptions | ( | ) |
Construct the default settings, unmodified.
| void GameOptions::SetFreqSize | ( | int | nFreqSize | ) |
Set the size of the display of the tracks.
| nFreqSize | One of FreqSize. |
| void GameOptions::SetOutputMode | ( | int | nOutputMode | ) |
Set the speaker output mode.
| nOutputMode | The mode. |
| void GameOptions::SetHelpText | ( | int | nHelpText | ) |
Show or hide the hints.
| nHelpText | 1 to show the hints, 0 to hide them. |
| void GameOptions::SetForceFeedback | ( | int | nForceFeedback | ) |
Turn controller vibration on or off.
| nForceFeedback | 1 for on, 0 for off. |
| void GameOptions::ApplyOutputMode | ( | ) |
Apply the speaker output mode to the synthesiser.
An unknown mode is reported and changes nothing.
| void GameOptions::RecordUpload | ( | ) |
Record today as the day of the last remix upload, and mark the settings modified.
The name is inferred.
| bool GameOptions::UploadedToday | ( | ) | const |
Report whether the last remix upload was today.
The name is inferred.
| void GameOptions::Save | ( | BinStream & | stream | ) | const |
Write the settings after version byte 3.
| stream | The stream. |
| void GameOptions::Load | ( | BinStream & | stream | ) |
Read the settings Save() wrote, or an older version of them.
Before version 3 the output mode is a byte that is ignored, and the mode becomes stereo. Version 0 records only the output mode, and versions before 2 record no date.
| stream | The stream. |
|
inline |
|
inline |
|
inline |
| nModified | Whether the settings changed since they were saved. |
|
inline |
|
inline |
|
inline |