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)
float	VolumeMusic [get, set]
	Gets/sets the music volume (0 to 1)
float	VolumeSFX [get, set]
	Gets/sets the sound effect volume (0 to 1)
float	VolumeDialog [get, set]
	Gets/sets the dialog volume (0 to 1)
float	TextSpeedMultiplier [get, set]
	Gets/Sets the speed of text in the game.
eDialogDisplay	DialogDisplay [get, set]
	Gets/sets the dialog display style (0 to 1)
CursorLockMode	LockCursor [get, set]
	Gets or sets whether the cursor is locked to the screen. Note, in editor it's always unlocked.
string	Language [get, set]
	Gets/Sets the current language by code.
LanguageData	LanguageData [get]
	Gets data for the currently selected language.
int	LanguageId [get, set]
	Gets/Sets the current language by id.

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

Public Attributes
CursorLockMode	m_lockCursor = CursorLockMode.Confined

Member Enumeration Documentation

eDialogDisplay

enum 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)

TextSpeedMultiplier

float TextSpeedMultiplier

getset

Gets/Sets the speed of text in the game.

DialogDisplay

eDialogDisplay DialogDisplay

getset

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

LockCursor

CursorLockMode LockCursor

getset

Gets or sets whether the cursor is locked to the screen. Note, in editor it's always unlocked.

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.