Class Settings

Namespace

FrameOfReference.World.Config

Assembly

FrameOfReference.World.dll

Stores settings for the application

public sealed class Settings

Inheritance

object

Settings

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Fields

Controls

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

public ControlsSettings Controls

Field Value

ControlsSettings

Display

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

public DisplaySettings Display

Field Value

DisplaySettings

Editor

Stores settings for the game's editor.

public EditorSettings Editor

Field Value

EditorSettings

General

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

public GeneralSettings General

Field Value

GeneralSettings

Graphics

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

public GraphicsSettings Graphics

Field Value

GraphicsSettings

Properties

Current

The currently active set of settings

public static Settings Current { get; }

Property Value

Settings

Methods

Config()

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

public void Config()

EnableAutoSave()

Configures Current settings to be automatically saved when they are changed.

public static void EnableAutoSave()

LoadCurrent()

Loads the current settings from an automatically located XML file

[LuaGlobal(Name = "LoadSettings", Description = "Loads the current settings from an automatically located XML file")]
public static Settings LoadCurrent()

Returns

Settings

Remarks

Any errors are logged and then ignored.

SaveCurrent()

Saves the current settings to an automatically located XML file

[LuaGlobal(Name = "SaveSettings", Description = "Saves the current settings to an automatically located XML file")]
public static void SaveCurrent()

Remarks

Any errors are logged and then ignored.