Settings Class

Delta Engine Documentation

Keeps a bunch of settings like the resolution, which are used when the application starts up. View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Core Settings
    DeltaEngine.Mocks MockSettings
    DeltaEngine.Platforms FileSettings

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

Syntax

C++

Copy to Clipboard Print

public abstract class Settings : IDisposable

public abstract class Settings : IDisposable

Public MustInherit Class Settings 
	Implements IDisposable

Public MustInherit Class Settings 
	Implements IDisposable

public ref class Settings abstract : IDisposable

public ref class Settings abstract : IDisposable

[<AbstractClassAttribute>]
type Settings =  
    class 
        interface IDisposable 
    end

[<AbstractClassAttribute>]
type Settings =  
    class 
        interface IDisposable 
    end

The Settings type exposes the following members.

Constructors

	Name	Description
	Settings	Initializes a new instance of the Settings class

Top

Methods

	Name	Description
	Dispose	View code on GitHub
	GetMyDocumentsAppFolder	View code on GitHub
	GetValue T
	LoadDefaultSettings	View code on GitHub
	Save	View code on GitHub
	SetValue

Top

Fields

	Name	Description
	DefaultUpdatesPerSecond
	SettingsFilename
	wasChanged

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
	ColorBufferBits	View code on GitHub
	Current	View code on GitHub
	CustomSettingsExists
	DefaultResolution
	DepthBufferBits	View code on GitHub
	LimitFramerate	View code on GitHub
	MusicVolume	View code on GitHub
	OnlineServiceIp
	OnlineServicePort
	PlayerName	View code on GitHub
	ProfilingModes
	RapidUpdatesPerSecond	View code on GitHub
	Resolution	View code on GitHub
	SoundVolume	View code on GitHub
	StartInFullscreen	View code on GitHub
	TwoLetterLanguageName	View code on GitHub
	UpdatesPerSecond	View code on GitHub
	UseOnlineLogging
	UseVSync	View code on GitHub

Top

Remarks

Tests: DeltaEngine.Tests.Core.SettingsTests

Examples

6 unit tests call DeltaEngine.Core.Settings

Copy to Clipboard Print

[Test]
public void CheckDefaultSettings()
{
    Settings settings = Settings.Current;
    settings.LoadDefaultSettings();
    Assert.AreEqual(Settings.DefaultResolution, settings.Resolution);
    Assert.AreEqual(false, settings.StartInFullscreen);
    Assert.AreEqual(1.0f, settings.SoundVolume);
    Assert.AreEqual(0.75f, settings.MusicVolume);
    Assert.AreEqual(24, settings.DepthBufferBits);
    Assert.AreEqual(32, settings.ColorBufferBits);
    Assert.AreEqual(0, settings.AntiAliasingSamples);
    Assert.AreEqual(0, settings.LimitFramerate);
    Assert.AreEqual(false, settings.UseVSync);
    Assert.AreEqual(20, settings.UpdatesPerSecond);
    Assert.AreEqual(20, settings.RapidUpdatesPerSecond);
}

[Test]
public void CheckDefaultSettings()
{
    Settings settings = Settings.Current;
    settings.LoadDefaultSettings();
    Assert.AreEqual(Settings.DefaultResolution, settings.Resolution);
    Assert.AreEqual(false, settings.StartInFullscreen);
    Assert.AreEqual(1.0f, settings.SoundVolume);
    Assert.AreEqual(0.75f, settings.MusicVolume);
    Assert.AreEqual(24, settings.DepthBufferBits);
    Assert.AreEqual(32, settings.ColorBufferBits);
    Assert.AreEqual(0, settings.AntiAliasingSamples);
    Assert.AreEqual(0, settings.LimitFramerate);
    Assert.AreEqual(false, settings.UseVSync);
    Assert.AreEqual(20, settings.UpdatesPerSecond);
    Assert.AreEqual(20, settings.RapidUpdatesPerSecond);
}

Copy to Clipboard Print

[Test]
public void ChangeAndSaveSettings()
{
    Settings settings = Settings.Current;
    settings.PlayerName = ModifiedPlayerName;
    settings.TwoLetterLanguageName = ModifiedTwoLetterLanguageName;
    settings.StartInFullscreen = false;
    Assert.AreEqual(settings.TwoLetterLanguageName, ModifiedTwoLetterLanguageName);
    Assert.AreEqual(ModifiedPlayerName, settings.PlayerName);
    settings.Save();
}

[Test]
public void ChangeAndSaveSettings()
{
    Settings settings = Settings.Current;
    settings.PlayerName = ModifiedPlayerName;
    settings.TwoLetterLanguageName = ModifiedTwoLetterLanguageName;
    settings.StartInFullscreen = false;
    Assert.AreEqual(settings.TwoLetterLanguageName, ModifiedTwoLetterLanguageName);
    Assert.AreEqual(ModifiedPlayerName, settings.PlayerName);
    settings.Save();
}

Copy to Clipboard Print

[Test]
public void SetValueTwice()
{
    Settings settings = Settings.Current;
    settings.PlayerName = "Blub";
    settings.PlayerName = ModifiedPlayerName;
    Assert.AreEqual(ModifiedPlayerName, settings.PlayerName);
}

[Test]
public void SetValueTwice()
{
    Settings settings = Settings.Current;
    settings.PlayerName = "Blub";
    settings.PlayerName = ModifiedPlayerName;
    Assert.AreEqual(ModifiedPlayerName, settings.PlayerName);
}