BadScript2.Settings.BadEditableSetting< T, TValue > Class Template Reference

Implements an Editable Setting. More...

Public Member Functions
	BadEditableSetting (string name, TValue? defaultValue=default)
	Creates a new Editable Setting.
BadSettings?	Get ()
	Returns the settings object of the Editable Setting.
TValue?	GetValue ()
	Returns the value of the Editable Setting.
void	Set (TValue? value)
	Sets the value of the Editable Setting.

Private Attributes
readonly? TValue	m_DefaultValue
	The Default Value of the Setting.
readonly string	m_Name
	The Name of the Setting.
BadSettings?	m_SettingsObj
	The Settings Object.

Detailed Description

Implements an Editable Setting.

Template Parameters

T	The Type that has the setting
TValue	The Type of the value of the setting

Type Constraints

T	:	BadSettingsProvider<T>
T	:	new()

Definition at line 15 of file BadEditableSetting.cs.

Constructor & Destructor Documentation

BadEditableSetting()

BadScript2.Settings.BadEditableSetting< T, TValue >.BadEditableSetting	(	string	name,
		TValue?	defaultValue = default
	)

Creates a new Editable Setting.

Parameters

name	The Name of the Setting
defaultValue	The Default Value of the Setting

Definition at line 37 of file BadEditableSetting.cs.

    {
        m_Name = name;
        m_DefaultValue = defaultValue;
    }

Member Function Documentation

Get()

BadSettings? BadScript2.Settings.BadEditableSetting< T, TValue >.Get

(

)

Returns the settings object of the Editable Setting.

Returns

The settings object of the Editable Setting

Definition at line 47 of file BadEditableSetting.cs.

    {
        if (m_SettingsObj != null ||
            BadSettingsProvider<T>.Instance.Settings == null)
        {
            return m_SettingsObj;
        }
 
        if (BadSettingsProvider<T>.Instance.Settings.HasProperty(m_Name))
        {
            m_SettingsObj = BadSettingsProvider<T>.Instance.Settings?.GetProperty(m_Name);
        }
        else
        {
            m_SettingsObj =
                new BadSettings(m_DefaultValue == null ? JValue.CreateNull() : JToken.FromObject(m_DefaultValue),
                                string.Empty
                               );
            BadSettingsProvider<T>.Instance.Settings.SetProperty(m_Name, m_SettingsObj);
        }
 
        return m_SettingsObj;
    }

GetValue()

TValue? BadScript2.Settings.BadEditableSetting< T, TValue >.GetValue

(

)

Returns the value of the Editable Setting.

Returns

The value of the Editable Setting

Definition at line 75 of file BadEditableSetting.cs.

    {
        BadSettings? setting = Get();
 
        if (setting == null)
        {
            return m_DefaultValue;
        }
 
        TValue? value = setting.GetValue<TValue>();
 
        return value ?? m_DefaultValue;
    }

Set()

void BadScript2.Settings.BadEditableSetting< T, TValue >.Set

(

TValue?

value

)

Sets the value of the Editable Setting.

Parameters

value

The value to set

Exceptions

BadRuntimeException

If the Settings Object is null

Definition at line 94 of file BadEditableSetting.cs.

    {
        BadSettings? settings = Get();
 
        if (settings == null)
        {
            throw new BadRuntimeException($"Settings Object for {typeof(T).Name}.{m_Name} is null");
        }
 
        settings.SetValue(value == null ? JValue.CreateNull() : JToken.FromObject(value));
    }

Member Data Documentation

m_DefaultValue

readonly? TValue BadScript2.Settings.BadEditableSetting< T, TValue >.m_DefaultValue

private

The Default Value of the Setting.

Definition at line 20 of file BadEditableSetting.cs.

m_Name

readonly string BadScript2.Settings.BadEditableSetting< T, TValue >.m_Name

private

The Name of the Setting.

Definition at line 25 of file BadEditableSetting.cs.

m_SettingsObj

BadSettings? BadScript2.Settings.BadEditableSetting< T, TValue >.m_SettingsObj

private

The Settings Object.

Definition at line 30 of file BadEditableSetting.cs.

---

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

• src/BadScript2/Settings/BadEditableSetting.cs