Public Api for the Settings System. More...

Public Member Functions
	BadSettings (string sourcePath)
	Creates a new empty Settings Object.

	BadSettings (JToken? value, string sourcePath)
	Creates a new Settings Object from a Json Token.

	BadSettings (Dictionary< string, BadSettings > properties, string sourcePath)
	Creates a new Settings Object from a Dictionary of Properties.

JToken?	GetValue ()
	Returns the Json Token of the Settings Object.

T?	GetValue< T > ()
	Returns a Deserialized Value of the Settings Object.

bool	HasValue ()
	Returns true if the Settings Object has a JToken Value.

void	SetValue (JToken? value, bool invokeOnChange=true)
	Sets the Json Token of the Current Settings Object.

bool	HasProperty (string propertyName)
	Returns true if the Settings Object has the given Property.

BadSettings	GetProperty (string propertyName)
	Returns the Property with the given Name.

void	SetProperty (string propertyName, BadSettings value, bool invokeOnChange=true)
	Sets the Property with the given Name.

bool	RemoveProperty (string propertyName, bool invokeOnChange=true)
	Removes the Property with the given Name.

void	Populate (bool invokeOnChanged, params BadSettings[] settings)
	Populates the current object with the settings provided.

T?	FindProperty< T > (string propertyName)
	Finds a property based on the property path relative to this object.

BadSettings	FindOrCreateProperty (string propertyPath)
	Finds a property based on the property path relative to this object.

BadSettings?	FindProperty (string propertyPath)
	Finds a property based on the property path relative to this object.

override string	ToString ()
	Returns a string representation of the current object.

Static Public Member Functions
static void	ResolveEnvironmentVariables (BadSettings root)
	Resolves Environment Variables in the current object.

static void	ResolveEnvironmentVariables (BadSettings root, BadSettings settings, BadSettings parent)
	Resolves Environment Variables in the current object.

Properties
bool	HasSourcePath `[get]`

string	SourcePath `[get]`

IEnumerable< string >	PropertyNames `[get]`
	The Property Names of the Settings Object.

Events
Action	OnValueChanged = delegate { }

Private Member Functions
void	PropertyValueChanged ()

void	InvokeValueChanged ()

bool	HasValue< T > ()
	Returns true if the Settings Object can be Deserialized into the given Type.

void	SetValue (object? value)
	Sets the Json Token of the Current Settings Object.

Static Private Member Functions
static string	ResolveEnvironmentVariables (BadSettings root, BadSettings parent, string str)
	Resolves Environment Variables in the current object.

Private Attributes
readonly Dictionary< string, BadSettings >	m_Properties
	The properties of the Current Settings Object.

readonly string	m_SourcePath
	The Source Path of the Settings Object.

object?	m_Cache
	Cache for the Serialized Value of the Settings.

bool	m_IsDirty
	Indicates if the current object is dirty and needs to be re-serialized.

JToken?	m_Value
	The Json Token of the Settings Object.

Detailed Description

Public Api for the Settings System.

Definition at line 10 of file BadSettings.cs.

Constructor & Destructor Documentation

◆ BadSettings() [1/3]

BadScript2.Settings.BadSettings.BadSettings ( string sourcePath )

Creates a new empty Settings Object.

Parameters

sourcePath The Source Path of the Settings Object

Definition at line 44 of file BadSettings.cs.

    {
        m_SourcePath = sourcePath;
        m_Value = null;
        m_IsDirty = true;
        m_Properties = new Dictionary<string, BadSettings>();
    }

◆ BadSettings() [2/3]

BadScript2.Settings.BadSettings.BadSettings	(	JToken?	value,
		string	sourcePath
	)

Creates a new Settings Object from a Json Token.

Parameters

value	The Json Token
sourcePath	The Source Path of the Settings Object

Definition at line 57 of file BadSettings.cs.

    {
        m_Value = value;
        m_SourcePath = sourcePath;
        m_IsDirty = true;
        m_Properties = new Dictionary<string, BadSettings>();
    }

◆ BadSettings() [3/3]

BadScript2.Settings.BadSettings.BadSettings	(	Dictionary< string, BadSettings >	properties,
		string	sourcePath
	)

Creates a new Settings Object from a Dictionary of Properties.

Parameters

properties	The Properties
sourcePath	The Source Path of the Settings Object

Definition at line 70 of file BadSettings.cs.

    {
        m_Value = null;
        m_IsDirty = true;
        m_Properties = properties;
        m_SourcePath = sourcePath;
        foreach (KeyValuePair<string, BadSettings> kvp in m_Properties)
        {
            kvp.Value.OnValueChanged += PropertyValueChanged;
        }
    }

Member Function Documentation

◆ FindOrCreateProperty()

BadSettings BadScript2.Settings.BadSettings.FindOrCreateProperty ( string propertyPath )

Finds a property based on the property path relative to this object.

Parameters

propertyPath Property Path

Returns: Settings Object

Definition at line 329 of file BadSettings.cs.

    {
        string[] path = propertyPath.Split('.');
        BadSettings current = this;
 
        foreach (string s in path)
        {
            if (!current.HasProperty(s))
            {
                BadSettings se = new BadSettings(string.Empty);
                current.SetProperty(s, se);
                current = se;
            }
            else
            {
                current = current.GetProperty(s);
            }
        }
 
        return current;
    }

◆ FindProperty()

BadSettings? BadScript2.Settings.BadSettings.FindProperty ( string propertyPath )

Finds a property based on the property path relative to this object.

Parameters

propertyPath Property Path

Returns: Settings Object

Definition at line 356 of file BadSettings.cs.

    {
        string[] path = propertyPath.Split('.');
        BadSettings current = this;
 
        foreach (string s in path)
        {
            if (!current.HasProperty(s))
            {
                return null;
            }
 
            current = current.GetProperty(s);
        }
 
        return current;
    }

◆ FindProperty< T >()

T? BadScript2.Settings.BadSettings.FindProperty< T > ( string propertyName )

Finds a property based on the property path relative to this object.

Parameters

propertyName Property Path

Template Parameters

T	Type to deserialize into

Returns: Deserialized Value

Type Constraints

T

:

class

Definition at line 317 of file BadSettings.cs.

                                                           : class
    {
        BadSettings? settings = FindProperty(propertyName);
 
        return settings?.GetValue<T>();
    }

◆ GetProperty()

BadSettings BadScript2.Settings.BadSettings.GetProperty ( string propertyName )

Returns the Property with the given Name.

Parameters

propertyName The Property Name

Returns: The Property

Definition at line 200 of file BadSettings.cs.

    {
        return m_Properties[propertyName];
    }

◆ GetValue()

JToken? BadScript2.Settings.BadSettings.GetValue ( )

Returns the Json Token of the Settings Object.

Returns: Json Token

Definition at line 104 of file BadSettings.cs.

    {
        return m_Value;
    }

◆ GetValue< T >()

T? BadScript2.Settings.BadSettings.GetValue< T > ( )

Returns a Deserialized Value of the Settings Object.

Template Parameters

T	The Type to Deserialize into

Returns: Deserialized Result

Definition at line 114 of file BadSettings.cs.

    {
        if (!m_IsDirty)
        {
            return (T?)m_Cache;
        }
 
        if (m_Value == null)
        {
            return default;
        }
 
        T? v = m_Value.ToObject<T>();
 
        m_Cache = v;
        m_IsDirty = false;
 
        return v;
    }

◆ HasProperty()

bool BadScript2.Settings.BadSettings.HasProperty ( string propertyName )

Returns true if the Settings Object has the given Property.

Parameters

propertyName The Property Name

Returns: true if the Property exists

Definition at line 190 of file BadSettings.cs.

    {
        return m_Properties.ContainsKey(propertyName);
    }

◆ HasValue()

bool BadScript2.Settings.BadSettings.HasValue ( )

Returns true if the Settings Object has a JToken Value.

Returns

Definition at line 138 of file BadSettings.cs.

    {
        return m_Value != null;
    }

◆ HasValue< T >()

bool BadScript2.Settings.BadSettings.HasValue< T > ( )

private

Returns true if the Settings Object can be Deserialized into the given Type.

Template Parameters

T The Type

Returns: true if Deserializable

Definition at line 148 of file BadSettings.cs.

    {
        if (m_Value?.Type == JTokenType.Array && !typeof(T).IsArray)
        {
            return false;
        }
 
        return m_Value != null && m_Value.ToObject<T>() != null;
    }

◆ InvokeValueChanged()

void BadScript2.Settings.BadSettings.InvokeValueChanged ( )

private

Definition at line 95 of file BadSettings.cs.

    {
        OnValueChanged();
    }

◆ Populate()

void BadScript2.Settings.BadSettings.Populate	(	bool	invokeOnChanged,
		params BadSettings[]	settings
	)

Populates the current object with the settings provided.

Parameters

invokeOnChanged	Indicates if the OnChanged Event should be invoked
settings	The settings this object will be populated with

Definition at line 261 of file BadSettings.cs.

    {
        if (m_Value is JArray arr)
        {
            foreach (BadSettings setting in settings)
            {
                if (!setting.HasValue())
                {
                    continue;
                }
 
                if (setting.GetValue() is JArray arr2)
                {
                    foreach (JToken jToken in arr2)
                    {
                        arr.Add(jToken);
                    }
                }
                else
                {
                    arr.Add(setting.GetValue() ?? JValue.CreateNull());
                }
            }
        }
 
        foreach (BadSettings setting in settings)
        {
            foreach (string propertyName in setting.PropertyNames)
            {
                if (HasProperty(propertyName))
                {
                    GetProperty(propertyName).Populate(false, setting.GetProperty(propertyName));
                }
                else
                {
                    SetProperty(propertyName, setting.GetProperty(propertyName), false);
                }
            }
        }
 
        if (invokeOnChanged)
        {
            PropertyValueChanged();
        }
        else
        {
            m_IsDirty = true;
        }
    }

◆ PropertyValueChanged()

void BadScript2.Settings.BadSettings.PropertyValueChanged ( )

private

Definition at line 89 of file BadSettings.cs.

    {
        m_IsDirty = true;
        InvokeValueChanged();
    }

◆ RemoveProperty()

bool BadScript2.Settings.BadSettings.RemoveProperty	(	string	propertyName,
		bool	invokeOnChange = `true`
	)

Removes the Property with the given Name.

Parameters

propertyName	The Property Name
invokeOnChange	Indicates if the OnChange Event should be invoked

Definition at line 234 of file BadSettings.cs.

    {
        if (m_Properties.TryGetValue(propertyName, out BadSettings? old))
        {
            old.OnValueChanged -= PropertyValueChanged;
        }
 
        bool r = m_Properties.Remove(propertyName);
 
        if (invokeOnChange)
        {
            PropertyValueChanged();
        }
        else
        {
            m_IsDirty = true;
        }
 
        return r;
    }

◆ ResolveEnvironmentVariables() [1/3]

static void BadScript2.Settings.BadSettings.ResolveEnvironmentVariables ( BadSettings root )

static

Resolves Environment Variables in the current object.

Parameters

root	The Root settings

Definition at line 453 of file BadSettings.cs.

    {
        ResolveEnvironmentVariables(root, root, root);
    }

◆ ResolveEnvironmentVariables() [2/3]

static string BadScript2.Settings.BadSettings.ResolveEnvironmentVariables	(	BadSettings	root,
		BadSettings	parent,
		string	str
	)

staticprivate

Resolves Environment Variables in the current object.

Parameters

root	The Root settings
parent	The Parent Object
str	The String to Expand

Returns: the Resolved variable

Exceptions

Exception Gets raised if the environment variable syntax is invalid or the environment variable is not found

Definition at line 412 of file BadSettings.cs.

    {
        for (int i = 0; i < str.Length; i++)
        {
            if (str[i] != '$' || i + 1 >= str.Length || str[i + 1] != '(')
            {
                continue;
            }
 
            int end = str.IndexOf(')', i + 2);
 
            if (end == -1)
            {
                throw new Exception("Unclosed environment variable");
            }
 
            string envVar = str.Substring(i + 2, end - i - 2);
 
            string? env = root.FindProperty<string>(envVar);
 
            if (env == null)
            {
                env = parent.FindProperty<string>(envVar);
 
                if (env == null)
                {
                    throw new Exception($"Environment variable '{envVar}' not found");
                }
            }
 
            str = str.Replace(str.Substring(i, end - i + 1), env);
            i--;
        }
 
        return str;
    }

◆ ResolveEnvironmentVariables() [3/3]

static void BadScript2.Settings.BadSettings.ResolveEnvironmentVariables	(	BadSettings	root,
		BadSettings	settings,
		BadSettings	parent
	)

static

Resolves Environment Variables in the current object.

Parameters

root	The Root settings
settings	The Current Settings Object
parent	The Parent Object

Definition at line 464 of file BadSettings.cs.

    {
        if (settings.HasValue<string>())
        {
            string value = settings.GetValue<string>()!;
 
            settings.SetValue(ResolveEnvironmentVariables(root, parent, value));
        }
        else if (settings.HasValue<string[]>())
        {
            string[] value = settings.GetValue<string[]>()!;
 
            for (int i = 0; i < value.Length; i++)
            {
                value[i] = ResolveEnvironmentVariables(root, parent, value[i]);
            }
 
            settings.SetValue(value);
        }
 
        foreach (string propertyName in settings.PropertyNames)
        {
            ResolveEnvironmentVariables(root, settings.GetProperty(propertyName), settings);
        }
    }

◆ SetProperty()

void BadScript2.Settings.BadSettings.SetProperty	(	string	propertyName,
		BadSettings	value,
		bool	invokeOnChange = `true`
	)

Sets the Property with the given Name.

Parameters

propertyName	The Property Name
value	The Property Value
invokeOnChange	Indicates if the OnChange Event should be invoked

Definition at line 211 of file BadSettings.cs.

    {
        if (m_Properties.TryGetValue(propertyName, out BadSettings? old))
        {
            old.OnValueChanged -= PropertyValueChanged;
        }
 
        m_Properties[propertyName] = value;
        if (invokeOnChange)
        {
            PropertyValueChanged();
        }
        else
        {
            m_IsDirty = true;
        }
    }

◆ SetValue() [1/2]

void BadScript2.Settings.BadSettings.SetValue	(	JToken?	value,
		bool	invokeOnChange = `true`
	)

Sets the Json Token of the Current Settings Object.

Parameters

value	Json Token
invokeOnChange	Indicates if the OnChange Event should be invoked

Definition at line 163 of file BadSettings.cs.

    {
        m_Value = value;
        if (invokeOnChange)
        {
            PropertyValueChanged();
        }
        else
        {
            m_IsDirty = true;
        }
    }

◆ SetValue() [2/2]

void BadScript2.Settings.BadSettings.SetValue ( object? value )

private

Sets the Json Token of the Current Settings Object.

Parameters

value The Deserialized Object

Definition at line 180 of file BadSettings.cs.

    {
        SetValue(value == null ? JValue.CreateNull() : JToken.FromObject(value));
    }

◆ ToString()

override string BadScript2.Settings.BadSettings.ToString ( )

Returns a string representation of the current object.

Returns: String Representation

Definition at line 378 of file BadSettings.cs.

    {
        if (HasValue())
        {
            return GetValue()?.ToString() ?? "NULL";
        }
 
        StringBuilder sb = new StringBuilder();
 
        sb.AppendLine("{");
 
        foreach (string propertyName in PropertyNames)
        {
            BadSettings s = GetProperty(propertyName);
            string str = s.ToString().Replace("\n", "\n\t");
            sb.AppendLine($"  {propertyName}: {str}");
        }
 
        sb.AppendLine("}");
 
        return sb.ToString();
    }

Member Data Documentation

◆ m_Cache

object? BadScript2.Settings.BadSettings.m_Cache

private

Cache for the Serialized Value of the Settings.

Definition at line 28 of file BadSettings.cs.

◆ m_IsDirty

bool BadScript2.Settings.BadSettings.m_IsDirty

private

Indicates if the current object is dirty and needs to be re-serialized.

Definition at line 33 of file BadSettings.cs.

◆ m_Properties

readonly Dictionary<string, BadSettings> BadScript2.Settings.BadSettings.m_Properties

private

The properties of the Current Settings Object.

Definition at line 15 of file BadSettings.cs.

◆ m_SourcePath

readonly string BadScript2.Settings.BadSettings.m_SourcePath

private

The Source Path of the Settings Object.

Definition at line 20 of file BadSettings.cs.

◆ m_Value

JToken? BadScript2.Settings.BadSettings.m_Value

private

The Json Token of the Settings Object.

Definition at line 38 of file BadSettings.cs.

Property Documentation

◆ HasSourcePath

bool BadScript2.Settings.BadSettings.HasSourcePath

get

Definition at line 22 of file BadSettings.cs.

◆ PropertyNames

IEnumerable<string> BadScript2.Settings.BadSettings.PropertyNames

get

The Property Names of the Settings Object.

Definition at line 85 of file BadSettings.cs.

◆ SourcePath

string BadScript2.Settings.BadSettings.SourcePath

get

Definition at line 23 of file BadSettings.cs.

Event Documentation

◆ OnValueChanged

Action BadScript2.Settings.BadSettings.OnValueChanged = delegate { }

Definition at line 87 of file BadSettings.cs.

87{ };

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

src/BadScript2/Settings/BadSettings.cs

Public Member Functions

Static Public Member Functions

Properties

Events

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BadSettings() [1/3]

◆ BadSettings() [2/3]

◆ BadSettings() [3/3]

Member Function Documentation

◆ FindOrCreateProperty()

◆ FindProperty()

◆ FindProperty< T >()

◆ GetProperty()

◆ GetValue()

◆ GetValue< T >()

◆ HasProperty()

◆ HasValue()

◆ HasValue< T >()

◆ InvokeValueChanged()

◆ Populate()

◆ PropertyValueChanged()

◆ RemoveProperty()

◆ ResolveEnvironmentVariables() [1/3]

◆ ResolveEnvironmentVariables() [2/3]

◆ ResolveEnvironmentVariables() [3/3]

◆ SetProperty()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ ToString()

Member Data Documentation

◆ m_Cache

◆ m_IsDirty

◆ m_Properties

◆ m_SourcePath

◆ m_Value

Property Documentation

◆ HasSourcePath

◆ PropertyNames

◆ SourcePath

Event Documentation

◆ OnValueChanged