diff --git a/api/IPA.Config.Data.Text.html b/api/IPA.Config.Data.Text.html
index 57074025..2c9a6292 100644
--- a/api/IPA.Config.Data.Text.html
+++ b/api/IPA.Config.Data.Text.html
@@ -170,7 +170,7 @@ String is so that it doesn't conflict with Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html b/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html
index b126b16a..e96fe1ba 100644
--- a/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html
+++ b/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html
@@ -276,7 +276,7 @@ However, if we were to add a Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.CaseInsensitiveEnumConverter-1.html b/api/IPA.Config.Stores.Converters.CaseInsensitiveEnumConverter-1.html
index a32c808e..c9842c5b 100644
--- a/api/IPA.Config.Stores.Converters.CaseInsensitiveEnumConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.CaseInsensitiveEnumConverter-1.html
@@ -160,7 +160,7 @@ ignoring the case of the serialized value for deseiralization.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.NullableConverter-2.html b/api/IPA.Config.Stores.Converters.NullableConverter-2.html
index 55ee216f..da1250df 100644
--- a/api/IPA.Config.Stores.Converters.NullableConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.NullableConverter-2.html
@@ -172,7 +172,7 @@ to use as the underlying converter. Use this in the Improve this Doc
- View Source
+ View Source
NullableConverter()
@@ -222,7 +222,7 @@ to use as the underlying converter. Use this in the Improve this Doc
diff --git a/api/IPA.Config.Stores.IValueConverter.html b/api/IPA.Config.Stores.IValueConverter.html
index 6de211b4..ea2006f3 100644
--- a/api/IPA.Config.Stores.IValueConverter.html
+++ b/api/IPA.Config.Stores.IValueConverter.html
@@ -117,7 +117,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginInitInjector.html b/api/IPA.Loader.PluginInitInjector.html
index f2db23d4..03c6ae43 100644
--- a/api/IPA.Loader.PluginInitInjector.html
+++ b/api/IPA.Loader.PluginInitInjector.html
@@ -140,7 +140,7 @@ For all of the default injectors, only one of each will be generated, and any la
Improve this Doc
- View Source
+ View Source
Note that this is called on the Unity main thread, and cannot therefore block, as the Task
+provided represents operations that also run on the Unity main thread.
diff --git a/api/IPA.Loader.Reason.html b/api/IPA.Loader.Reason.html
index 6567f629..f331899d 100644
--- a/api/IPA.Loader.Reason.html
+++ b/api/IPA.Loader.Reason.html
@@ -179,7 +179,7 @@ present for the purposes of updating.
Improve this Doc
A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used.
diff --git a/api/IPA.Logging.StandardLogger.html b/api/IPA.Logging.StandardLogger.html
index 74289f5d..765ff7b1 100644
--- a/api/IPA.Logging.StandardLogger.html
+++ b/api/IPA.Logging.StandardLogger.html
@@ -181,7 +181,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.OnDisableAttribute.html b/api/IPA.OnDisableAttribute.html
index 3b22c928..57ea10a4 100644
--- a/api/IPA.OnDisableAttribute.html
+++ b/api/IPA.OnDisableAttribute.html
@@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th
Improve this Doc
diff --git a/api/IPA.OnEnableAttribute.html b/api/IPA.OnEnableAttribute.html
index 31516d68..1a47e3da 100644
--- a/api/IPA.OnEnableAttribute.html
+++ b/api/IPA.OnEnableAttribute.html
@@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th
Improve this Doc
diff --git a/api/IPA.OnExitAttribute.html b/api/IPA.OnExitAttribute.html
index 6e89d687..e5f01913 100644
--- a/api/IPA.OnExitAttribute.html
+++ b/api/IPA.OnExitAttribute.html
@@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th
Improve this Doc
diff --git a/api/IPA.OnStartAttribute.html b/api/IPA.OnStartAttribute.html
index 75c5660f..2572ee35 100644
--- a/api/IPA.OnStartAttribute.html
+++ b/api/IPA.OnStartAttribute.html
@@ -294,7 +294,7 @@ The method marked by this attribute will always be called from the Unity main th
Improve this Doc
diff --git a/api/IPA.RuntimeOptions.html b/api/IPA.RuntimeOptions.html
index d535bd51..48fe2ccf 100644
--- a/api/IPA.RuntimeOptions.html
+++ b/api/IPA.RuntimeOptions.html
@@ -171,7 +171,7 @@ With this option set, whether or not the plugin is disabled during a given run i
Improve this Doc
diff --git a/api/IPA.Utilities.Async.SingleCreationValueCache-2.html b/api/IPA.Utilities.Async.SingleCreationValueCache-2.html
index 6c5a6fe0..19bf03eb 100644
--- a/api/IPA.Utilities.Async.SingleCreationValueCache-2.html
+++ b/api/IPA.Utilities.Async.SingleCreationValueCache-2.html
@@ -154,7 +154,7 @@ to ensure that values are only created once ever, without having multiple parall
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html
index 3a4ac9f2..91d66f05 100644
--- a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html
@@ -126,7 +126,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -172,7 +172,7 @@ it is disposed. Create this with Improve this Doc
diff --git a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
index d07f2b65..b5d90325 100644
--- a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
@@ -126,7 +126,7 @@ when it is disposed. Create this with Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
index 85fe89c7..49fe1b02 100644
--- a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
@@ -126,7 +126,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -172,7 +172,7 @@ it is disposed. Create this with Improve this Doc
diff --git a/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html b/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
index 9b4bcad4..f36a9f44 100644
--- a/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
@@ -126,7 +126,7 @@ when it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -172,7 +172,7 @@ when it is disposed. Create this with Improve this Doc
diff --git a/api/IPA.Utilities.Async.Synchronization.html b/api/IPA.Utilities.Async.Synchronization.html
index 3357bac0..783147a8 100644
--- a/api/IPA.Utilities.Async.Synchronization.html
+++ b/api/IPA.Utilities.Async.Synchronization.html
@@ -137,7 +137,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
diff --git a/api/index.html b/api/index.html
index ac8d549c..6aa68a50 100644
--- a/api/index.html
+++ b/api/index.html
@@ -90,7 +90,7 @@ Select a namespace and a class on the left to get started.
diff --git a/articles/command-line.html b/articles/command-line.html
index c591672f..92b96406 100644
--- a/articles/command-line.html
+++ b/articles/command-line.html
@@ -183,7 +183,7 @@ avaliable. If there is, it will be downloaded and installed on the next run. Thi
diff --git a/articles/contributing.html b/articles/contributing.html
index 737a0f1a..c2b79cf1 100644
--- a/articles/contributing.html
+++ b/articles/contributing.html
@@ -117,7 +117,7 @@ should reference the copy in there. When building for Release, it just uses the
diff --git a/articles/start-user.html b/articles/start-user.html
index 4bf55f7e..eddc8f45 100644
--- a/articles/start-user.html
+++ b/articles/start-user.html
@@ -161,7 +161,7 @@ the game directory, though your plugins will be moved to a different folder when
diff --git a/index.json b/index.json
index 0e7b58ca..37ac9749 100644
--- a/index.json
+++ b/index.json
@@ -1,103 +1,83 @@
{
- "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html": {
- "href": "api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html",
- "title": "Class SerializedNameAttribute",
- "keywords": "Class SerializedNameAttribute Specifies a name for the serialized field or property in an object being wrapped by Generated(Config, Boolean) that is different from the member name itself. Inheritance Object Attribute SerializedNameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Attributes Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = true)] public sealed class SerializedNameAttribute : Attribute, _Attribute Examples When serializing the following object, we might get the JSON that follows. public class PluginConfig { public virtual bool BooleanField { get; set; } = true; } { \"BooleanField\": true } However, if we were to add a SerializedNameAttribute to that field, we would get the following. public class PluginConfig { [SerializedName(\"bool\")] public virtual bool BooleanField { get; set; } = true; } { \"bool\": true } Constructors | Improve this Doc View Source SerializedNameAttribute(String) Creates a new SerializedNameAttribute with the given Name . Declaration public SerializedNameAttribute(string name) Parameters Type Name Description String name the value to assign to Name Properties | Improve this Doc View Source Name Gets the name to replace the member name with. Declaration public string Name { get; } Property Value Type Description String Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
- },
- "api/IPA.Config.Data.Map.html": {
- "href": "api/IPA.Config.Data.Map.html",
- "title": "Class Map",
- "keywords": "Class Map A ordered map of String to Value for serialization by an IConfigProvider . Use Map() or From(IDictionary) to create. Inheritance Object Value Map Implements IDictionary < String , Value > ICollection < KeyValuePair < String , Value >> IEnumerable < KeyValuePair < String , Value >> IEnumerable Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Map : Value, IDictionary, ICollection>, IEnumerable>, IEnumerable Properties | Improve this Doc View Source Count Gets the number of key-value pairs in this Map . Declaration public int Count { get; } Property Value Type Description Int32 See Also Count | Improve this Doc View Source Item[String] Accesses the Value at key in the map. Declaration public Value this[string key] { get; set; } Parameters Type Name Description String key the key to get the value associated with Property Value Type Description Value the value associated with the key See Also Item [TKey] | Improve this Doc View Source Keys Gets a collection of the keys for the Map . Declaration public ICollection Keys { get; } Property Value Type Description ICollection < String > See Also Keys | Improve this Doc View Source Values Gets a collection of the values in the Map . Declaration public ICollection Values { get; } Property Value Type Description ICollection < Value > Remarks Unlike all other iterables given by Map , this does not guarantee that order is maintained. See Also Values Methods | Improve this Doc View Source Add(String, Value) Adds a new Value with a given key. Declaration public void Add(string key, Value value) Parameters Type Name Description String key the key to put the value at Value value the Value to add See Also Add (TKey, TValue) | Improve this Doc View Source Clear() Clears the Map of its key-value pairs. Declaration public void Clear() See Also Clear () | Improve this Doc View Source ContainsKey(String) Checks if the Map contains a given key . Declaration public bool ContainsKey(string key) Parameters Type Name Description String key the key to check for Returns Type Description Boolean true if the key exists, otherwise false See Also ContainsKey (TKey) | Improve this Doc View Source GetEnumerator() Enumerates the Map 's key-value pairs. Declaration public IEnumerator> GetEnumerator() Returns Type Description IEnumerator < KeyValuePair < String , Value >> an IEnumerator of key-value pairs in this Map See Also GetEnumerator () | Improve this Doc View Source Remove(String) Removes the object associated with a key in this Map . Declaration public bool Remove(string key) Parameters Type Name Description String key the key to remove Returns Type Description Boolean true if the key existed, false otherwise See Also Remove (TKey) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a JSON-like set of key-value pairs Overrides Value.ToString() | Improve this Doc View Source TryGetValue(String, out Value) Gets the value associated with the specified key. Declaration public bool TryGetValue(string key, out Value value) Parameters Type Name Description String key the key of the value to get Value value the target location of the retrieved object Returns Type Description Boolean true if the key was found and value set, false otherwise See Also TryGetValue (TKey, TValue) Explicit Interface Implementations | Improve this Doc View Source ICollection>.Add(KeyValuePair) Declaration void ICollection>.Add(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item | Improve this Doc View Source ICollection>.Contains(KeyValuePair) Declaration bool ICollection>.Contains(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item Returns Type Description Boolean | Improve this Doc View Source ICollection>.CopyTo(KeyValuePair[], Int32) Declaration void ICollection>.CopyTo(KeyValuePair[] array, int arrayIndex) Parameters Type Name Description KeyValuePair < String , Value >[] array Int32 arrayIndex | Improve this Doc View Source ICollection>.IsReadOnly Declaration bool ICollection>.IsReadOnly { get; } Returns Type Description Boolean | Improve this Doc View Source ICollection>.Remove(KeyValuePair) Declaration bool ICollection>.Remove(KeyValuePair item) Parameters Type Name Description KeyValuePair < String , Value > item Returns Type Description Boolean | Improve this Doc View Source IEnumerable.GetEnumerator() Declaration IEnumerator IEnumerable.GetEnumerator() Returns Type Description IEnumerator Implements System.Collections.Generic.IDictionary System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Extension Methods EnumerableExtensions.Prepend(IEnumerable, T) EnumerableExtensions.Append(IEnumerable, T) EnumerableExtensions.NonNull(IEnumerable, Func) EnumerableExtensions.NonNull(IEnumerable, Func>) ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
- },
- "api/IPA.Config.Data.Integer.html": {
- "href": "api/IPA.Config.Data.Integer.html",
- "title": "Class Integer",
- "keywords": "Class Integer A Value representing an integer. This may hold a Int64 's worth of data. Inheritance Object Value Integer Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Integer : Value Properties | Improve this Doc View Source Value The actual value of the Integer object. Declaration public long Value { get; set; } Property Value Type Description Int64 Methods | Improve this Doc View Source AsFloat() Coerces this Integer into a FloatingPoint . Declaration public FloatingPoint AsFloat() Returns Type Description FloatingPoint a FloatingPoint representing the closest approximation of Value | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String the result of Value.ToString() Overrides Value.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
- },
- "api/IPA.Config.Data.Boolean.html": {
- "href": "api/IPA.Config.Data.Boolean.html",
- "title": "Class Boolean",
- "keywords": "Class Boolean A Value representing a boolean value. Inheritance Object Value Boolean Inherited Members Value.Null() Value.List() Value.Map() Value.From(String) Value.Text(String) Value.From(Int64) Value.Integer(Int64) Value.From(Decimal) Value.Float(Decimal) Value.From(Boolean) Value.Bool(Boolean) Value.From(IEnumerable) Value.From(IDictionary) Value.From(IEnumerable>) Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Data Assembly : IPA.Loader.dll Syntax public sealed class Boolean : Value Properties | Improve this Doc View Source Value The actual value fo this Boolean object. Declaration public bool Value { get; set; } Property Value Type Description Boolean Methods | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String the result of Value.ToString().ToLower() Overrides Value.ToString() Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
- },
- "api/IPA.Config.Config.html": {
- "href": "api/IPA.Config.Config.html",
- "title": "Class Config",
- "keywords": "Class Config An abstraction of a config file on disk, which handles synchronizing between a memory representation and the disk representation. Inheritance Object Config Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public class Config Properties | Improve this Doc View Source Name Gets the name associated with this Config object. Declaration public string Name { get; } Property Value Type Description String | Improve this Doc View Source Provider Gets the IConfigProvider associated with this Config object. Declaration public IConfigProvider Provider { get; } Property Value Type Description IConfigProvider Methods | Improve this Doc View Source GetConfigFor(String, String[]) Gets a Config object using the specified list of preferred config types. Declaration public static Config GetConfigFor(string configName, params string[] extensions) Parameters Type Name Description String configName the name of the mod for this config String [] extensions the preferred config types to try to get Returns Type Description Config a Config using the requested format, or of type JSON. | Improve this Doc View Source LoadAsync() Forces an asynchronous load from disk. Declaration public Task LoadAsync() Returns Type Description Task | Improve this Doc View Source LoadSync() Forces a synchronous load from disk. Declaration public void LoadSync() | Improve this Doc View Source Register(Type) Registers a IConfigProvider to use for configs. Declaration public static void Register(Type type) Parameters Type Name Description Type type the type to register | Improve this Doc View Source Register() Registers a IConfigProvider to use for configs. Declaration public static void Register() where T : IConfigProvider Type Parameters Name Description T the type to register | Improve this Doc View Source SetStore(IConfigStore) Sets this object's IConfigStore . Can only be called once. Declaration public void SetStore(IConfigStore store) Parameters Type Name Description IConfigStore store the IConfigStore to add to this instance Exceptions Type Condition InvalidOperationException If this was called before. Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) GeneratedStore.Generated(Config, Boolean)"
+ "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html": {
+ "href": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html",
+ "title": "Struct Synchronization.ReaderWriterLockSlimReadLocker",
+ "keywords": "Struct Synchronization.ReaderWriterLockSlimReadLocker A locker for a read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockRead(ReaderWriterLockSlim) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct ReaderWriterLockSlimReadLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization LockRead(ReaderWriterLockSlim)"
},
- "api/BSIPA_ModList.UI.ViewControllers.html": {
- "href": "api/BSIPA_ModList.UI.ViewControllers.html",
- "title": "",
- "keywords": "Classes MarkdownView A UI component that renders CommonMark Markdown in-game."
+ "api/IPA.Utilities.Async.Synchronization.MutexLocker.html": {
+ "href": "api/IPA.Utilities.Async.Synchronization.MutexLocker.html",
+ "title": "Struct Synchronization.MutexLocker",
+ "keywords": "Struct Synchronization.MutexLocker A locker for a Mutex that automatically releases when it is disposed. Create this with Lock(Mutex) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct MutexLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[]) See Also Synchronization Lock(Mutex)"
},
- "api/IPA.Config.Config.NameAttribute.html": {
- "href": "api/IPA.Config.Config.NameAttribute.html",
- "title": "Class Config.NameAttribute",
- "keywords": "Class Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Inheritance Object Attribute Config.NameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Parameter)] public sealed class NameAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source NameAttribute(String) Constructs the attribute with a specific name. Declaration public NameAttribute(string name) Parameters Type Name Description String name the name to use for the config. Properties | Improve this Doc View Source Name The name to use for the config. Declaration public string Name { get; } Property Value Type Description String the name to use for the config Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
+ "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html": {
+ "href": "api/IPA.Utilities.Async.SingleThreadTaskScheduler.html",
+ "title": "Class SingleThreadTaskScheduler",
+ "keywords": "Class SingleThreadTaskScheduler A single-threaded task scheduler that runs all of its tasks on the same thread. Inheritance Object TaskScheduler SingleThreadTaskScheduler Implements IDisposable Inherited Members TaskScheduler.TryDequeue(Task) TaskScheduler.FromCurrentSynchronizationContext() TaskScheduler.TryExecuteTask(Task) TaskScheduler.MaximumConcurrencyLevel TaskScheduler.Default TaskScheduler.Current TaskScheduler.Id TaskScheduler.UnobservedTaskException Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public class SingleThreadTaskScheduler : TaskScheduler, IDisposable Properties | Improve this Doc View Source IsRunning Gets whether or not the underlying thread has been started. Declaration public bool IsRunning { get; } Property Value Type Description Boolean Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Methods | Improve this Doc View Source Dispose() Disposes this object. This puts the object into an unusable state. Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes this object. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing whether or not to dispose managed objects | Improve this Doc View Source Exit() Terminates the runner thread, and waits for the currently running task to complete. Declaration public IEnumerable Exit() Returns Type Description IEnumerable < Task > an IEnumerable of Task s that did not execute Remarks After this method returns, this object has been disposed and is no longer in a valid state. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source GetScheduledTasks() Throws a NotSupportedException . Declaration protected override IEnumerable GetScheduledTasks() Returns Type Description IEnumerable < Task > nothing Overrides TaskScheduler.GetScheduledTasks() Exceptions Type Condition NotSupportedException Always. | Improve this Doc View Source Join() Waits for the runner thread to complete all tasks in the queue, then exits. Declaration public void Join() Remarks After this method returns, this object has been disposed and is no longer in a valid state. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source QueueTask(Task) Queues a given Task to this scheduler. The Task must> be scheduled for this TaskScheduler by the runtime. Declaration protected override void QueueTask(Task task) Parameters Type Name Description Task task the Task to queue Overrides TaskScheduler.QueueTask(Task) Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source Start() Starts the thread that executes tasks scheduled with this TaskScheduler Declaration public void Start() Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. | Improve this Doc View Source TryExecuteTaskInline(Task, Boolean) Rejects any attempts to execute a task inline. Declaration protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued) Parameters Type Name Description Task task the task to attempt to execute Boolean taskWasPreviouslyQueued whether the task was previously queued to this scheduler Returns Type Description Boolean false Overrides TaskScheduler.TryExecuteTaskInline(Task, Boolean) Remarks This task scheduler always runs its tasks on the thread that it manages, therefore it doesn't make sense to run it inline. Exceptions Type Condition ObjectDisposedException Thrown if this object has already been disposed. Implements System.IDisposable Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
},
- "api/IPA.Config.Stores.Converters.html": {
- "href": "api/IPA.Config.Stores.Converters.html",
- "title": "",
- "keywords": "Classes CaseInsensitiveEnumConverter A converter for an enum of type T , that converts the enum to its string representation and back, ignoring the case of the serialized value for deseiralization. CollectionConverter A base class for all ICollection type converters, providing most of the functionality. CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Converter Provides utility functions for custom converters. Converter Provides generic utilities for converters for certain types. CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . CustomValueTypeConverter A ValueConverter for custom value types, serialized identically to the reference types serialized with Generated(Config, Boolean) . DictionaryConverter A converter for instances of Dictionary . DictionaryConverter A converter for instances of Dictionary , specifying a value converter as a type parameter. EnumConverter A converter for an enum of type T , that converts the enum to its string representation and back. IDictionaryConverter A converter for instances of IDictionary . IDictionaryConverter A converter for instances of IDictionary , specifying a value converter as a type parameter. IListConverter A CollectionConverter for an IList , creating a List when deserializing. IListConverter An IListConverter which default constructs a converter for use as the value converter. IReadOnlyDictionaryConverter A converter for instances of IReadOnlyDictionary . IReadOnlyDictionaryConverter A converter for instances of IReadOnlyDictionary , specifying a value converter as a type parameter. ISetConverter A CollectionConverter for an ISet , creating a HashSet when deserializing. ISetConverter An ISetConverter which default constructs a converter for use as the value converter. ListConverter A CollectionConverter for a List . ListConverter A ListConverter which default constructs a converter for use as the value converter. NullableConverter A converter for a Nullable . NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute . NumericEnumConverter A converter for an enum of type T , that converts the enum to its underlying value for serialization."
+ "api/IPA.Utilities.Async.SingleCreationValueCache-2.html": {
+ "href": "api/IPA.Utilities.Async.SingleCreationValueCache-2.html",
+ "title": "Class SingleCreationValueCache",
+ "keywords": "Class SingleCreationValueCache A dictionary-like type intended for thread-safe value caches whose values are created only once ever. Inheritance Object SingleCreationValueCache Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public class SingleCreationValueCache Type Parameters Name Description TKey the key type of the cache TValue the value type of the cache Remarks This object basically wraps a ConcurrentDictionary with some special handling to ensure that values are only created once ever, without having multiple parallel constructions. Constructors | Improve this Doc View Source SingleCreationValueCache() Initializes a new instance of the SingleCreationValueCache class that is empty, has the default concurrency level, has the default initial capacity, and uses the default comparer for the key type. Declaration public SingleCreationValueCache() | Improve this Doc View Source SingleCreationValueCache(IEnumerable>) Initializes a new instance of the SingleCreationValueCache class that contains elements copied from the specified IEnumerable , has the default concurrency level, has the default initial capacity, and uses the default comparer for the key type. Declaration public SingleCreationValueCache(IEnumerable> collection) Parameters Type Name Description IEnumerable < KeyValuePair > collection the IEnumerable whose element are to be used for the new cache Exceptions Type Condition ArgumentNullException when any arguments are null ArgumentException collection contains duplicate keys | Improve this Doc View Source SingleCreationValueCache(IEnumerable>, IEqualityComparer) Initializes a new instance of the SingleCreationValueCache class that contains elements copied from the specified IEnumerable has the default concurrency level, has the default initial capacity, and uses the specified IEqualityComparer . Declaration public SingleCreationValueCache(IEnumerable> collection, IEqualityComparer comparer) Parameters Type Name Description IEnumerable < KeyValuePair > collection the IEnumerable whose elements are to be used for the new cache IEqualityComparer comparer the equality comparer to use when comparing keys Exceptions Type Condition ArgumentNullException collection or comparer is null | Improve this Doc View Source SingleCreationValueCache(IEqualityComparer) Initializes a new instance of the SingleCreationValueCache class that is empty, has the default concurrency level and capacity, and uses the specified IEqualityComparer . Declaration public SingleCreationValueCache(IEqualityComparer comparer) Parameters Type Name Description IEqualityComparer comparer the equality comparer to use when comparing keys Exceptions Type Condition ArgumentNullException comparer is null Properties | Improve this Doc View Source Count Gets the number of elements that this cache contains. Declaration public int Count { get; } Property Value Type Description Int32 | Improve this Doc View Source IsEmpty Gets a value that indicates whether this cache is empty. Declaration public bool IsEmpty { get; } Property Value Type Description Boolean Methods | Improve this Doc View Source Clear() Clears the cache. Declaration public void Clear() | Improve this Doc View Source ContainsKey(TKey) Gets a value indicating whether or not this cache contains key . Declaration public bool ContainsKey(TKey key) Parameters Type Name Description TKey key the key to search for Returns Type Description Boolean true if the cache contains the key, false otherwise | Improve this Doc View Source GetOrAdd(TKey, Func) Gets the value associated with the specified key from the cache. If it does not exist, and no creators are currently running for this key, then the creator is called to create the value and the value is added to the cache. If there is a creator currently running for the key, then this waits for the creator to finish and retrieves the value. Declaration public TValue GetOrAdd(TKey key, Func creator) Parameters Type Name Description TKey key the key to search for Func creator the delegate to use to create the value if it does not exist Returns Type Description TValue the value that was found, or the result of creator | Improve this Doc View Source ToArray() Copies the key-value pairs stored by the cache to a new array, filtering all elements that are currently being created. Declaration public KeyValuePair[] ToArray() Returns Type Description KeyValuePair [] an array containing a snapshot of the key-value pairs contained in this cache | Improve this Doc View Source TryGetValue(TKey, out TValue) Attempts to get the value associated with the specified key from the cache. Declaration public bool TryGetValue(TKey key, out TValue value) Parameters Type Name Description TKey key the key to search for TValue value the value retrieved, if any Returns Type Description Boolean true if the value was found, false otherwise Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
},
- "api/IPA.Config.Stores.Converters.NullableConverter-1.html": {
- "href": "api/IPA.Config.Stores.Converters.NullableConverter-1.html",
- "title": "Class NullableConverter",
- "keywords": "Class NullableConverter A converter for a Nullable . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class NullableConverter : ValueConverter, IValueConverter where T : struct Type Parameters Name Description T the underlying type of the Nullable Constructors | Improve this Doc View Source NullableConverter() Creates a converter with the default converter for the base type. Equivalent to new NullableConverter(Converter.Default) Declaration public NullableConverter() See Also NullableConverter(ValueConverter) Default | Improve this Doc View Source NullableConverter(ValueConverter) Creates a converter with the given underlying ValueConverter . Declaration public NullableConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the undlerlying ValueConverter to use Methods | Improve this Doc View Source FromValue(Value, Object) Converts a Value tree to a value. Declaration public override T? FromValue(Value value, object parent) Parameters Type Name Description Value value the Value tree to convert Object parent the object which will own the created object Returns Type Description Nullable the object represented by value Overrides IPA.Config.Stores.ValueConverter>.FromValue(IPA.Config.Data.Value, System.Object) | Improve this Doc View Source ToValue(Nullable, Object) Converts a nullable T to a Value tree. Declaration public override Value ToValue(T? obj, object parent) Parameters Type Name Description Nullable obj the value to serialize Object parent the object which owns obj Returns Type Description Value a Value tree representing obj . Overrides IPA.Config.Stores.ValueConverter>.ToValue(System.Nullable, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(T, String, U) ReflectionUtil.GetField(T, String) ReflectionUtil.SetProperty(T, String, U) ReflectionUtil.GetProperty(T, String) ReflectionUtil.InvokeMethod(T, String, Object[])"
+ "api/IPA.RuntimeOptions.html": {
+ "href": "api/IPA.RuntimeOptions.html",
+ "title": "Enum RuntimeOptions",
+ "keywords": "Enum RuntimeOptions Options that a plugin must specify to describe how it expects to be run. Namespace : IPA Assembly : IPA.Loader.dll Syntax public enum RuntimeOptions Fields Name Description DynamicInit Indicates that this plugin supports runtime enabling and disabling. When this is set, the plugin may be disabled at reasonable points during runtime. As with SingleStartInit , it will be initialized and enabled with the game if it is enabled on startup, and disabled with the game if it is enabled on shutdown. When a plugin with this set is enabled mid-game, the first time it is enabled, its initialization methods will be called, then its enable methods. All subsequent enables will NOT re-initialize, however the enable methods will be called. When a plugin with this set is disabled mid-game, the plugin instance will NOT be destroyed, and will instead be re-used for subsequent enables. The plugin is expected to handle this gracefully, and behave in a way that makes sense. SingleStartInit Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game. With this option set, whether or not the plugin is disabled during a given run is constant for that entire run. See Also PluginAttribute InitAttribute OnEnableAttribute OnDisableAttribute OnStartAttribute OnExitAttribute Extension Methods ReflectionUtil.SetField(String, U) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, U) ReflectionUtil.GetProperty(String) ReflectionUtil.InvokeMethod(String, Object[])"
},
- "api/IPA.Config.Stores.Converters.ListConverter-2.html": {
- "href": "api/IPA.Config.Stores.Converters.ListConverter-2.html",
- "title": "Class ListConverter",
- "keywords": "Class ListConverter A ListConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter Implements IValueConverter Inherited Members ListConverter.Create(Int32, Object) CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(List, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(List, Object) ValueConverter>.ToValue(List, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class ListConverter : ListConverter, IValueConverter where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TConverter the type of the converter to use for T Constructors | Improve this Doc View Source ListConverter() Creates an ListConverter using a default constructed TConverter element type. Equivalent to calling ListConverter(ValueConverter) with a default-constructed TConverter . Declaration public ListConverter() See Also ListConverter(ValueConverter