BadScript2.Settings.BadSettingsProvider< T > Class Template Reference

Helper class that can be used to automatically load a settings object from a file. More...

Static Public Member Functions
static void	SetRootSettings (BadSettings settings)
	Sets the Root Settings Object.

Protected Member Functions
	BadSettingsProvider (string path)
	Creates a new Settings Provider.

Properties
static bool	HasRootSettings [get]
	Returns true if the root setting has been set.
static BadSettings	RootSettings [get]
	Returns the Root Settings Object.
BadSettings?	Settings [get]
	Returns the Instance of the Settings Provider.
static T	Instance [get]
	Returns the Instance of the Settings Provider.

Private Attributes
readonly string	m_Path
	The Settings Path Name('.' separated)

Static Private Attributes
static ? BadSettings	s_RootSettings
	The Root Settings Object.
static ? T	s_Instance
	The Instance of the Settings Provider.

Detailed Description

Helper class that can be used to automatically load a settings object from a file.

Type Constraints

T	:	BadSettingsProvider<T>
T	:	new()

Definition at line 42 of file BadSettingsProvider.cs.

Constructor & Destructor Documentation

BadSettingsProvider()

BadScript2.Settings.BadSettingsProvider< T >.BadSettingsProvider ( string  path )

protected

Creates a new Settings Provider.

Parameters

path	The Settings Path

Definition at line 58 of file BadSettingsProvider.cs.

    {
        m_Path = path;
    }

Member Function Documentation

SetRootSettings()

static void BadScript2.Settings.BadSettingsProvider< T >.SetRootSettings ( BadSettings  settings )

static

Sets the Root Settings Object.

Parameters

settings

Root Settings

Definition at line 33 of file BadSettingsProvider.cs.

    {
        s_RootSettings = settings;
    }

Member Data Documentation

m_Path

readonly string BadScript2.Settings.BadSettingsProvider< T >.m_Path

private

The Settings Path Name('.' separated)

Definition at line 52 of file BadSettingsProvider.cs.

s_Instance

? T BadScript2.Settings.BadSettingsProvider< T >.s_Instance

staticprivate

The Instance of the Settings Provider.

Definition at line 47 of file BadSettingsProvider.cs.

s_RootSettings

? BadSettings BadScript2.Settings.BadSettingsProvider< T >.s_RootSettings

staticprivate

The Root Settings Object.

Definition at line 13 of file BadSettingsProvider.cs.

Property Documentation

HasRootSettings

bool BadScript2.Settings.BadSettingsProvider< T >.HasRootSettings

staticget

Returns true if the root setting has been set.

Definition at line 18 of file BadSettingsProvider.cs.

Instance

T BadScript2.Settings.BadSettingsProvider< T >.Instance

staticget

Returns the Instance of the Settings Provider.

Definition at line 73 of file BadSettingsProvider.cs.

RootSettings

BadSettings BadScript2.Settings.BadSettingsProvider< T >.RootSettings

staticget

Returns the Root Settings Object.

Exceptions

BadRuntimeException

Gets raised if the Root Settings Object has not been set.

Definition at line 24 of file BadSettingsProvider.cs.

Settings

BadSettings? BadScript2.Settings.BadSettingsProvider< T >.Settings

get

Returns the Instance of the Settings Provider.

Definition at line 66 of file BadSettingsProvider.cs.

---

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

• src/BadScript2/Settings/BadSettingsProvider.cs