ScummVM API documentation
Stark::Settings Class Reference

#include <settings.h>

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)
 
bool isDemo () const
 
bool getBoolSetting (BoolSettingIndex index)
 
int getIntSetting (IntSettingIndex index)
 
void flipSetting (BoolSettingIndex index)
 
void setIntSetting (IntSettingIndex index, int value)
 
bool hasLowResFMV ()
 
void enableBookOfSecrets ()
 
bool hasBookOfSecrets ()
 
bool isAssetsModEnabled () const
 
bool shouldPreMultiplyReplacementPNGs () const
 
Gfx::Bitmap::SamplingFilter getImageSamplingFilter () const
 
Common::CodePage getTextCodePage () const
 
bool isFontAntialiasingEnabled () const
 
bool shouldIgnoreFontSettings () const
 
Common::Language getLanguage () const
 

Detailed Description

Settings services.

Maintains the settings of the game.

Member Function Documentation

◆ isDemo()

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

◆ getBoolSetting()

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

Get the settings value

◆ flipSetting()

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

Flip the boolean settings

◆ setIntSetting()

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

Set the integer settings

◆ hasLowResFMV()

bool Stark::Settings::hasLowResFMV ( )
inline

Check whether low-resolution fmv is available

◆ enableBookOfSecrets()

void Stark::Settings::enableBookOfSecrets ( )
inline

Enable the book of secrets

◆ hasBookOfSecrets()

bool Stark::Settings::hasBookOfSecrets ( )
inline

Check whether the book of secrets is enabled

◆ isAssetsModEnabled()

bool Stark::Settings::isAssetsModEnabled ( ) const

Should the game try to load external replacement assets?

◆ shouldPreMultiplyReplacementPNGs()

bool Stark::Settings::shouldPreMultiplyReplacementPNGs ( ) const

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

When rendering, bitmaps 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.

◆ getImageSamplingFilter()

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

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

◆ getTextCodePage()

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

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

◆ isFontAntialiasingEnabled()

bool Stark::Settings::isFontAntialiasingEnabled ( ) const

Should TrueType fonts be rendered with anti-aliasing?

◆ shouldIgnoreFontSettings()

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 ScummVM.

◆ getLanguage()

Common::Language Stark::Settings::getLanguage ( ) const

Return the game language (which is currently initialized with the Advanced Detector description language field value)


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