Table of Contents

Class GameOptionsFile

Namespace: CmlLib.Core.Utils
Assembly: CmlLib.Core.dll

public class GameOptionsFile : IEnumerable<KeyValuePair<string, string>>, IEnumerable

Inheritance

objectGameOptionsFile

Implements

IEnumerable<KeyValuePair<string, string>>, IEnumerable

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

GameOptionsFile()

public GameOptionsFile()

GameOptionsFile(Dictionary<string, string?>)

public GameOptionsFile(Dictionary<string, string?> options)

Parameters

options Dictionary<string, string?>

GameOptionsFile(Dictionary<string, string?>, string)

public GameOptionsFile(Dictionary<string, string?> options, string path)

Parameters

options Dictionary<string, string?>

path string

Fields

MaxOptionFileLength

public static readonly int MaxOptionFileLength

Field Value

int

Properties

FilePath

public string? FilePath { get; }

Property Value

string?

this[string]

public string? this[string key] { get; }

Property Value

string?

Methods

ContainsKey(string)

public bool ContainsKey(string key)

Parameters

key string

Returns

bool

FromKeyValueString(string)

public static KeyValuePair<string, string> FromKeyValueString(string keyvalue)

Parameters

keyvalue string

Returns

KeyValuePair<string, string>

GetEnumerator()

public IEnumerator<KeyValuePair<string, string>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, string>>

GetRawValue(string)

public string? GetRawValue(string key)

Parameters

key string

Returns

string?

GetValueAsArray(string)

public string[]? GetValueAsArray(string key)

Parameters

key string

Returns

string[]?

GetValueAsBool(string)

public bool GetValueAsBool(string key)

Parameters

key string

Returns

bool

GetValueAsDouble(string)

public double GetValueAsDouble(string key)

Parameters

key string

Returns

double

GetValueAsInt(string)

public int GetValueAsInt(string key)

Parameters

key string

Returns

int

GetValueAsString(string)

public string? GetValueAsString(string key)

Parameters

key string

Returns

string?

ReadFile(string)

public static GameOptionsFile ReadFile(string filepath)

Parameters

filepath string

Returns

GameOptionsFile

ReadFile(string, Encoding)

public static GameOptionsFile ReadFile(string filepath, Encoding encoding)

Parameters

filepath string

encoding Encoding

Returns

GameOptionsFile

Save()

public void Save()

Save(string)

public void Save(string path)

Parameters

path string

Save(Encoding)

public void Save(Encoding encoding)

Parameters

encoding Encoding

Save(string, Encoding)

public void Save(string path, Encoding encoding)

Parameters

path string

encoding Encoding

SetRawValue(string, string)

public void SetRawValue(string key, string value)

Parameters

key string

value string

SetValue(string, string)

public void SetValue(string key, string value)

Parameters

key string

value string

SetValue(string, int)

public void SetValue(string key, int value)

Parameters

key string

value int

SetValue(string, double)

public void SetValue(string key, double value)

Parameters

key string

value double

SetValue(string, bool)

public void SetValue(string key, bool value)

Parameters

key string

value bool

SetValue(string, string[])

public void SetValue(string key, string[] array)

Parameters

key string

array string[]

SetValue(string, object)

public void SetValue(string key, object obj)

Parameters

key string

obj object