ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::Settings Class Reference

Settings services. More...

#include <settings.h>

Collaboration diagram for Stark::Settings:

List of all members.

Public Types

enum  BoolSettingIndex {
  kHighModel, kSubtitle, kSpecialFX, kShadow,
  kHighFMV, kTimeSkip
}
enum  IntSettingIndex { kVoice, kMusic, kSfx, kSaveLoadPage }

Public Member Functions

 Settings (Audio::Mixer *mixer, const ADGameDescription *gd)
 ~Settings ()
bool isDemo () const
 Is this a demo version of the game?
bool getBoolSetting (BoolSettingIndex index)
 Get the settings value.
int getIntSetting (IntSettingIndex index)
void flipSetting (BoolSettingIndex index)
 Flip the boolean settings.
void setIntSetting (IntSettingIndex index, int value)
 Set the integer settings.
bool hasLowResFMV ()
 Check whether low-resolution fmv is available.
void enableBookOfSecrets ()
 Enable the book of secrets.
bool hasBookOfSecrets ()
 Check whether the book of secrets is enabled.
bool isAssetsModEnabled () const
 Should the game try to load external replacement assets?
bool shouldPreMultiplyReplacementPNGs () const
 Should the engine apply alpha pre-multiplication when loading replacement PNGs.
Gfx::Texture::SamplingFilter getImageSamplingFilter () const
 Should linear filtering be used when sampling the background image textures?
Common::CodePage getTextCodePage () const
 The codepage text is encoded in or this version of the game.
bool isFontAntialiasingEnabled () const
 Should TrueType fonts be rendered with anti-aliasing?
bool shouldIgnoreFontSettings () const
 Should the font settings from 'gui.ini' be ignored.

Private Attributes

Audio::Mixer_mixer
bool _hasLowRes
const bool _isDemo
const Common::Language _language
const char * _boolKey [6]
const char * _intKey [4]

Detailed Description

Settings services.

Maintains the settings of the game.

Definition at line 46 of file settings.h.


Member Enumeration Documentation

Enumerator:
kHighModel 
kSubtitle 
kSpecialFX 
kShadow 
kHighFMV 
kTimeSkip 

Definition at line 48 of file settings.h.

Enumerator:
kVoice 
kMusic 
kSfx 
kSaveLoadPage 

Definition at line 57 of file settings.h.


Constructor & Destructor Documentation

Stark::Settings::Settings ( Audio::Mixer mixer,
const ADGameDescription gd 
)

Definition at line 36 of file settings.cpp.

Stark::Settings::~Settings (  )  [inline]

Definition at line 65 of file settings.h.


Member Function Documentation

void Stark::Settings::enableBookOfSecrets (  )  [inline]

Enable the book of secrets.

Definition at line 92 of file settings.h.

void Stark::Settings::flipSetting ( BoolSettingIndex  index  )  [inline]

Flip the boolean settings.

Definition at line 81 of file settings.h.

bool Stark::Settings::getBoolSetting ( BoolSettingIndex  index  )  [inline]

Get the settings value.

Definition at line 77 of file settings.h.

Gfx::Texture::SamplingFilter Stark::Settings::getImageSamplingFilter (  )  const

Should linear filtering be used when sampling the background image textures?

Definition at line 98 of file settings.cpp.

int Stark::Settings::getIntSetting ( IntSettingIndex  index  )  [inline]

Definition at line 78 of file settings.h.

Common::CodePage Stark::Settings::getTextCodePage (  )  const

The codepage text is encoded in or this version of the game.

Definition at line 106 of file settings.cpp.

bool Stark::Settings::hasBookOfSecrets (  )  [inline]

Check whether the book of secrets is enabled.

Definition at line 98 of file settings.h.

bool Stark::Settings::hasLowResFMV (  )  [inline]

Check whether low-resolution fmv is available.

Definition at line 89 of file settings.h.

bool Stark::Settings::isAssetsModEnabled (  )  const

Should the game try to load external replacement assets?

Definition at line 90 of file settings.cpp.

bool Stark::Settings::isDemo (  )  const [inline]

Is this a demo version of the game?

This is true either for 4-CD or 2-CD style demos

Definition at line 72 of file settings.h.

bool Stark::Settings::isFontAntialiasingEnabled (  )  const

Should TrueType fonts be rendered with anti-aliasing?

Definition at line 102 of file settings.cpp.

void Stark::Settings::setIntSetting ( IntSettingIndex  index,
int  value 
)

Set the integer settings.

Definition at line 69 of file settings.cpp.

bool Stark::Settings::shouldIgnoreFontSettings (  )  const

Should the font settings from 'gui.ini' be ignored.

Some versions of the game, especially the GOG.com version have a version of 'gui.ini' that causes poor visuals. We just ignore the settings from the game and use the default values from ResidualVM.

Definition at line 117 of file settings.cpp.

bool Stark::Settings::shouldPreMultiplyReplacementPNGs (  )  const

Should the engine apply alpha pre-multiplication when loading replacement PNGs.

When rendering, textures are expected to be in pre-multiplied alpha format. It's best to have the PNGs in that format on file to speed up loading by removing the need to convert them. However this option enables the conversion when loading the files to they can be stored with regular alpha transparency for convenience when testing.

Definition at line 94 of file settings.cpp.


Member Data Documentation

const char* Stark::Settings::_boolKey[6] [private]

Definition at line 138 of file settings.h.

Definition at line 134 of file settings.h.

const char* Stark::Settings::_intKey[4] [private]

Definition at line 139 of file settings.h.

const bool Stark::Settings::_isDemo [private]

Definition at line 135 of file settings.h.

Definition at line 136 of file settings.h.

Definition at line 133 of file settings.h.


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


Generated on Sat Nov 16 2019 05:03:36 for ResidualVM by doxygen 1.7.1
curved edge   curved edge