Frame of Reference Game API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
FrameOfReference.World.Config.Settings Class Reference

Stores settings for the application More...

Public Member Functions

void Config ()
 Displays a configuration interface for the settings, allowing easy manipulation of values More...
 

Static Public Member Functions

static void LoadCurrent ()
 Loads the current settings from an automatically located XML file More...
 
static void SaveCurrent ()
 Saves the current settings to an automatically located XML file More...
 

Public Attributes

GeneralSettings General = new GeneralSettings()
 Stores general game settings (UI language, difficulty level, etc.). More...
 
ControlsSettings Controls = new ControlsSettings()
 Stores settings for the user controls (mouse, keyboard, etc.). More...
 
DisplaySettings Display = new DisplaySettings()
 Stores display settings (resolution, etc.). Changes here require the engine to be reset. More...
 
GraphicsSettings Graphics = new GraphicsSettings()
 Stores graphics settings (effect details, etc.). Changes here don't require the engine to be reset. More...
 
SoundSettings Sound = new SoundSettings()
 Stores sound settings (turn music on or off, etc.). More...
 
EditorSettings Editor = new EditorSettings()
 Stores settings for the game's editor. More...
 

Properties

static Settings Current [get, set]
 The currently active set of settings More...
 
static bool AutoSave [get, set]
 Automatically save any changed settings? More...
 

Detailed Description

Stores settings for the application

Member Function Documentation

void FrameOfReference.World.Config.Settings.Config ( )
inline

Displays a configuration interface for the settings, allowing easy manipulation of values

static void FrameOfReference.World.Config.Settings.LoadCurrent ( )
inlinestatic

Loads the current settings from an automatically located XML file

Any errors are logged and then ignored.

static void FrameOfReference.World.Config.Settings.SaveCurrent ( )
inlinestatic

Saves the current settings to an automatically located XML file

Any errors are logged and then ignored.

Member Data Documentation

ControlsSettings FrameOfReference.World.Config.Settings.Controls = new ControlsSettings()

Stores settings for the user controls (mouse, keyboard, etc.).

DisplaySettings FrameOfReference.World.Config.Settings.Display = new DisplaySettings()

Stores display settings (resolution, etc.). Changes here require the engine to be reset.

EditorSettings FrameOfReference.World.Config.Settings.Editor = new EditorSettings()

Stores settings for the game's editor.

GeneralSettings FrameOfReference.World.Config.Settings.General = new GeneralSettings()

Stores general game settings (UI language, difficulty level, etc.).

GraphicsSettings FrameOfReference.World.Config.Settings.Graphics = new GraphicsSettings()

Stores graphics settings (effect details, etc.). Changes here don't require the engine to be reset.

SoundSettings FrameOfReference.World.Config.Settings.Sound = new SoundSettings()

Stores sound settings (turn music on or off, etc.).

Property Documentation

bool FrameOfReference.World.Config.Settings.AutoSave
staticgetset

Automatically save any changed settings?

Settings FrameOfReference.World.Config.Settings.Current
staticgetset

The currently active set of settings


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