FileSettings Class

Delta Engine Documentation

App settings loaded from and saved to file. View code on GitHub

Inheritance Hierarchy

System Object
DeltaEngine.Core Settings
DeltaEngine.Platforms FileSettings

Namespace: DeltaEngine.Platforms
Assembly: DeltaEngine.Platforms (in DeltaEngine.Platforms.dll) Version: 1.1.1.0 (1.1.1)

Syntax

C++

Copy to Clipboard Print

public class FileSettings : Settings

public class FileSettings : Settings

Public Class FileSettings 
	Inherits Settings

Public Class FileSettings 
	Inherits Settings

public ref class FileSettings : public Settings

public ref class FileSettings : public Settings

type FileSettings =  
    class 
        inherit Settings 
    end

type FileSettings =  
    class 
        inherit Settings 
    end

The FileSettings type exposes the following members.

Constructors

	Name	Description
	FileSettings	Initializes a new instance of the FileSettings class

Top

Methods

	Name	Description
	Dispose	View code on GitHub (Inherited from Settings.)
	GetValue T	(Overrides Settings GetValue T (String, T).)
	LoadDefaultSettings	(Overrides Settings LoadDefaultSettings .)
	Save	View code on GitHub (Overrides Settings Save .)
	SetValue	(Overrides Settings SetValue(String, Object).)

Top

Fields

	Name	Description
	wasChanged	(Inherited from Settings.)

Top

Properties

	Name	Description
	AntiAliasingSamples	4 works on most frameworks, but some have AA disabled, use 0 to keep all frameworks in sync View code on GitHub (Inherited from Settings.)
	ColorBufferBits	View code on GitHub (Inherited from Settings.)
	CustomSettingsExists	(Inherited from Settings.)
	DepthBufferBits	View code on GitHub (Inherited from Settings.)
	LimitFramerate	View code on GitHub (Inherited from Settings.)
	MusicVolume	View code on GitHub (Inherited from Settings.)
	OnlineServiceIp	(Inherited from Settings.)
	OnlineServicePort	(Inherited from Settings.)
	PlayerName	View code on GitHub (Inherited from Settings.)
	ProfilingModes	(Inherited from Settings.)
	RapidUpdatesPerSecond	View code on GitHub (Inherited from Settings.)
	Resolution	View code on GitHub (Inherited from Settings.)
	SoundVolume	View code on GitHub (Inherited from Settings.)
	StartInFullscreen	View code on GitHub (Inherited from Settings.)
	TwoLetterLanguageName	View code on GitHub (Inherited from Settings.)
	UpdatesPerSecond	View code on GitHub (Inherited from Settings.)
	UseOnlineLogging	(Inherited from Settings.)
	UseVSync	View code on GitHub (Inherited from Settings.)

Top

Remarks

Tests: DeltaEngine.Platforms.Tests.FileSettingsTests

Examples

3 unit tests call DeltaEngine.Platforms.FileSettings

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void CheckDefaultSettings()
{
    Assert.AreEqual(false, fileSettings.StartInFullscreen);
    Assert.AreEqual(1.0f, fileSettings.SoundVolume);
    Assert.AreEqual(0.75f, fileSettings.MusicVolume);
    Assert.AreEqual(24, fileSettings.DepthBufferBits);
    Assert.AreEqual(32, fileSettings.ColorBufferBits);
    Assert.AreEqual(0, fileSettings.AntiAliasingSamples);
    Assert.AreEqual(0, fileSettings.LimitFramerate);
    Assert.AreEqual(20, fileSettings.UpdatesPerSecond);
}

[Test, CloseAfterFirstFrame]
public void CheckDefaultSettings()
{
    Assert.AreEqual(false, fileSettings.StartInFullscreen);
    Assert.AreEqual(1.0f, fileSettings.SoundVolume);
    Assert.AreEqual(0.75f, fileSettings.MusicVolume);
    Assert.AreEqual(24, fileSettings.DepthBufferBits);
    Assert.AreEqual(32, fileSettings.ColorBufferBits);
    Assert.AreEqual(0, fileSettings.AntiAliasingSamples);
    Assert.AreEqual(0, fileSettings.LimitFramerate);
    Assert.AreEqual(20, fileSettings.UpdatesPerSecond);
}

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void ChangeAndSaveSettings()
{
    fileSettings.PlayerName = ModifiedPlayerName;
    fileSettings.TwoLetterLanguageName = ModifiedTwoLetterLanguageName;
    fileSettings.Save();
    Assert.IsTrue(File.Exists(SettingsFilePath));
}

[Test, CloseAfterFirstFrame]
public void ChangeAndSaveSettings()
{
    fileSettings.PlayerName = ModifiedPlayerName;
    fileSettings.TwoLetterLanguageName = ModifiedTwoLetterLanguageName;
    fileSettings.Save();
    Assert.IsTrue(File.Exists(SettingsFilePath));
}

Copy to Clipboard Print

[Test]
public void ChangeFileSettings()
{
    fileSettings.StartInFullscreen = true;
    Assert.AreEqual(true, fileSettings.StartInFullscreen);
    fileSettings.StartInFullscreen = false;
}

[Test]
public void ChangeFileSettings()
{
    fileSettings.StartInFullscreen = true;
    Assert.AreEqual(true, fileSettings.StartInFullscreen);
    fileSettings.StartInFullscreen = false;
}