Class SavedStateEntriesExtensions

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

Provides extension members for ISavedStateEntries.

public static class SavedStateEntriesExtensions

Inheritance

object

SavedStateEntriesExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetDictionary<TKey, TValue>(ISavedStateEntries, string)

Names a dictionary in this store whose values are stored as text. Nothing is read or written until the dictionary is used.

public static ISavedStateDictionary<TKey, TValue> GetDictionary<TKey, TValue>(this ISavedStateEntries entries, string key) where TKey : struct, IConvertible where TValue : struct, IParsable<TValue>

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateDictionary<TKey, TValue>

Type Parameters

TKey

TValue

Remarks

A set, list, or dictionary uses the store nested under its key, so two of them under one key read and change each other's entries.

Exceptions

ArgumentNullException

key is null.

NotSupportedException

TKey is neither a built-in integer type, byte included, nor an enum.

GetEntriesDictionary<TKey>(ISavedStateEntries, string)

Names a dictionary in this store whose values are stores of their own. Nothing is read or written until the dictionary is used.

public static ISavedStateEntriesDictionary<TKey> GetEntriesDictionary<TKey>(this ISavedStateEntries entries, string key) where TKey : struct, IConvertible

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateEntriesDictionary<TKey>

Type Parameters

TKey

Remarks

A set, list, or dictionary uses the store nested under its key, so two of them under one key read and change each other's entries.

Exceptions

ArgumentNullException

key is null.

NotSupportedException

TKey is neither a built-in integer type, byte included, nor an enum.

GetFormPair<TForm>(ISavedStateEntries, string)

Names one form ID in this store. Nothing is read or written until Value is.

public static ISavedStateFormPair<TForm> GetFormPair<TForm>(this ISavedStateEntries entries, string key) where TForm : struct, IForm

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateFormPair<TForm>

Type Parameters

TForm

Exceptions

ArgumentNullException

key is null.

GetList(ISavedStateEntries, string)

Names a list in this store, whose elements are stores of their own. Nothing is read or written until the list is used.

public static ISavedStateList GetList(this ISavedStateEntries entries, string key)

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateList

Remarks

A set, list, or dictionary uses the store nested under its key, so two of them under one key read and change each other's entries.

Exceptions

ArgumentNullException

key is null.

GetPair<T>(ISavedStateEntries, string)

Names one entry of this store, to be read and written as T. Nothing is read or written until Value is.

public static ISavedStatePair<T> GetPair<T>(this ISavedStateEntries entries, string key) where T : struct, IParsable<T>

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStatePair<T>

Type Parameters

T

Exceptions

ArgumentNullException

key is null.

GetRecordPair<T>(ISavedStateEntries, string)

Names one record in this store, stored as ISavedStateRecordPair<T> describes. Nothing is read or written until its value is.

public static ISavedStateRecordPair<T> GetRecordPair<T>(this ISavedStateEntries entries, string key) where T : class

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateRecordPair<T>

Type Parameters

T

Exceptions

ArgumentNullException

key is null.

GetStringPair(ISavedStateEntries, string)

Names one piece of text in this store. Nothing is read or written until Value is.

public static ISavedStateStringPair GetStringPair(this ISavedStateEntries entries, string key)

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateStringPair

Exceptions

ArgumentNullException

key is null.

GetStringSet(ISavedStateEntries, string)

Names a set of text in this store. Nothing is read or written until the set is used.

public static ISavedStateStringSet GetStringSet(this ISavedStateEntries entries, string key)

Parameters

entries ISavedStateEntries

key string

Returns

ISavedStateStringSet

Remarks

A set, list, or dictionary uses the store nested under its key, so two of them under one key read and change each other's entries.

Exceptions

ArgumentNullException

key is null.