PowerQuest 0.15.13
QuestSettings Class Reference

Detailed Description

Settings that can be set by players in game.

Public Types

enum  eDialogDisplay { TextAndSpeech , SpeechOnly , TextOnly }
 Whether dialog's displayed, audio only, or both. More...
 

Properties

float Volume [get, set]
 Gets/sets the master volume (0 to 1) More...
 
float VolumeMusic [get, set]
 Gets/sets the music volume (0 to 1) More...
 
float VolumeSFX [get, set]
 Gets/sets the sound effect volume (0 to 1) More...
 
float VolumeDialog [get, set]
 Gets/sets the dialog volume (0 to 1) More...
 
float TextSpeedMultiplier [get, set]
 
eDialogDisplay DialogDisplay [get, set]
 Gets/sets the dialog display style (0 to 1) More...
 
CursorLockMode LockCursor [get, set]
 
string Language [get, set]
 Gets/Sets the current language by code. More...
 
LanguageData LanguageData [get]
 Gets data for the currently selected language. More...
 
int LanguageId [get, set]
 Gets/Sets the current language by id. More...
 

Public Member Functions

void OnInitialise ()
 Initialises the system (Called from inside PowerQuest) More...
 
void OnPostRestore (int version)
 Initialises the system (Called from inside PowerQuest) More...
 
LanguageData[] GetLanguages ()
 Get's the current language. More...
 

Public Attributes

CursorLockMode m_lockCursor = CursorLockMode.Confined
 

Member Enumeration Documentation

◆ eDialogDisplay

Whether dialog's displayed, audio only, or both.

Property Documentation

◆ Volume

float Volume
getset

Gets/sets the master volume (0 to 1)

◆ VolumeMusic

float VolumeMusic
getset

Gets/sets the music volume (0 to 1)

◆ VolumeSFX

float VolumeSFX
getset

Gets/sets the sound effect volume (0 to 1)

◆ VolumeDialog

float VolumeDialog
getset

Gets/sets the dialog volume (0 to 1)

◆ DialogDisplay

eDialogDisplay DialogDisplay
getset

Gets/sets the dialog display style (0 to 1)

◆ Language

string Language
getset

Gets/Sets the current language by code.

◆ LanguageData

LanguageData LanguageData
get

Gets data for the currently selected language.

◆ LanguageId

int LanguageId
getset

Gets/Sets the current language by id.

Member Function Documentation

◆ OnInitialise()

void OnInitialise ( )
inline

Initialises the system (Called from inside PowerQuest)

◆ OnPostRestore()

void OnPostRestore ( int  version)
inline

Initialises the system (Called from inside PowerQuest)

◆ GetLanguages()

LanguageData[] GetLanguages ( )
inline

Get's the current language.