From d6669247f1163598383cada070aed6e34c581d78 Mon Sep 17 00:00:00 2001
From: nike4613 This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly.MarkdownView()
@@ -413,7 +413,7 @@ public class MarkdownView : MonoBehaviour
Improve this Doc
- View Source
+ View Source
HasEmbeddedImage
Markdown
@@ -481,7 +481,7 @@ public class MarkdownView : MonoBehaviour
Improve this Doc
- View Source
+ View Source
rectTransform
@@ -541,7 +541,7 @@ public class MarkdownView : MonoBehaviour
Improve this Doc
NameAttribute(String)
@@ -288,7 +288,7 @@ public sealed class NameAttribute : Attribute, _Attribute
Improve this Doc
- View Source
+ View Source
Name
@@ -346,7 +346,7 @@ public sealed class NameAttribute : Attribute, _Attribute
Improve this Doc
PreferAttribute(String[])
@@ -289,7 +289,7 @@ public sealed class PreferAttribute : Attribute, _Attribute
Improve this Doc
- View Source
+ View Source
PreferenceOrder
@@ -347,7 +347,7 @@ public sealed class PreferAttribute : Attribute, _Attribute
Improve this Doc
parent
.<
Improve this Doc
- View Source
+ View Source
parent
Improve this Doc
- View Source
+ View Source
ToValue(TCollection, Object)
@@ -522,7 +522,7 @@ with the parent parent
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.CollectionConverter-3.html b/api/IPA.Config.Stores.Converters.CollectionConverter-3.html
index 50d5c5bc..0053e063 100644
--- a/api/IPA.Config.Stores.Converters.CollectionConverter-3.html
+++ b/api/IPA.Config.Stores.Converters.CollectionConverter-3.html
@@ -191,7 +191,7 @@
Improve this Doc
- View Source
+ View Source
CollectionConverter()
@@ -243,7 +243,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.Converter-1.html b/api/IPA.Config.Stores.Converters.Converter-1.html
index 6f7fb7ee..cb2f9e2b 100644
--- a/api/IPA.Config.Stores.Converters.Converter-1.html
+++ b/api/IPA.Config.Stores.Converters.Converter-1.html
@@ -145,7 +145,7 @@
Improve this Doc
- View Source
+ View Source
Default
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.Converter.html b/api/IPA.Config.Stores.Converters.Converter.html
index 527b81aa..c7734068 100644
--- a/api/IPA.Config.Stores.Converters.Converter.html
+++ b/api/IPA.Config.Stores.Converters.Converter.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
FloatValue(Value)
@@ -180,7 +180,7 @@ or null if Improve this Doc
- View Source
+ View Source
IntValue(Value)
@@ -237,7 +237,7 @@ or null if Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html b/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html
index a4bc43d9..2556731a 100644
--- a/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html
@@ -159,7 +159,7 @@
Improve this Doc
- View Source
+ View Source
Deserialize(Value, Object)
@@ -219,7 +219,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -281,7 +281,7 @@
Improve this Doc
- View Source
+ View Source
Serialize(T, Object)
@@ -341,7 +341,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -433,7 +433,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.CustomValueTypeConverter-1.html b/api/IPA.Config.Stores.Converters.CustomValueTypeConverter-1.html
index 0902584a..61be928a 100644
--- a/api/IPA.Config.Stores.Converters.CustomValueTypeConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.CustomValueTypeConverter-1.html
@@ -160,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
Deserialize(Value, Object)
@@ -220,7 +220,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -282,7 +282,7 @@
Improve this Doc
- View Source
+ View Source
Serialize(T)
@@ -336,7 +336,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -424,7 +424,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.DictionaryConverter-1.html b/api/IPA.Config.Stores.Converters.DictionaryConverter-1.html
index eac00820..c847a6ff 100644
--- a/api/IPA.Config.Stores.Converters.DictionaryConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.DictionaryConverter-1.html
@@ -166,7 +166,7 @@
Improve this Doc
- View Source
+ View Source
DictionaryConverter()
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
DictionaryConverter(ValueConverter<TValue>)
@@ -218,7 +218,7 @@
Improve this Doc
- View Source
+ View Source
BaseConverter
@@ -251,7 +251,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -309,7 +309,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(Dictionary<String, TValue>, Object)
@@ -393,7 +393,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.DictionaryConverter-2.html b/api/IPA.Config.Stores.Converters.DictionaryConverter-2.html
index 8ea205b2..6eecacc9 100644
--- a/api/IPA.Config.Stores.Converters.DictionaryConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.DictionaryConverter-2.html
@@ -180,7 +180,7 @@
Improve this Doc
- View Source
+ View Source
DictionaryConverter()
@@ -223,7 +223,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.EnumConverter-1.html b/api/IPA.Config.Stores.Converters.EnumConverter-1.html
index 3e66da41..bc62bc66 100644
--- a/api/IPA.Config.Stores.Converters.EnumConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.EnumConverter-1.html
@@ -159,7 +159,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -233,7 +233,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -317,7 +317,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.IDictionaryConverter-1.html b/api/IPA.Config.Stores.Converters.IDictionaryConverter-1.html
index 59d11d2c..811382c6 100644
--- a/api/IPA.Config.Stores.Converters.IDictionaryConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.IDictionaryConverter-1.html
@@ -166,7 +166,7 @@
Improve this Doc
- View Source
+ View Source
IDictionaryConverter()
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
IDictionaryConverter(ValueConverter<TValue>)
@@ -218,7 +218,7 @@
Improve this Doc
- View Source
+ View Source
BaseConverter
@@ -251,7 +251,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -309,7 +309,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(IDictionary<String, TValue>, Object)
@@ -393,7 +393,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.IDictionaryConverter-2.html b/api/IPA.Config.Stores.Converters.IDictionaryConverter-2.html
index ea9e8ec4..19c7f01b 100644
--- a/api/IPA.Config.Stores.Converters.IDictionaryConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.IDictionaryConverter-2.html
@@ -180,7 +180,7 @@
Improve this Doc
- View Source
+ View Source
IDictionaryConverter()
@@ -223,7 +223,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.IListConverter-1.html b/api/IPA.Config.Stores.Converters.IListConverter-1.html
index 63ea618a..73920874 100644
--- a/api/IPA.Config.Stores.Converters.IListConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.IListConverter-1.html
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
IListConverter()
@@ -202,7 +202,7 @@
Improve this Doc
- View Source
+ View Source
IListConverter(ValueConverter<T>)
@@ -238,7 +238,7 @@
Improve this Doc
- View Source
+ View Source
Create(Int32, Object)
@@ -326,7 +326,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.IListConverter-2.html b/api/IPA.Config.Stores.Converters.IListConverter-2.html
index d4117f98..c85fc6e8 100644
--- a/api/IPA.Config.Stores.Converters.IListConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.IListConverter-2.html
@@ -190,7 +190,7 @@
Improve this Doc
- View Source
+ View Source
IListConverter()
@@ -242,7 +242,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-1.html b/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-1.html
index c85297bf..7fa4019b 100644
--- a/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-1.html
@@ -166,7 +166,7 @@
Improve this Doc
- View Source
+ View Source
IReadOnlyDictionaryConverter()
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
IReadOnlyDictionaryConverter(ValueConverter<TValue>)
@@ -218,7 +218,7 @@
Improve this Doc
- View Source
+ View Source
BaseConverter
@@ -251,7 +251,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -309,7 +309,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(IReadOnlyDictionary<String, TValue>, Object)
@@ -393,7 +393,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-2.html b/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-2.html
index c982c460..e7039504 100644
--- a/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-2.html
@@ -180,7 +180,7 @@
Improve this Doc
- View Source
+ View Source
IReadOnlyDictionaryConverter()
@@ -223,7 +223,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.ISetConverter-1.html b/api/IPA.Config.Stores.Converters.ISetConverter-1.html
index 9c610bf5..95fc7978 100644
--- a/api/IPA.Config.Stores.Converters.ISetConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.ISetConverter-1.html
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
ISetConverter()
@@ -202,7 +202,7 @@
Improve this Doc
- View Source
+ View Source
ISetConverter(ValueConverter<T>)
@@ -238,7 +238,7 @@
Improve this Doc
- View Source
+ View Source
Create(Int32, Object)
@@ -326,7 +326,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.ISetConverter-2.html b/api/IPA.Config.Stores.Converters.ISetConverter-2.html
index 6c60c761..f629b3d4 100644
--- a/api/IPA.Config.Stores.Converters.ISetConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.ISetConverter-2.html
@@ -190,7 +190,7 @@
Improve this Doc
- View Source
+ View Source
ISetConverter()
@@ -242,7 +242,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.ListConverter-1.html b/api/IPA.Config.Stores.Converters.ListConverter-1.html
index 172ab71e..5e3c5ddb 100644
--- a/api/IPA.Config.Stores.Converters.ListConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.ListConverter-1.html
@@ -182,7 +182,7 @@
Improve this Doc
- View Source
+ View Source
ListConverter()
@@ -202,7 +202,7 @@
Improve this Doc
- View Source
+ View Source
ListConverter(ValueConverter<T>)
@@ -238,7 +238,7 @@
Improve this Doc
- View Source
+ View Source
Create(Int32, Object)
@@ -326,7 +326,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.ListConverter-2.html b/api/IPA.Config.Stores.Converters.ListConverter-2.html
index 8aaf45ce..22e40004 100644
--- a/api/IPA.Config.Stores.Converters.ListConverter-2.html
+++ b/api/IPA.Config.Stores.Converters.ListConverter-2.html
@@ -190,7 +190,7 @@
Improve this Doc
- View Source
+ View Source
ListConverter()
@@ -242,7 +242,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.NullableConverter-1.html b/api/IPA.Config.Stores.Converters.NullableConverter-1.html
index 4ffec4c0..21381895 100644
--- a/api/IPA.Config.Stores.Converters.NullableConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.NullableConverter-1.html
@@ -160,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
NullableConverter()
@@ -183,7 +183,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
NullableConverter(ValueConverter<T>)
@@ -219,7 +219,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -277,7 +277,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
ToValue(Nullable<T>, Object)
@@ -361,7 +361,7 @@ Equivalent to
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 8a074850..8894c9cd 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
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.Converters.NumericEnumConverter-1.html b/api/IPA.Config.Stores.Converters.NumericEnumConverter-1.html
index 911692de..6b7ad8c2 100644
--- a/api/IPA.Config.Stores.Converters.NumericEnumConverter-1.html
+++ b/api/IPA.Config.Stores.Converters.NumericEnumConverter-1.html
@@ -159,7 +159,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -233,7 +233,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -317,7 +317,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.GeneratedStore.html b/api/IPA.Config.Stores.GeneratedStore.html
index 395c6754..6196d279 100644
--- a/api/IPA.Config.Stores.GeneratedStore.html
+++ b/api/IPA.Config.Stores.GeneratedStore.html
@@ -130,7 +130,7 @@ config stores.
Improve this Doc
- View Source
+ View Source
AssemblyVisibilityTarget
The name of the assembly that internals must be visible to to allow internal protection.
@@ -162,7 +162,7 @@ config stores.
Improve this Doc
- View Source
+ View Source
Create<T>()
@@ -218,7 +218,7 @@ config stores.
Improve this Doc
- View Source
+ View Source
Generated<T>(Config, Boolean)
@@ -347,7 +347,7 @@ the resulting object will implement it and notify it too.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Config.Stores.IValueConverter.html b/api/IPA.Config.Stores.IValueConverter.html
index f6e41e51..60c8e66c 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
Type
@@ -150,7 +150,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -206,7 +206,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
ToValue(Object, Object)
@@ -284,7 +284,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.Config.Stores.ValueConverter-1.html b/api/IPA.Config.Stores.ValueConverter-1.html
index fd95ab60..048b86b3 100644
--- a/api/IPA.Config.Stores.ValueConverter-1.html
+++ b/api/IPA.Config.Stores.ValueConverter-1.html
@@ -160,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -220,7 +220,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -282,7 +282,7 @@
Improve this Doc
- View Source
+ View Source
IValueConverter.FromValue(Value, Object)
@@ -334,7 +334,7 @@
Improve this Doc
- View Source
+ View Source
IValueConverter.ToValue(Object, Object)
@@ -386,7 +386,7 @@
Improve this Doc
- View Source
+ View Source
IValueConverter.Type
@@ -446,7 +446,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.InitAttribute.html b/api/IPA.InitAttribute.html
index 7b028343..bd418251 100644
--- a/api/IPA.InitAttribute.html
+++ b/api/IPA.InitAttribute.html
@@ -289,7 +289,7 @@ Parameter injection is done with Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.CannotRuntimeDisableException.html b/api/IPA.Loader.CannotRuntimeDisableException.html
index dba04fda..c2d9b657 100644
--- a/api/IPA.Loader.CannotRuntimeDisableException.html
+++ b/api/IPA.Loader.CannotRuntimeDisableException.html
@@ -169,7 +169,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio
Improve this Doc
- View Source
+ View Source
CannotRuntimeDisableException(PluginMetadata)
@@ -203,7 +203,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio
Improve this Doc
- View Source
+ View Source
CannotRuntimeDisableException(PluginMetadata, String)
@@ -243,7 +243,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio
Improve this Doc
- View Source
+ View Source
CannotRuntimeDisableException(SerializationInfo, StreamingContext)
@@ -298,7 +298,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio
Improve this Doc
- View Source
+ View Source
Plugin
@@ -358,7 +358,7 @@ public class CannotRuntimeDisableException : Exception, ISerializable, _Exceptio
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.Features.Feature.html b/api/IPA.Loader.Features.Feature.html
index 63075fc2..daf1d6b2 100644
--- a/api/IPA.Loader.Features.Feature.html
+++ b/api/IPA.Loader.Features.Feature.html
@@ -132,7 +132,7 @@
Improve this Doc
- View Source
+ View Source
InvalidMessage
@@ -165,7 +165,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
StoreOnPlugin
@@ -199,7 +199,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
AfterInit(PluginMetadata)
@@ -233,7 +233,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
AfterInit(PluginMetadata, Object)
@@ -273,7 +273,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
BeforeInit(PluginMetadata)
@@ -323,7 +323,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
BeforeLoad(PluginMetadata)
@@ -377,7 +377,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
Evaluate()
@@ -410,7 +410,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
Initialize(PluginMetadata, String[])
@@ -471,7 +471,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
RequireLoaded(PluginMetadata)
@@ -527,7 +527,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.IgnoreReason.html b/api/IPA.Loader.IgnoreReason.html
index 9c0653a7..c13b90f8 100644
--- a/api/IPA.Loader.IgnoreReason.html
+++ b/api/IPA.Loader.IgnoreReason.html
@@ -115,7 +115,7 @@
Improve this Doc
- View Source
+ View Source
IgnoreReason(Reason, String, Exception, PluginMetadata)
@@ -169,7 +169,7 @@
Improve this Doc
- View Source
+ View Source
Error
@@ -200,7 +200,7 @@
Improve this Doc
- View Source
+ View Source
Reason
@@ -231,7 +231,7 @@
Improve this Doc
- View Source
+ View Source
ReasonText
@@ -263,7 +263,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
RelatedTo
@@ -296,7 +296,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
Equals(IgnoreReason)
@@ -346,7 +346,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
Equals(Object)
@@ -395,7 +395,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
GetHashCode()
@@ -429,7 +429,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
Equality(IgnoreReason, IgnoreReason)
@@ -485,7 +485,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
Inequality(IgnoreReason, IgnoreReason)
@@ -563,7 +563,7 @@ include details about why the plugin was ignored, if it is present.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginInitInjector.InjectParameter.html b/api/IPA.Loader.PluginInitInjector.InjectParameter.html
index 52105179..5ad5f2b1 100644
--- a/api/IPA.Loader.PluginInitInjector.InjectParameter.html
+++ b/api/IPA.Loader.PluginInitInjector.InjectParameter.html
@@ -166,7 +166,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginInitInjector.html b/api/IPA.Loader.PluginInitInjector.html
index 198aac76..cc548a91 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
AddInjector(Type, PluginInitInjector.InjectParameter)
@@ -186,7 +186,7 @@ For all of the default injectors, only one of each will be generated, and any la
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html b/api/IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html
index 1a153dcb..5963df08 100644
--- a/api/IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html
+++ b/api/IPA.Loader.PluginManager.OnAnyPluginsStateChangedDelegate.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginManager.PluginDisableDelegate.html b/api/IPA.Loader.PluginManager.PluginDisableDelegate.html
index 425ed1cc..0aa84184 100644
--- a/api/IPA.Loader.PluginManager.PluginDisableDelegate.html
+++ b/api/IPA.Loader.PluginManager.PluginDisableDelegate.html
@@ -144,7 +144,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginManager.PluginEnableDelegate.html b/api/IPA.Loader.PluginManager.PluginEnableDelegate.html
index aa7da9a3..db974f67 100644
--- a/api/IPA.Loader.PluginManager.PluginEnableDelegate.html
+++ b/api/IPA.Loader.PluginManager.PluginEnableDelegate.html
@@ -144,7 +144,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginManager.html b/api/IPA.Loader.PluginManager.html
index 4a507bf6..18e12f79 100644
--- a/api/IPA.Loader.PluginManager.html
+++ b/api/IPA.Loader.PluginManager.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
AllPlugins
@@ -162,7 +162,7 @@ public static IEnumerable<PluginMetadata> AllPlugins { get; }
Improve this Doc
- View Source
+ View Source
DisabledPlugins
@@ -194,7 +194,7 @@ public static IEnumerable<PluginMetadata> AllPlugins { get; }
Improve this Doc
- View Source
+ View Source
EnabledPlugins
@@ -217,6 +217,38 @@ public static IEnumerable<PluginMetadata> AllPlugins { get; }
IEnumerable<PluginMetadata>
a collection of all enabled plugins
+
+
+
+
+
+ |
+ Improve this Doc
+
+
+ View Source
+
+
+ IgnoredPlugins
+ Gets a read-only dictionary of an ignored plugin to the reason it was ignored, as an IgnoreReason.
+
+
+ Declaration
+
+ public static IReadOnlyDictionary<PluginMetadata, IgnoreReason> IgnoredPlugins { get; }
+
+ Property Value
+
+
+
+ Type
+ Description
+
+
+
+
+ IReadOnlyDictionary<PluginMetadata, IgnoreReason>
+ a dictionary of PluginMetadata to IgnoreReason of ignored plugins
@@ -226,7 +258,7 @@ public static IEnumerable<PluginMetadata> AllPlugins { get; }
Improve this Doc
- View Source
+ View Source
Plugins
@@ -261,7 +293,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
GetDisabledPlugin(String)
@@ -311,7 +343,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
GetDisabledPluginFromId(String)
@@ -361,7 +393,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
GetPlugin(String)
@@ -411,7 +443,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
GetPluginFromId(String)
@@ -461,7 +493,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
IsDisabled(PluginMetadata)
@@ -511,7 +543,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
IsEnabled(PluginMetadata)
@@ -561,7 +593,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
PluginStateTransaction()
@@ -595,7 +627,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
OnAnyPluginsStateChanged
Called whenever any plugins, regardless of whether or not their change occurs during runtime, have their state changed.
@@ -629,7 +661,7 @@ provided represents operations that also run on the Unity main thread.
Improve this Doc
- View Source
+ View Source
OnPluginsStateChanged
Called whenever any plugins have their state changed at runtime with the Task representing that state change.
@@ -663,7 +695,7 @@ provided represents operations that also run on the Unity main thread.
Improve this Doc
- View Source
+ View Source
PluginDisabled
Called whenever a plugin is disabled, before the plugin in question is enabled.
@@ -693,7 +725,7 @@ provided represents operations that also run on the Unity main thread.
Improve this Doc
- View Source
+ View Source
PluginEnabled
Called whenever a plugin is enabled, before the plugin in question is enabled.
@@ -729,7 +761,7 @@ provided represents operations that also run on the Unity main thread.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.PluginMetadata.html b/api/IPA.Loader.PluginMetadata.html
index 900c2059..487768c6 100644
--- a/api/IPA.Loader.PluginMetadata.html
+++ b/api/IPA.Loader.PluginMetadata.html
@@ -126,7 +126,7 @@
Improve this Doc
- View Source
+ View Source
Assembly
@@ -158,7 +158,7 @@
Improve this Doc
- View Source
+ View Source
AssociatedFiles
@@ -181,6 +181,38 @@
IReadOnlyList<FileInfo>
a list of associated files
+
+
+
+
+
+ |
+ Improve this Doc
+
+
+ View Source
+
+
+ Author
+ The name of the author that wrote this plugin.
+
+
+ Declaration
+
+ public string Author { get; }
+
+ Property Value
+
+
+
+ Type
+ Description
+
+
+
+
+ String
+ the name of the plugin's author
@@ -190,7 +222,7 @@
Improve this Doc
- View Source
+ View Source
Features
@@ -222,7 +254,7 @@
Improve this Doc
- View Source
+ View Source
File
@@ -254,7 +286,7 @@
Improve this Doc
- View Source
+ View Source
Id
@@ -286,7 +318,7 @@
Improve this Doc
- View Source
+ View Source
IsBare
@@ -318,7 +350,7 @@
Improve this Doc
- View Source
+ View Source
Name
@@ -350,7 +382,7 @@
Improve this Doc
- View Source
+ View Source
PluginType
@@ -382,7 +414,7 @@
Improve this Doc
- View Source
+ View Source
RuntimeOptions
@@ -413,7 +445,7 @@
Improve this Doc
- View Source
+ View Source
Version
@@ -447,7 +479,7 @@
Improve this Doc
- View Source
+ View Source
ToString()
@@ -503,7 +535,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Loader.Reason.html b/api/IPA.Loader.Reason.html
index ad44df3a..2c10e202 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
- View Source
+ View Source
diff --git a/api/IPA.Loader.StateTransitionTransaction.html b/api/IPA.Loader.StateTransitionTransaction.html
index 3e4dcf32..5ec66395 100644
--- a/api/IPA.Loader.StateTransitionTransaction.html
+++ b/api/IPA.Loader.StateTransitionTransaction.html
@@ -133,7 +133,7 @@
Improve this Doc
- View Source
+ View Source
DisabledPlugins
@@ -180,7 +180,7 @@
Improve this Doc
- View Source
+ View Source
EnabledPlugins
@@ -227,7 +227,7 @@
Improve this Doc
- View Source
+ View Source
HasStateChanged
@@ -275,7 +275,7 @@
Improve this Doc
- View Source
+ View Source
WillNeedRestart
@@ -325,7 +325,7 @@
Improve this Doc
- View Source
+ View Source
Clone()
@@ -373,7 +373,7 @@
Improve this Doc
- View Source
+ View Source
Commit()
@@ -445,7 +445,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
Disable(PluginMetadata, Boolean)
@@ -526,7 +526,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
Disable(PluginMetadata, out IEnumerable<PluginMetadata>, Boolean)
@@ -612,7 +612,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
Dispose()
@@ -628,7 +628,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
Enable(PluginMetadata, Boolean)
@@ -709,7 +709,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
Enable(PluginMetadata, out IEnumerable<PluginMetadata>, Boolean)
@@ -795,7 +795,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
IsDisabled(PluginMetadata)
@@ -870,7 +870,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
IsEnabled(PluginMetadata)
@@ -971,7 +971,7 @@ the number of plugins being disabled, and the time they take.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.LogPrinter.html b/api/IPA.Logging.LogPrinter.html
index d638ae5f..d2066f38 100644
--- a/api/IPA.Logging.LogPrinter.html
+++ b/api/IPA.Logging.LogPrinter.html
@@ -132,7 +132,7 @@
Improve this Doc
- View Source
+ View Source
Filter
@@ -166,7 +166,7 @@
Improve this Doc
- View Source
+ View Source
EndPrint()
@@ -183,7 +183,7 @@ Use this to dispose file handles and the like.
Improve this Doc
- View Source
+ View Source
Print(Logger.Level, DateTime, String, String)
@@ -235,7 +235,7 @@ Use this to dispose file handles and the like.
Improve this Doc
- View Source
+ View Source
StartPrint()
@@ -274,7 +274,7 @@ Use this to create file handles and the like.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Logger.Level.html b/api/IPA.Logging.Logger.Level.html
index d3e8543a..4aa7050d 100644
--- a/api/IPA.Logging.Logger.Level.html
+++ b/api/IPA.Logging.Logger.Level.html
@@ -172,7 +172,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Logger.LogLevel.html b/api/IPA.Logging.Logger.LogLevel.html
index 54528847..9b680865 100644
--- a/api/IPA.Logging.Logger.LogLevel.html
+++ b/api/IPA.Logging.Logger.LogLevel.html
@@ -208,7 +208,7 @@ public enum LogLevel : byte
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Logger.html b/api/IPA.Logging.Logger.html
index 263a2868..3b2062ea 100644
--- a/api/IPA.Logging.Logger.html
+++ b/api/IPA.Logging.Logger.html
@@ -130,7 +130,7 @@
Improve this Doc
- View Source
+ View Source
LogFormat
@@ -164,7 +164,7 @@
Improve this Doc
- View Source
+ View Source
Critical(Exception)
@@ -203,7 +203,7 @@ Equivalent to Log(Level.Critical, e);
Improve this Doc
- View Source
+ View Source
Critical(String)
@@ -242,7 +242,7 @@ Equivalent to Log(Level.Critical, message);
Improve this Doc
- View Source
+ View Source
Debug(Exception)
@@ -281,7 +281,7 @@ Equivalent to Log(Level.Debug, e);
Improve this Doc
- View Source
+ View Source
Debug(String)
@@ -320,7 +320,7 @@ Equivalent to Log(Level.Debug, message);
Improve this Doc
- View Source
+ View Source
Error(Exception)
@@ -359,7 +359,7 @@ Equivalent to Log(Level.Error, e);
Improve this Doc
- View Source
+ View Source
Error(String)
@@ -398,7 +398,7 @@ Equivalent to Log(Level.Error, message);
Improve this Doc
- View Source
+ View Source
Info(Exception)
@@ -437,7 +437,7 @@ Equivalent to Log(Level.Info, e);
Improve this Doc
- View Source
+ View Source
Info(String)
@@ -476,7 +476,7 @@ Equivalent to Log(Level.Info, message);
Improve this Doc
- View Source
+ View Source
Log(Logger.Level, Exception)
@@ -516,7 +516,7 @@ Equivalent to Log(Level.Info, message);
Improve this Doc
- View Source
+ View Source
Log(Logger.Level, String)
@@ -556,7 +556,7 @@ Equivalent to Log(Level.Info, message);
Improve this Doc
- View Source
+ View Source
Notice(Exception)
@@ -595,7 +595,7 @@ Equivalent to Log(Level.Notice, e);
Improve this Doc
- View Source
+ View Source
Notice(String)
@@ -634,7 +634,7 @@ Equivalent to Log(Level.Notice, message);
Improve this Doc
- View Source
+ View Source
Trace(Exception)
@@ -673,7 +673,7 @@ Equivalent to Log(Level.Trace, e);
Improve this Doc
- View Source
+ View Source
Trace(String)
@@ -712,7 +712,7 @@ Equivalent to Log(Level.Trace, message);
Improve this Doc
- View Source
+ View Source
Warn(Exception)
@@ -751,7 +751,7 @@ Equivalent to Log(Level.Warning, e);
Improve this Doc
- View Source
+ View Source
Warn(String)
@@ -815,7 +815,7 @@ Equivalent to Log(Level.Warning, message);
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.LoggerExtensions.html b/api/IPA.Logging.LoggerExtensions.html
index b046c8a1..822ed371 100644
--- a/api/IPA.Logging.LoggerExtensions.html
+++ b/api/IPA.Logging.LoggerExtensions.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
GetChildLogger(Logger, String)
@@ -191,7 +191,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Printers.ColoredConsolePrinter.html b/api/IPA.Logging.Printers.ColoredConsolePrinter.html
index e01a0789..0df4cf26 100644
--- a/api/IPA.Logging.Printers.ColoredConsolePrinter.html
+++ b/api/IPA.Logging.Printers.ColoredConsolePrinter.html
@@ -136,7 +136,7 @@
Improve this Doc
- View Source
+ View Source
Color
@@ -168,7 +168,7 @@
Improve this Doc
- View Source
+ View Source
Filter
@@ -204,7 +204,7 @@
Improve this Doc
- View Source
+ View Source
Print(Logger.Level, DateTime, String, String)
@@ -280,7 +280,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Printers.ColorlessConsolePrinter.html b/api/IPA.Logging.Printers.ColorlessConsolePrinter.html
index 385f66de..3d88ffa4 100644
--- a/api/IPA.Logging.Printers.ColorlessConsolePrinter.html
+++ b/api/IPA.Logging.Printers.ColorlessConsolePrinter.html
@@ -136,7 +136,7 @@
Improve this Doc
- View Source
+ View Source
Filter
@@ -172,7 +172,7 @@
Improve this Doc
- View Source
+ View Source
Print(Logger.Level, DateTime, String, String)
@@ -248,7 +248,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Printers.GZFilePrinter.html b/api/IPA.Logging.Printers.GZFilePrinter.html
index 2af2626c..a598a075 100644
--- a/api/IPA.Logging.Printers.GZFilePrinter.html
+++ b/api/IPA.Logging.Printers.GZFilePrinter.html
@@ -143,7 +143,7 @@
Improve this Doc
- View Source
+ View Source
FileWriter
The StreamWriter that writes to the GZip file.
@@ -176,7 +176,7 @@
Improve this Doc
- View Source
+ View Source
Dispose()
@@ -191,7 +191,7 @@
Improve this Doc
- View Source
+ View Source
Dispose(Boolean)
@@ -225,7 +225,7 @@
Improve this Doc
- View Source
+ View Source
EndPrint()
@@ -243,7 +243,7 @@
Improve this Doc
- View Source
+ View Source
GetFileInfo()
@@ -275,7 +275,7 @@
Improve this Doc
- View Source
+ View Source
StartPrint()
@@ -319,7 +319,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Printers.GlobalLogFilePrinter.html b/api/IPA.Logging.Printers.GlobalLogFilePrinter.html
index adf64ff8..a4a8c443 100644
--- a/api/IPA.Logging.Printers.GlobalLogFilePrinter.html
+++ b/api/IPA.Logging.Printers.GlobalLogFilePrinter.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
Filter
@@ -186,7 +186,7 @@
Improve this Doc
- View Source
+ View Source
GetFileInfo()
@@ -220,7 +220,7 @@
Improve this Doc
- View Source
+ View Source
Print(Logger.Level, DateTime, String, String)
@@ -300,7 +300,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Printers.PluginLogFilePrinter.html b/api/IPA.Logging.Printers.PluginLogFilePrinter.html
index 4490bb3b..4460cf9f 100644
--- a/api/IPA.Logging.Printers.PluginLogFilePrinter.html
+++ b/api/IPA.Logging.Printers.PluginLogFilePrinter.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
PluginLogFilePrinter(String)
@@ -186,7 +186,7 @@
Improve this Doc
- View Source
+ View Source
Filter
@@ -222,7 +222,7 @@
Improve this Doc
- View Source
+ View Source
GetFileInfo()
@@ -256,7 +256,7 @@
Improve this Doc
- View Source
+ View Source
Print(Logger.Level, DateTime, String, String)
@@ -336,7 +336,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.Printers.PluginSubLogPrinter.html b/api/IPA.Logging.Printers.PluginSubLogPrinter.html
index 16ab3f5f..d68dd135 100644
--- a/api/IPA.Logging.Printers.PluginSubLogPrinter.html
+++ b/api/IPA.Logging.Printers.PluginSubLogPrinter.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
PluginSubLogPrinter(String, String)
@@ -192,7 +192,7 @@
Improve this Doc
- View Source
+ View Source
Filter
@@ -228,7 +228,7 @@
Improve this Doc
- View Source
+ View Source
GetFileInfo()
@@ -262,7 +262,7 @@
Improve this Doc
- View Source
+ View Source
Print(Logger.Level, DateTime, String, String)
@@ -342,7 +342,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Logging.StandardLogger.html b/api/IPA.Logging.StandardLogger.html
index f01cd38c..73acbbab 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
ConsoleWriter
@@ -213,7 +213,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
IsOnLoggerThread
@@ -245,7 +245,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
PrintFilter
@@ -279,7 +279,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
AddPrinter(LogPrinter)
@@ -313,7 +313,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
Debug(String)
@@ -353,7 +353,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
Log(Logger.Level, String)
@@ -420,7 +420,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.Old.IEnhancedPlugin.html b/api/IPA.Old.IEnhancedPlugin.html
index 5122b080..b5d0aba1 100644
--- a/api/IPA.Old.IEnhancedPlugin.html
+++ b/api/IPA.Old.IEnhancedPlugin.html
@@ -128,7 +128,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
Filter
@@ -164,7 +164,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
OnLateUpdate()
@@ -202,7 +202,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Old.IPlugin.html b/api/IPA.Old.IPlugin.html
index 84ed6874..ae5e69d0 100644
--- a/api/IPA.Old.IPlugin.html
+++ b/api/IPA.Old.IPlugin.html
@@ -102,7 +102,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
Name
@@ -133,7 +133,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
Version
@@ -166,7 +166,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
OnApplicationQuit()
@@ -182,7 +182,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
OnApplicationStart()
@@ -198,7 +198,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
OnFixedUpdate()
@@ -214,7 +214,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
OnLevelWasInitialized(Int32)
@@ -247,7 +247,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
OnLevelWasLoaded(Int32)
@@ -280,7 +280,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
OnUpdate()
@@ -318,7 +318,7 @@ public interface IPlugin
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.OnDisableAttribute.html b/api/IPA.OnDisableAttribute.html
index cfacb21d..b2ca1802 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
- View Source
+ View Source
diff --git a/api/IPA.OnEnableAttribute.html b/api/IPA.OnEnableAttribute.html
index 3a01c6a3..8d6d1033 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
- View Source
+ View Source
diff --git a/api/IPA.OnExitAttribute.html b/api/IPA.OnExitAttribute.html
index 77755ac4..445b3678 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
- View Source
+ View Source
diff --git a/api/IPA.OnStartAttribute.html b/api/IPA.OnStartAttribute.html
index ed2de25b..2243dd56 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
- View Source
+ View Source
diff --git a/api/IPA.PluginAttribute.html b/api/IPA.PluginAttribute.html
index 50d3f604..8aaaf08a 100644
--- a/api/IPA.PluginAttribute.html
+++ b/api/IPA.PluginAttribute.html
@@ -252,7 +252,7 @@ public sealed class PluginAttribute : Attribute, _Attribute
Improve this Doc
- View Source
+ View Source
PluginAttribute(RuntimeOptions)
@@ -289,7 +289,7 @@ to indicate the runtime capabilities of the plugin.
Improve this Doc
- View Source
+ View Source
RuntimeOptions
@@ -354,7 +354,7 @@ to indicate the runtime capabilities of the plugin.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.RuntimeOptions.html b/api/IPA.RuntimeOptions.html
index b0fe81a0..79c9c68a 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
- View Source
+ View Source
diff --git a/api/IPA.Utilities.AlmostVersion.StoredAs.html b/api/IPA.Utilities.AlmostVersion.StoredAs.html
index bb6e13a3..b662e34e 100644
--- a/api/IPA.Utilities.AlmostVersion.StoredAs.html
+++ b/api/IPA.Utilities.AlmostVersion.StoredAs.html
@@ -142,7 +142,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.AlmostVersion.html b/api/IPA.Utilities.AlmostVersion.html
index a73e5818..1e70c7b9 100644
--- a/api/IPA.Utilities.AlmostVersion.html
+++ b/api/IPA.Utilities.AlmostVersion.html
@@ -126,7 +126,7 @@ not a valid .
Improve this Doc
- View Source
+ View Source
AlmostVersion(SemVer.Version)
@@ -160,7 +160,7 @@ not a valid .
Improve this Doc
- View Source
+ View Source
AlmostVersion(String)
@@ -194,7 +194,7 @@ not a valid .
Improve this Doc
- View Source
+ View Source
AlmostVersion(String, AlmostVersion)
@@ -235,7 +235,7 @@ same way as the AlmostVe
Improve this Doc
- View Source
+ View Source
AlmostVersion(String, AlmostVersion.StoredAs)
@@ -278,7 +278,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
SemverValue
@@ -310,7 +310,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
StorageMode
@@ -342,7 +342,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
StringValue
@@ -376,7 +376,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
CompareTo(AlmostVersion)
@@ -434,7 +434,7 @@ or Improve this Doc
- View Source
+ View Source
CompareTo(SemVer.Version)
@@ -492,7 +492,7 @@ be thrown.
Improve this Doc
- View Source
+ View Source
Equals(Object)
@@ -551,7 +551,7 @@ be thrown.
Improve this Doc
- View Source
+ View Source
GetHashCode()
@@ -589,7 +589,7 @@ be thrown.
Improve this Doc
- View Source
+ View Source
ToString()
@@ -630,7 +630,7 @@ stored as a , it is equivalent to calling Improve this Doc
- View Source
+ View Source
Equality(AlmostVersion, AlmostVersion)
@@ -695,7 +695,7 @@ does not.
Improve this Doc
- View Source
+ View Source
Implicit(AlmostVersion to SemVer.Version)
@@ -749,7 +749,7 @@ If not applicable, returns null
Improve this Doc
- View Source
+ View Source
Implicit(SemVer.Version to AlmostVersion)
@@ -802,7 +802,7 @@ If not applicable, returns null
Improve this Doc
- View Source
+ View Source
Inequality(AlmostVersion, AlmostVersion)
@@ -891,7 +891,7 @@ If not applicable, returns null
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.AlmostVersionConverter.html b/api/IPA.Utilities.AlmostVersionConverter.html
index c7c3a43f..2c9198a9 100644
--- a/api/IPA.Utilities.AlmostVersionConverter.html
+++ b/api/IPA.Utilities.AlmostVersionConverter.html
@@ -143,7 +143,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -200,7 +200,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(AlmostVersion, Object)
@@ -284,7 +284,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Coroutines.html b/api/IPA.Utilities.Async.Coroutines.html
index 1d8cd94a..7f0d1992 100644
--- a/api/IPA.Utilities.Async.Coroutines.html
+++ b/api/IPA.Utilities.Async.Coroutines.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
WaitForTask(Task)
@@ -185,7 +185,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.SingleCreationValueCache-2.html b/api/IPA.Utilities.Async.SingleCreationValueCache-2.html
index 157be47a..0efaf6f7 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
SingleCreationValueCache()
@@ -172,7 +172,7 @@ capacity, and uses the default comparer for the key type.
Improve this Doc
- View Source
+ View Source
SingleCreationValueCache(IEnumerable<KeyValuePair<TKey, TValue>>)
@@ -230,7 +230,7 @@ the default comparer for the key type.
Improve this Doc
- View Source
+ View Source
SingleCreationValueCache(IEnumerable<KeyValuePair<TKey, TValue>>, IEqualityComparer<TKey>)
@@ -289,7 +289,7 @@ the specified Improve this Doc
- View Source
+ View Source
SingleCreationValueCache(IEqualityComparer<TKey>)
@@ -343,7 +343,7 @@ the specified Improve this Doc
- View Source
+ View Source
Count
@@ -374,7 +374,7 @@ the specified Improve this Doc
- View Source
+ View Source
IsEmpty
@@ -407,7 +407,7 @@ the specified Improve this Doc
- View Source
+ View Source
Clear()
@@ -423,7 +423,7 @@ the specified Improve this Doc
- View Source
+ View Source
ContainsKey(TKey)
@@ -473,7 +473,7 @@ the specified Improve this Doc
- View Source
+ View Source
GetOrAdd(TKey, Func<TKey, TValue>)
@@ -532,7 +532,7 @@ this waits for the creator to finish and retrieves the value.
Improve this Doc
- View Source
+ View Source
ToArray()
@@ -565,7 +565,7 @@ created.
Improve this Doc
- View Source
+ View Source
TryGetValue(TKey, out TValue)
@@ -643,7 +643,7 @@ created.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html b/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html
index 89e83d66..dd21c13d 100644
--- a/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html
+++ b/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html
@@ -158,7 +158,7 @@
Improve this Doc
- View Source
+ View Source
IsRunning
@@ -207,7 +207,7 @@
Improve this Doc
- View Source
+ View Source
Dispose()
@@ -223,7 +223,7 @@
Improve this Doc
- View Source
+ View Source
Dispose(Boolean)
@@ -257,7 +257,7 @@
Improve this Doc
- View Source
+ View Source
Exit()
@@ -308,7 +308,7 @@
Improve this Doc
- View Source
+ View Source
GetScheduledTasks()
@@ -358,7 +358,7 @@
Improve this Doc
- View Source
+ View Source
Join()
@@ -393,7 +393,7 @@
Improve this Doc
- View Source
+ View Source
QueueTask(Task)
@@ -446,7 +446,7 @@ scheduled for this Improve this Doc
- View Source
+ View Source
Start()
@@ -478,7 +478,7 @@ scheduled for this Improve this Doc
- View Source
+ View Source
TryExecuteTaskInline(Task, Boolean)
@@ -581,7 +581,7 @@ make sense to run it inline.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.MutexLocker.html b/api/IPA.Utilities.Async.Synchronization.MutexLocker.html
index 393f891d..eed18a94 100644
--- a/api/IPA.Utilities.Async.Synchronization.MutexLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.MutexLocker.html
@@ -126,7 +126,7 @@ Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -172,7 +172,7 @@ Create this with 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 1f591b6f..4b7ff725 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
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html b/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
index 67a61d84..da9f4f0a 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
Upgrade()
@@ -165,7 +165,7 @@ upgrading the current thread's lock.
Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -211,7 +211,7 @@ upgrading the current thread's lock.
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 82eb42bf..86522720 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
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html b/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html
index 37a505e5..cb3c421b 100644
--- a/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html
@@ -126,7 +126,7 @@ Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -172,7 +172,7 @@ Create this with Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html b/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
index 7a7629af..408c9f54 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
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html b/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html
index f8f31a14..af8c2e86 100644
--- a/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html
+++ b/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html
@@ -126,7 +126,7 @@ Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -172,7 +172,7 @@ Create this with Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.Synchronization.html b/api/IPA.Utilities.Async.Synchronization.html
index 9826050f..02a7049d 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
Lock(Mutex)
@@ -187,7 +187,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
Lock(Semaphore)
@@ -237,7 +237,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
Lock(SemaphoreSlim)
@@ -287,7 +287,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockAsync(SemaphoreSlim)
@@ -337,7 +337,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockRead(ReaderWriterLockSlim)
@@ -387,7 +387,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockReadUpgradable(ReaderWriterLockSlim)
@@ -437,7 +437,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockWrite(ReaderWriterLockSlim)
@@ -493,7 +493,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html b/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html
index 8d49bb54..465ae91c 100644
--- a/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html
+++ b/api/IPA.Utilities.Async.UnityMainThreadTaskScheduler.html
@@ -155,7 +155,7 @@
Improve this Doc
- View Source
+ View Source
Cancelling
@@ -187,7 +187,7 @@
Improve this Doc
- View Source
+ View Source
Default
@@ -219,7 +219,7 @@
Improve this Doc
- View Source
+ View Source
Factory
@@ -251,7 +251,7 @@
Improve this Doc
- View Source
+ View Source
IsRunning
@@ -283,7 +283,7 @@
Improve this Doc
- View Source
+ View Source
YieldAfterTasks
@@ -315,7 +315,7 @@
Improve this Doc
- View Source
+ View Source
YieldAfterTime
@@ -349,7 +349,7 @@
Improve this Doc
- View Source
+ View Source
Cancel()
@@ -387,7 +387,7 @@ All remaining tasks will be left in the queue.
Improve this Doc
- View Source
+ View Source
Coroutine()
@@ -451,7 +451,7 @@ exit on its own.
Improve this Doc
- View Source
+ View Source
Dispose()
@@ -467,7 +467,7 @@ exit on its own.
Improve this Doc
- View Source
+ View Source
Dispose(Boolean)
@@ -501,7 +501,7 @@ exit on its own.
Improve this Doc
- View Source
+ View Source
GetScheduledTasks()
@@ -551,7 +551,7 @@ exit on its own.
Improve this Doc
- View Source
+ View Source
QueueTask(Task)
@@ -604,7 +604,7 @@ scheduled for this Improve this Doc
- View Source
+ View Source
TryExecuteTaskInline(Task, Boolean)
@@ -703,7 +703,7 @@ scheduled for this Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html b/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html
index 9b3a4edf..f471bdbf 100644
--- a/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html
+++ b/api/IPA.Utilities.CriticalSection.AutoExecuteSection.html
@@ -125,7 +125,7 @@
Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -166,7 +166,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.CriticalSection.html b/api/IPA.Utilities.CriticalSection.html
index a328f424..69b5a943 100644
--- a/api/IPA.Utilities.CriticalSection.html
+++ b/api/IPA.Utilities.CriticalSection.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
EnterExecuteSection()
@@ -145,7 +145,7 @@
Improve this Doc
- View Source
+ View Source
ExecuteSection()
@@ -177,7 +177,7 @@
Improve this Doc
- View Source
+ View Source
ExitExecuteSection()
@@ -199,7 +199,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.EnumerableExtensions.html b/api/IPA.Utilities.EnumerableExtensions.html
index 8a6de0b2..4e6521ca 100644
--- a/api/IPA.Utilities.EnumerableExtensions.html
+++ b/api/IPA.Utilities.EnumerableExtensions.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
Append<T>(IEnumerable<T>, T)
@@ -201,7 +201,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T>(IEnumerable<T>)
@@ -268,7 +268,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T>(IEnumerable<Nullable<T>>)
@@ -335,7 +335,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T, U>(IEnumerable<T>, Func<T, U>)
@@ -413,7 +413,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T, U>(IEnumerable<T>, Func<T, Nullable<U>>)
@@ -491,7 +491,7 @@
Improve this Doc
- View Source
+ View Source
Prepend<T>(IEnumerable<T>, T)
@@ -569,7 +569,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Extensions.html b/api/IPA.Utilities.Extensions.html
index 1230949c..001e08d8 100644
--- a/api/IPA.Utilities.Extensions.html
+++ b/api/IPA.Utilities.Extensions.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
GetDefault(Type)
@@ -179,7 +179,7 @@
Improve this Doc
- View Source
+ View Source
IsSubPathOf(String, String)
@@ -234,7 +234,7 @@ only matches if the base dir folder name is matched exactly ("c:\foobar\fil
Improve this Doc
- View Source
+ View Source
Right(String, Int32)
@@ -290,7 +290,7 @@ only matches if the base dir folder name is matched exactly ("c:\foobar\fil
Improve this Doc
- View Source
+ View Source
Unwrap(Nullable<Boolean>)
@@ -340,7 +340,7 @@ only matches if the base dir folder name is matched exactly ("c:\foobar\fil
Improve this Doc
- View Source
+ View Source
WithEnding(String, String)
@@ -403,7 +403,7 @@ results in satisfying .EndsWith(ending).
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.FieldAccessor-2.Accessor.html b/api/IPA.Utilities.FieldAccessor-2.Accessor.html
index 8c761a54..a706c4a2 100644
--- a/api/IPA.Utilities.FieldAccessor-2.Accessor.html
+++ b/api/IPA.Utilities.FieldAccessor-2.Accessor.html
@@ -154,7 +154,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.FieldAccessor-2.html b/api/IPA.Utilities.FieldAccessor-2.html
index 62ffc724..8f074667 100644
--- a/api/IPA.Utilities.FieldAccessor-2.html
+++ b/api/IPA.Utilities.FieldAccessor-2.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
Access(ref T, String)
@@ -226,7 +226,7 @@
Improve this Doc
- View Source
+ View Source
Get(T, String)
@@ -304,7 +304,7 @@
Improve this Doc
- View Source
+ View Source
Get(ref T, String)
@@ -386,7 +386,7 @@ as it prevents a copy.
Improve this Doc
- View Source
+ View Source
GetAccessor(String)
@@ -452,7 +452,7 @@ as it prevents a copy.
Improve this Doc
- View Source
+ View Source
Set(T, String, U)
@@ -523,7 +523,7 @@ as it prevents a copy.
Improve this Doc
- View Source
+ View Source
Set(ref T, String, U)
@@ -604,7 +604,7 @@ as it prevents a copy.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.MethodAccessor-2.html b/api/IPA.Utilities.MethodAccessor-2.html
index 7c4621e4..d0d46caa 100644
--- a/api/IPA.Utilities.MethodAccessor-2.html
+++ b/api/IPA.Utilities.MethodAccessor-2.html
@@ -151,7 +151,7 @@
Improve this Doc
- View Source
+ View Source
GetDelegate(String)
@@ -228,7 +228,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.PropertyAccessor-2.Getter.html b/api/IPA.Utilities.PropertyAccessor-2.Getter.html
index 5cab68b0..18140394 100644
--- a/api/IPA.Utilities.PropertyAccessor-2.Getter.html
+++ b/api/IPA.Utilities.PropertyAccessor-2.Getter.html
@@ -154,7 +154,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.PropertyAccessor-2.Setter.html b/api/IPA.Utilities.PropertyAccessor-2.Setter.html
index 61da8a97..a16b4743 100644
--- a/api/IPA.Utilities.PropertyAccessor-2.Setter.html
+++ b/api/IPA.Utilities.PropertyAccessor-2.Setter.html
@@ -144,7 +144,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.PropertyAccessor-2.html b/api/IPA.Utilities.PropertyAccessor-2.html
index d73ee8d3..7256bf82 100644
--- a/api/IPA.Utilities.PropertyAccessor-2.html
+++ b/api/IPA.Utilities.PropertyAccessor-2.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
Get(T, String)
@@ -227,7 +227,7 @@
Improve this Doc
- View Source
+ View Source
Get(ref T, String)
@@ -308,7 +308,7 @@ it avoids a copy.
Improve this Doc
- View Source
+ View Source
GetGetter(String)
@@ -374,7 +374,7 @@ it avoids a copy.
Improve this Doc
- View Source
+ View Source
GetSetter(String)
@@ -440,7 +440,7 @@ it avoids a copy.
Improve this Doc
- View Source
+ View Source
Set(T, String, U)
@@ -510,7 +510,7 @@ it avoids a copy.
Improve this Doc
- View Source
+ View Source
Set(ref T, String, U)
@@ -586,7 +586,7 @@ it avoids a copy.
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Ref-1.html b/api/IPA.Utilities.Ref-1.html
index 7b713352..09984875 100644
--- a/api/IPA.Utilities.Ref-1.html
+++ b/api/IPA.Utilities.Ref-1.html
@@ -150,7 +150,7 @@
Improve this Doc
- View Source
+ View Source
Ref(T)
@@ -186,7 +186,7 @@
Improve this Doc
- View Source
+ View Source
Error
@@ -218,7 +218,7 @@
Improve this Doc
- View Source
+ View Source
Value
@@ -252,7 +252,7 @@
Improve this Doc
- View Source
+ View Source
CompareTo(T)
@@ -302,7 +302,7 @@
Improve this Doc
- View Source
+ View Source
CompareTo(Ref<T>)
@@ -352,7 +352,7 @@
Improve this Doc
- View Source
+ View Source
Verify()
@@ -370,7 +370,7 @@
Improve this Doc
- View Source
+ View Source
Implicit(T to Ref<T>)
@@ -420,7 +420,7 @@
Improve this Doc
- View Source
+ View Source
Implicit(Ref<T> to T)
@@ -499,7 +499,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Ref.html b/api/IPA.Utilities.Ref.html
index 1fb7d457..93cdccf3 100644
--- a/api/IPA.Utilities.Ref.html
+++ b/api/IPA.Utilities.Ref.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
Create<T>(T)
@@ -201,7 +201,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.ReflectionUtil.html b/api/IPA.Utilities.ReflectionUtil.html
index a2001b0d..26a8f9a8 100644
--- a/api/IPA.Utilities.ReflectionUtil.html
+++ b/api/IPA.Utilities.ReflectionUtil.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
CopyComponent(Component, Type, GameObject, Type)
@@ -197,7 +197,7 @@
Improve this Doc
- View Source
+ View Source
CopyComponent<T>(Component, GameObject, Type)
@@ -280,7 +280,7 @@
Improve this Doc
- View Source
+ View Source
GetField<U, T>(T, String)
@@ -377,7 +377,7 @@
Improve this Doc
- View Source
+ View Source
GetProperty<U, T>(T, String)
@@ -474,7 +474,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod<U, T>(T, String, Object[])
@@ -573,7 +573,7 @@
Improve this Doc
- View Source
+ View Source
SetField<T, U>(T, String, U)
@@ -660,7 +660,7 @@
Improve this Doc
- View Source
+ View Source
SetProperty<T, U>(T, String, U)
@@ -753,7 +753,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.UnityGame.Release.html b/api/IPA.Utilities.UnityGame.Release.html
index f3098536..29182f8a 100644
--- a/api/IPA.Utilities.UnityGame.Release.html
+++ b/api/IPA.Utilities.UnityGame.Release.html
@@ -142,7 +142,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.UnityGame.html b/api/IPA.Utilities.UnityGame.html
index 473c92db..95f73c50 100644
--- a/api/IPA.Utilities.UnityGame.html
+++ b/api/IPA.Utilities.UnityGame.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
GameVersion
@@ -161,7 +161,7 @@
Improve this Doc
- View Source
+ View Source
InstallPath
@@ -193,7 +193,7 @@
Improve this Doc
- View Source
+ View Source
LibraryPath
@@ -225,7 +225,7 @@
Improve this Doc
- View Source
+ View Source
NativeLibraryPath
@@ -257,7 +257,7 @@
Improve this Doc
- View Source
+ View Source
OnMainThread
@@ -289,7 +289,7 @@
Improve this Doc
- View Source
+ View Source
PluginsPath
@@ -321,7 +321,7 @@
Improve this Doc
- View Source
+ View Source
ReleaseType
@@ -356,7 +356,7 @@
Improve this Doc
- View Source
+ View Source
UserDataPath
@@ -394,7 +394,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Utils.ScopeGuardObject.html b/api/IPA.Utilities.Utils.ScopeGuardObject.html
index d1448fb9..555fe579 100644
--- a/api/IPA.Utilities.Utils.ScopeGuardObject.html
+++ b/api/IPA.Utilities.Utils.ScopeGuardObject.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
ScopeGuardObject(Action)
@@ -164,7 +164,7 @@
Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -209,7 +209,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/IPA.Utilities.Utils.html b/api/IPA.Utilities.Utils.html
index 5cb06381..e972dffd 100644
--- a/api/IPA.Utilities.Utils.html
+++ b/api/IPA.Utilities.Utils.html
@@ -129,7 +129,7 @@
Improve this Doc
- View Source
+ View Source
CanUseDateTimeNowSafely
@@ -163,7 +163,7 @@
Improve this Doc
- View Source
+ View Source
ByteArrayToString(Byte[])
@@ -213,7 +213,7 @@
Improve this Doc
- View Source
+ View Source
CopyAll(DirectoryInfo, DirectoryInfo, String, Func<Exception, FileInfo, Boolean>)
@@ -265,7 +265,7 @@
Improve this Doc
- View Source
+ View Source
CurrentTime()
@@ -297,7 +297,7 @@
Improve this Doc
- View Source
+ View Source
GetRelativePath(String, String)
@@ -353,7 +353,7 @@
Improve this Doc
- View Source
+ View Source
ScopeGuard(Action)
@@ -406,7 +406,7 @@
Improve this Doc
- View Source
+ View Source
StringToByteArray(String)
@@ -456,7 +456,7 @@
Improve this Doc
- View Source
+ View Source
UnsafeCompare(Byte[], Byte[])
@@ -512,7 +512,7 @@
Improve this Doc
- View Source
+ View Source
VersionCompareNoPrerelease(SemVer.Version, SemVer.Version)
@@ -574,7 +574,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/api/index.html b/api/index.html
index 833a62df..b1bcbee2 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 a12229e7..262f5594 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 54da6f66..19ad0134 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/dev-resources/description.html b/articles/dev-resources/description.html
index d95879e0..3ce79da7 100644
--- a/articles/dev-resources/description.html
+++ b/articles/dev-resources/description.html
@@ -91,7 +91,7 @@
diff --git a/articles/index.html b/articles/index.html
index b0fd3e96..ce357b59 100644
--- a/articles/index.html
+++ b/articles/index.html
@@ -94,7 +94,7 @@
diff --git a/articles/start-dev.html b/articles/start-dev.html
index bb6df6bf..e20a6c42 100644
--- a/articles/start-dev.html
+++ b/articles/start-dev.html
@@ -517,7 +517,7 @@ namespace Demo
diff --git a/articles/start-user.html b/articles/start-user.html
index e2d627d9..2bef33a1 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.html b/index.html
index 4f2d8ba3..eb644302 100644
--- a/index.html
+++ b/index.html
@@ -101,7 +101,7 @@
diff --git a/index.json b/index.json
index 8bfbbb75..618fe468 100644
--- a/index.json
+++ b/index.json
@@ -1,138 +1,143 @@
{
- "articles/start-dev.html": {
- "href": "articles/start-dev.html",
- "title": "Making your own mod",
- "keywords": "Making a mod Overview What follows is a very barebones, and frankly not very useful plugin class, even as a starting point, but it should be enough to give a decent idea of how to do quick upgrades of existing mods for those who want to. using System; using IPA; using IPA.Logging; namespace Demo { [Plugin(RuntimeOptions.SingleStartInit)] internal class Plugin { public static Logger log { get; private set; } [Init] public Plugin(Logger logger) { log = logger; log.Debug(\"Basic plugin running!\"); // setup that does not require game code // this is only called once ever, so do once-ever initialization } [OnStart] public void OnStart() { // setup that requires game code } [OnExit] public void OnExit() { // teardown } } } There are basically 4 major concepts here: Logger , the logging system. PluginAttribute , which declares that this class is a plugin and how it should behave. InitAttribute , which declares the constructor (and optionally other methods) as being used for initialization. The lifecycle event attributes OnStartAttribute and OnExitAttribute . I reccommend you read the docs for each of those to get an idea for what they do. It is worth noting that this example is of a mod that cannot be enabled and disabled at runtime, as marked by RuntimeOptions.SingleStartInit . What can be changed Before we go adding more functionality, its worth mentioning that that is not the only way to have a plugin set up. For starters, we can add another method marked [Init] , and it will be called after the constructor, with the same injected parameters, if those are applicable. [Init] public void Init(Logger logger) { // logger will be the same instance as log currently is } If you only had a method marked [Init] , and no constructors marked [Init] , then the plugin type must expose a public default constructor. If multiple constructors are marked [Init] , only the one with the most parameters will be called. You may also mark as many methods as you wish with [Init] and all of them will be called, in no well-defined order on initialization. The same is true for [OnStart] and [OnExit] , respectively. From Scratch If you are starting from scratch, you will need one other thing to get your plugin up and running: a manifest. A basic manifest for that might look a little like this: { \"author\": \"ExampleMan\", \"description\": [ \"A demo plugin written for the BSIPA basic tutorial.\" ], \"gameVersion\": \"1.6.0\", \"id\": null, \"name\": \"Demo Plugin\", \"version\": \"0.0.1\", \"features\": [ ], \"links\": { \"project-home\": \"https://example.com/demo-plugin\", \"project-source\": \"https://github.com/exampleman/demo-plugin/\", \"donate\": \"https://ko-fi.com/exampleman\" }, } There is a lot going on there, but most of it should be decently obvious. Among the things that aren't immediately obvious, are id : This represents a unique identifier for the mod, for use by package managers such as BeatMods. It may be null if the mod chooses not to support those. features : Don't worry about this for now, this is a not-very-simple thing that will be touched on later. In addition, there are a few gatchas with it: description : This can be either a string or an array representing different lines. Markdown formatting is permitted. gameVersion : This should match exactly with the application version of the game being targeted. While this is not enforced by BSIPA, mod repositories like BeatMods may require it match, and it is good practice regardless. version : This must be a valid SemVer version number for your mod. In order for your plugin to load, the manifest must be embedded into the plugin DLL as an embedded resource. This can be set in the Visual Studio file properties panel under Build Action , or in the .csproj like so:
At this point, if the main plugin source file and the manifest are in the same source location, and the plugin class is using the project's default namespace, the plugin will load just fine. However, this is somewhat difficult both to explain and verify, so I recommend you use the the misc.plugin-hint field in your manifest. It can be used like so: \"misc\": { \"plugin-hint\": \"Demo.Plugin\" } With this, you can set plugin-hint to the full typename of your plugin type, and it will correctly load. This is a hint though, and will also try it as a namespace if it fails to find the plugin type. If that fails, it will then fall back to using the manifest's embedded namespace. A less painful description If you want to have a relatively long or well-formatted description for your mod, it may start to become painful to embed it in a list of JSON strings in the manifest. Luckily, there is a way to handle this. The first step is to create another embedded file, but this time it should be a Markdown file, perhaps description.md . It may contain something like this: # Demo Plugin A little demo for the BSIPA modding introduction. --- WE CAN USE MARKDOWN!!! Then, in your manifest description, have the first line be something look like this, but replacing Demo.description.md with the fully namespaced name of the resource: \"#![Demo.description.md]\", Now, when loaded into memory, if anything reads your description metadata, they get the content of that file instead of the content of the manifest key. Configuring your plugin Something that many plugins want and need is configuration. Fortunately, BSIPA provides a fairly powerful configuration system out of the box. To start using it, first create a config class of some kind. Lets take a look at a fairly simple example of this: namespace Demo { public class PluginConfig { public static PluginConfig Instance { get; set; } public int IntValue { get; set; } = 42; public float FloatValue { get; set; } = 3.14159f; } } Notice how the class is both marked public and is not marked sealed . For the moment, both of these are necessary. Also notice that all of the members are properties. While this doesn't change much now, it will be significant in the near future. Now, how do we get this object off of disk? Simple. Back in your plugin class, change your [Init] constructor to look like this: [Init] public Plugin(Logger logger, Config conf) { log = logger; PluginConfig.Instance = conf.Generated(); log.Debug(\"Config loaded\"); // setup that does not require game code } For this to compile, though, we will need to add a few using s: using IPA.Config; using IPA.Config.Stores; With just this, you have your config automatically loading from disk! It's even reloaded when it gets changed mid-game! You can now access it from anywhere by simply accessing PluginConfig.Instance . Make sure you don't accidentally reassign this though, as then you will loose your only interaction with the user's preferences. By default, it will be named the same as is in your plugin's manifest's name field, and will use the built-in json provider. This means that the file that will be loaded from will be UserData/Demo Plugin.json for our demo plugin. You can, however, control both of those by applying attributes to the Config parameter, namely Config.NameAttribute to control the name, and Config.PreferAttribute to control the type. If the type preferences aren't registered though, it will just fall back to JSON. The config's behaviour can be found either later here, or in the remarks section of Generated(Config, Boolean) . At this point, your main plugin file should look something like this: using System; using IPA; using IPA.Logging; using IPA.Config; using IPA.Config.Stores; namespace Demo { [Plugin(RuntimeOptions.SingleStartInit)] internal class Plugin { public static Logger log { get; private set; } [Init] public Plugin(Logger logger, Config conf) { log = logger; PluginConfig.Instance = conf.Generated(); log.Debug(\"Config loaded\"); // setup that does not require game code } [OnStart] public void OnStart() { // setup that requires game code } [OnExit] public void OnExit() { // teardown } } } But what about more complex types than just int and float ? What if you want sub-objects? Those are supported natively, and so are very easy to set up. We just add this to the config class: public class SubThingsObject { public double DoubleValue { get; set; } = 2.718281828459045; } public SubThingsObject SubThings { get; set; } = new SubThingsObject(); Now this object will be automatically read from disk too. But there is one caveat to this: because SubThingsObject is a reference type, SubThings can be null . This is often undesireable. The obvious solution may be to simply change it to a struct , but that is both not supported and potentially undesirable for other reasons we'll get to later. Instead, you can use NonNullableAttribute . Change the definition of SubThings to this: [NonNullable] public SubThingsObject SubThings { get; set; } = new SubThingsObject(); And add this to the using s: using IPA.Config.Stores.Attributes; This attribute tells the serializer that null is an invalid value for the config object. This does, however, require that you take extra care ensure that it never becomes null in code, as that will break the serializer. What about collection types? Well, you can use those too, but you have to use something new: a converter. You may be familiar with them if you have used something like the popular Newtonsoft.Json library before. In BSIPA, they lie in the IPA.Config.Stores.Converters namespace. All converters either implement IValueConverter or derive from ValueConverter . You will mostly use them with an UseConverterAttribute . To use them, we'll want to import them: using System.Collections.Generic; using IPA.Config.Stores; using IPA.Config.Stores.Converters; Then add a field, for example a list field: [UseConverter(typeof(ListConverter))] public List ListValue { get; set; } = new List(); This uses a converter that is provided with BSIPA for List s specifically. It converts the list to an ordered array, which is then written to disk as a JSON array. We could also potentially want use something like a HashSet . Lets start by looking at the definition for such a member, then deciphering what exactly it means: [UseConverter(typeof(CollectionConverter>))] public HashSet SetValue { get; set; } = new HashSet(); The converter we're using here is CollectionConverter , a base type for converters of all kinds of collections. In fact, the ListConverter is derived from this, and uses it for most of its implementation. If a type implements ICollection , CollectionConverter can convert it. It, like most other BSIPA provided aggregate converters, provides a type argument overload CollectionConverter to compose other converters with it to handle unusual element types. Now after all that, your plugin class has not changed, and your config class should look something like this: using System.Collections.Generic; using IPA.Config.Stores; using IPA.Config.Stores.Attributes; using IPA.Config.Stores.Converters; namespace Demo { public class PluginConfig { public static PluginConfig Instance { get; set; } public class SubThingsObject { public double DoubleValue { get; set; } = 2.718281828459045; } public int IntValue { get; set; } = 42; public float FloatValue { get; set; } = 3.14159f; [NonNullable] public SubThingsObject SubThings { get; set; } = new SubThingsObject(); [UseConverter(typeof(ListConverter))] public List ListValue { get; set; } = new List(); [UseConverter(typeof(CollectionConverter>))] public HashSet SetValue { get; set; } = new HashSet(); } } I mentioned earlier that your config file will be automatically reloaded -- but isn't that a bad thing? Doesn't that mean that the config could change under your feet without you having a way to tell? Not so- I just haven't introduced the mechanism. Define a public or protected virtual method named OnReload : public virtual void OnReload() { // this is called whenever the config file is reloaded from disk // use it to tell all of your systems that something has changed // this is called off of the main thread, and is not safe to interact // with Unity in } This method will be called whenever BSIPA reloads your config from disk. When it is called, the object will already have been populated. Use it to notify all of your systems that configuration has changed. Now, we know how to read from disk, and how to use unusual types, but how do we write it back to disk? This config system is based on automatic saving (though we haven't quite gotten to the automatic part), and so the config is written to disk whenever the system recognizes that something has changed. To tell is as much, define a public or protected virtual method named Changed : public virtual void Changed() { // this is called whenever one of the virtual properties is changed // can be called to signal that the content has been changed } This method can be called to tell BSIPA that this config object has changed. Later, when we enable automated change tracking, this will also be called when one of the config's members changes. You can use this body to validate something or, for example, write a timestamp for last change. I just mentioned automated change tracking -- lets add that now. To do this, just make all of the properties virtual, like so: public class SubThingsObject { public virtual double DoubleValue { get; set; } = 2.718281828459045; } public virtual int IntValue { get; set; } = 42; public virtual float FloatValue { get; set; } = 3.14159f; [NonNullable] public virtual SubThingsObject SubThings { get; set; } = new SubThingsObject(); [UseConverter(typeof(ListConverter))] public virtual List ListValue { get; set; } = new List(); [UseConverter(typeof(CollectionConverter>))] public virtual HashSet SetValue { get; set; } = new HashSet(); Now, whenever you assign to any of those properties, your Changed method will be called, and the config object will be marked as changed and will be written to disk. Unfortunately, any properties that can be modified while only using the property getter do not trigger this, and so if you change any collections for example, you will have to manually call Changed . After doing all this, your config class should look something like this: using System.Collections.Generic; using IPA.Config.Stores; using IPA.Config.Stores.Attributes; using IPA.Config.Stores.Converters; namespace Demo { public class PluginConfig { public static PluginConfig Instance { get; set; } public class SubThingsObject { public virtual double DoubleValue { get; set; } = 2.718281828459045; } public virtual int IntValue { get; set; } = 42; public virtual float FloatValue { get; set; } = 3.14159f; [NonNullable] public virtual SubThingsObject SubThings { get; set; } = new SubThingsObject(); [UseConverter(typeof(ListConverter))] public virtual List ListValue { get; set; } = new List(); [UseConverter(typeof(CollectionConverter>))] public virtual HashSet SetValue { get; set; } = new HashSet(); public virtual void Changed() { // this is called whenever one of the virtual properties is changed // can be called to signal that the content has been changed } public virtual void OnReload() { // this is called whenever the config file is reloaded from disk // use it to tell all of your systems that something has changed // this is called off of the main thread, and is not safe to interact // with Unity in } } } There is one more major problem with this though: the main class is still public. Most configs shouldn't be. Lets make it internal. So we make it internal: internal class PluginConfig But to make it actually work, we add this outside the namespace declaration: using System.Runtime.CompilerServices; [assembly: InternalsVisibleTo(GeneratedStore.AssemblyVisibilityTarget)] And now our full file looks like this: using System.Collections.Generic; using System.Runtime.CompilerServices; using IPA.Config.Stores; using IPA.Config.Stores.Attributes; using IPA.Config.Stores.Converters; [assembly: InternalsVisibleTo(GeneratedStore.AssemblyVisibilityTarget)] namespace Demo { internal class PluginConfig { public static PluginConfig Instance { get; set; } public class SubThingsObject { public virtual double DoubleValue { get; set; } = 2.718281828459045; } public virtual int IntValue { get; set; } = 42; public virtual float FloatValue { get; set; } = 3.14159f; [NonNullable] public virtual SubThingsObject SubThings { get; set; } = new SubThingsObject(); [UseConverter(typeof(ListConverter))] public virtual List ListValue { get; set; } = new List(); [UseConverter(typeof(CollectionConverter>))] public virtual HashSet SetValue { get; set; } = new HashSet(); public virtual void Changed() { // this is called whenever one of the virtual properties is changed // can be called to signal that the content has been changed } public virtual void OnReload() { // this is called whenever the config file is reloaded from disk // use it to tell all of your systems that something has changed // this is called off of the main thread, and is not safe to interact // with Unity in } } }"
+ "api/IPA.Config.Stores.Attributes.NonNullableAttribute.html": {
+ "href": "api/IPA.Config.Stores.Attributes.NonNullableAttribute.html",
+ "title": "Class NonNullableAttribute",
+ "keywords": "Class NonNullableAttribute Indicates that a field or property in an object being wrapped by Generated(Config, Boolean) that would otherwise be nullable (i.e. a reference type or a Nullable type) should never be null, and the member will be ignored if the deserialized value is null . Inheritance Object Attribute NonNullableAttribute 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 NonNullableAttribute : Attribute, _Attribute 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[])"
},
- "articles/command-line.html": {
- "href": "articles/command-line.html",
- "title": "The Command Line",
- "keywords": "The Command Line BSIPA has 2 command lines: the installer, and the game. Their documentation is below. The Installer ( IPA.exe ) The Game The installer has quite a few options, which are documented inline with the -h or --help flag. This is what it currently looks like: usage: IPA.exe [FLAGS] [ARGUMENTS] flags: -h, --help prints this message -w, --waitfor=PID waits for the specified PID to exit -f, --force forces the operation to go through -r, --revert reverts the IPA installation -n, --nowait doesn't wait for user input after the operation -s, --start=ARGUMENTS uses the specified arguments to start the game after the patch/unpatch -l, --launch uses positional parameters as arguments to start the game after patch/unpatch -R, --no-revert prevents a normal installation from first reverting The game also gets quite a few command line options, though there isn't anything as convenient as a help page for them. Here's a quick list of what they are and what they do. --verbose Makes a console appear with log information at startup. --debug Enables the loading of debug information in Mono. The debugging information must be in the portable PDB format, in the same location as the DLL that it's for. This option also forces BSIPA to show all debug messages in the console, as well as where they were called. This overrides the config settings Debug.ShowDebug and Debug.ShowCallSource . --trace Enables trace level messages. By default, they do not ever enter the message queue, and thus cost almost nothing. When this or the config option is used, they are added and logged with the same rules as Debug messages. This overrides the config setting Debug.ShowTrace . --mono-debug Enables the built-in Mono soft debugger engine. By default, it acts as a client, and requires that there be a soft debugger server running on port 10000 on localhost . Implies --debug . --server Does nothing on its own. When paired with --mono-debug , this option makes the Mono soft debugger act in server mode. It begins listening on port 10000 on any address, and will pause startup (with no window) until a debugger is connected. I recommend using SDB, but that is a command line debugger and a lot of people don't care for those. --no-yeet Disables mod yeeting. By default, whenever BSIPA detects that the game is now running a newer version than previous runs, it will move all mods to another folder and not load them. (They still get checked for updates though.) When this is enabled, that behaviour is disabled. Overrides the config setting YeetMods . --condense-logs Reduces the number of log files BSIPA will output for a given session. By default, BSIPA will create a subfolder in the Logs folder for each mod sublog, as well as each mod. This disables that behaviour, and restricts it to only create a global log and mod logs. Overrides the config setting Debug.CondenseModLogs . --no-updates Disables automatic updating. By default, BSIPA will check BeatMods for all of the loaded mods to see if there is a new version avaliable. If there is, it will be downloaded and installed on the next run. This flag disables that behaviour. Overrides the config settings Updates.AutoCheckUpdates and Updates.AutoUpdate ."
+ "api/IPA.Config.IModPrefs.html": {
+ "href": "api/IPA.Config.IModPrefs.html",
+ "title": "Interface IModPrefs",
+ "keywords": "Interface IModPrefs Allows to get and set preferences for your mod. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [Obsolete(\"Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.\")] public interface IModPrefs Methods | Improve this Doc View Source GetBool(String, String, Boolean, Boolean) Gets a bool from the ini. Declaration bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Boolean | Improve this Doc View Source GetFloat(String, String, Single, Boolean) Gets a float from the ini. Declaration float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Single defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Single | Improve this Doc View Source GetInt(String, String, Int32, Boolean) Gets an int from the ini. Declaration int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Int32 | Improve this Doc View Source GetString(String, String, String, Boolean) Gets a string from the ini. Declaration string GetString(string section, string name, string defaultValue = \"\", bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. String defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description String | Improve this Doc View Source HasKey(String, String) Checks whether or not a key exists in the ini. Declaration bool HasKey(string section, string name) Parameters Type Name Description String section Section of the key. String name Name of the key. Returns Type Description Boolean | Improve this Doc View Source SetBool(String, String, Boolean) Sets a bool in the ini. Declaration void SetBool(string section, string name, bool value) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean value Value that should be written. | Improve this Doc View Source SetFloat(String, String, Single) Sets a float in the ini. Declaration void SetFloat(string section, string name, float value) Parameters Type Name Description String section Section of the key. String name Name of the key. Single value Value that should be written. | Improve this Doc View Source SetInt(String, String, Int32) Sets an int in the ini. Declaration void SetInt(string section, string name, int value) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 value Value that should be written. | Improve this Doc View Source SetString(String, String, String) Sets a string in the ini. Declaration void SetString(string section, string name, string value) Parameters Type Name Description String section Section of the key. String name Name of the key. String value Value that should be written. 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[])"
},
- "other_api/config/schema.html": {
- "href": "other_api/config/schema.html",
- "title": "Configuration File Schema",
- "keywords": "Configuration File Schema { \"definitions\": { \"Debug_\": { \"type\": \"object\", \"properties\": { \"ShowCallSource\": { \"type\": \"boolean\" }, \"ShowDebug\": { \"type\": \"boolean\" }, \"CondenseModLogs\": { \"type\": \"boolean\" }, \"ShowHandledErrorStackTraces\": { \"type\": \"boolean\" }, \"HideMessagesForPerformance\": { \"type\": \"boolean\" }, \"HideLogThreshold\": { \"type\": \"integer\" }, \"ShowTrace\": { \"type\": \"boolean\" }, \"SyncLogging\": { \"type\": \"boolean\" } }, \"required\": [ \"ShowCallSource\", \"ShowDebug\", \"CondenseModLogs\", \"ShowHandledErrorStackTraces\", \"HideMessagesForPerformance\", \"HideLogThreshold\", \"ShowTrace\", \"SyncLogging\" ] }, \"Updates_\": { \"type\": \"object\", \"properties\": { \"AutoUpdate\": { \"type\": \"boolean\" }, \"AutoCheckUpdates\": { \"type\": \"boolean\" } }, \"required\": [ \"AutoUpdate\", \"AutoCheckUpdates\" ] } }, \"type\": \"object\", \"properties\": { \"Regenerate\": { \"type\": \"boolean\" }, \"Updates\": { \"$ref\": \"#/definitions/Updates_\" }, \"Debug\": { \"$ref\": \"#/definitions/Debug_\" }, \"YeetMods\": { \"type\": \"boolean\" }, \"GameAssemblies\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"LastGameVersion\": { \"type\": \"string\" } }, \"required\": [ \"Regenerate\", \"Updates\", \"Debug\", \"YeetMods\", \"GameAssemblies\" ] }"
+ "api/IPA.Config.IConfigStore.html": {
+ "href": "api/IPA.Config.IConfigStore.html",
+ "title": "Interface IConfigStore",
+ "keywords": "Interface IConfigStore A storage for a config structure. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public interface IConfigStore Properties | Improve this Doc View Source SyncObject A synchronization object for the save thread to wait on for changes. It should be signaled whenever the internal state of the object is changed. The writer will never signal this handle. Declaration WaitHandle SyncObject { get; } Property Value Type Description WaitHandle | Improve this Doc View Source WriteSyncObject A synchronization object for the load thread and accessors to maintain safe synchronization. Any readers should take a read lock with EnterReadLock() or EnterUpgradeableReadLock() , and any writers should take a write lock with EnterWriteLock() . Declaration ReaderWriterLockSlim WriteSyncObject { get; } Property Value Type Description ReaderWriterLockSlim Remarks Read and write are read and write to this object , not to the file on disk. Methods | Improve this Doc View Source ReadFrom(ConfigProvider) Reads the config structure from the given IConfigProvider into the current IConfigStore . Declaration void ReadFrom(ConfigProvider provider) Parameters Type Name Description ConfigProvider provider the provider to read from Remarks The calling code will have entered a write lock on WriteSyncObject when this is called. | Improve this Doc View Source WriteTo(ConfigProvider) Writes the config structure stored by the current IConfigStore to the given IConfigProvider . Declaration void WriteTo(ConfigProvider provider) Parameters Type Name Description ConfigProvider provider the provider to write to Remarks The calling code will have entered a read lock on WriteSyncObject when this is called. 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[])"
},
- "articles/dev-resources/description.html": {
- "href": "articles/dev-resources/description.html",
- "title": "Demo Plugin",
- "keywords": "Demo Plugin A little demo for the BSIPA modding introduction. WE CAN USE MARKDOWN!!!"
+ "api/IPA.Config.Data.List.html": {
+ "href": "api/IPA.Config.Data.List.html",
+ "title": "Class List",
+ "keywords": "Class List A list of Value s for serialization by an IConfigProvider . Use List() or From(IEnumerable) to create. Inheritance Object Value List Implements IList < Value > ICollection < Value > IEnumerable < 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 List : Value, IList, ICollection, IEnumerable, IEnumerable Properties | Improve this Doc View Source Count Gets the number of elements in the List . Declaration public int Count { get; } Property Value Type Description Int32 See Also Count | Improve this Doc View Source Item[Int32] Gets the value at the given index in this List . Declaration public Value this[int index] { get; set; } Parameters Type Name Description Int32 index the index to retrieve the Value at Property Value Type Description Value the Value at index See Also Item [ Int32 ] Methods | Improve this Doc View Source Add(Value) Adds a Value to the end of this List . Declaration public void Add(Value item) Parameters Type Name Description Value item the Value to add See Also Add (T) | Improve this Doc View Source AddRange(IEnumerable) Adds a range of Value s to the end of this List . Declaration public void AddRange(IEnumerable vals) Parameters Type Name Description IEnumerable < Value > vals the range of Value s to add | Improve this Doc View Source Clear() Clears the List . Declaration public void Clear() See Also Clear () | Improve this Doc View Source Contains(Value) Checks if the List contains a certian item. Declaration public bool Contains(Value item) Parameters Type Name Description Value item the Value to check for Returns Type Description Boolean true if the item was founc, otherwise false See Also Contains (T) | Improve this Doc View Source CopyTo(Value[], Int32) Copies the Value s in the List to the Array in array . Declaration public void CopyTo(Value[] array, int arrayIndex) Parameters Type Name Description Value [] array the Array to copy to Int32 arrayIndex the starting index to copy to See Also CopyTo (T[], Int32 ) | Improve this Doc View Source GetEnumerator() Gets an enumerator to enumerate the List . Declaration public IEnumerator GetEnumerator() Returns Type Description IEnumerator < Value > an IEnumerator for this List See Also GetEnumerator () | Improve this Doc View Source IndexOf(Value) Gets the index that a given Value is in the List . Declaration public int IndexOf(Value item) Parameters Type Name Description Value item the Value to search for Returns Type Description Int32 the index that the item was at, or -1. See Also IndexOf (T) | Improve this Doc View Source Insert(Int32, Value) Inserts a Value at an index. Declaration public void Insert(int index, Value item) Parameters Type Name Description Int32 index the index to insert at Value item the Value to insert See Also Insert ( Int32 , T) | Improve this Doc View Source Remove(Value) Removes a Value from the List . Declaration public bool Remove(Value item) Parameters Type Name Description Value item the Value to remove Returns Type Description Boolean true if the item was removed, false otherwise See Also Remove (T) | Improve this Doc View Source RemoveAt(Int32) Removes a Value at an index. Declaration public void RemoveAt(int index) Parameters Type Name Description Int32 index the index to remove a Value at See Also RemoveAt ( Int32 ) | Improve this Doc View Source ToString() Converts this Value into a human-readable format. Declaration public override string ToString() Returns Type Description String a comma-seperated list of the result of ToString() wrapped in square brackets Overrides Value.ToString() Explicit Interface Implementations | Improve this Doc View Source ICollection.IsReadOnly Declaration bool ICollection.IsReadOnly { get; } Returns Type Description Boolean | Improve this Doc View Source IEnumerable.GetEnumerator() Declaration IEnumerator IEnumerable.GetEnumerator() Returns Type Description IEnumerator Implements System.Collections.Generic.IList System.Collections.Generic.ICollection System.Collections.Generic.IEnumerable System.Collections.IEnumerable Extension Methods EnumerableExtensions.Prepend(IEnumerable, T) EnumerableExtensions.Append(IEnumerable, T) EnumerableExtensions.NonNull(IEnumerable) 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.Stores.GeneratedStore.html": {
- "href": "api/IPA.Config.Stores.GeneratedStore.html",
- "title": "Class GeneratedStore",
- "keywords": "Class GeneratedStore A class providing an extension for Config to make it easy to use generated config stores. Inheritance Object GeneratedStore Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores Assembly : IPA.Loader.dll Syntax public static class GeneratedStore Fields | Improve this Doc View Source AssemblyVisibilityTarget The name of the assembly that internals must be visible to to allow internal protection. Declaration public const string AssemblyVisibilityTarget = \"IPA.Config.Generated\" Field Value Type Description String Methods | Improve this Doc View Source Create() Creates a generated store outside of the context of the config system. Declaration public static T Create() where T : class Returns Type Description T a generated instance of T implementing functionality described by Generated(Config, Boolean) Type Parameters Name Description T the type to wrap Remarks See Generated(Config, Boolean) for more information about how it behaves. See Also Generated(Config, Boolean) | Improve this Doc View Source Generated(Config, Boolean) Creates a generated IConfigStore of type T , registers it to the Config object, and returns it. This also forces a synchronous config load via LoadSync() if loadSync is true . Declaration public static T Generated(this Config cfg, bool loadSync = true) where T : class Parameters Type Name Description Config cfg the Config to register to Boolean loadSync whether to synchronously load the content, or trigger an async load Returns Type Description T a generated instance of T as a special IConfigStore Type Parameters Name Description T the type to wrap Remarks T must be a public non- sealed class. It can also be internal, but in that case, then your assembly must have the following attribute to allow the generated code to reference it. [assembly: InternalsVisibleTo(IPA.Config.Stores.GeneratedStore.AssemblyVisibilityTarget)] Only fields and properties that are public or protected will be considered, and only properties where both the getter and setter are public or protected are considered. Any fields or properties with an IgnoreAttribute applied to them are also ignored. Having properties be virtual is not strictly necessary, however it allows the generated type to keep track of changes and lock around them so that the config will auto-save. All of the attributes in the IPA.Config.Stores.Attributes namespace are handled as described by them. If the T declares a public or protected, virtual method Changed() , then that method may be called to artificially signal to the runtime that the content of the object has changed. That method will also be called after the write locks are released when a property is set anywhere in the owning tree. This will only be called on the outermost generated object of the config structure, even if the change being signaled is somewhere deep into the tree. Similarly, T can declare a public or protected, virtual method OnReload() , which will be called on the filesystem reader thread after the object has been repopulated with new data values. It will be called after the write lock for this object is released. This will only be called on the outermost generated object of the config structure. Similarly, T can declare a public or protected, virtual method CopyFrom(ConfigType) (the first parameter is the type it is defined on), which may be called to copy the properties from another object of its type easily, and more importantly, as only one change. Its body will be executed after the values have been copied. Similarly, T can declare a public or protected, virtual method ChangeTransaction() returning IDisposable , which may be called to get an object representing a transactional change. This may be used to change a lot of properties at once without triggering a save multiple times. Ideally, this is used in a langword_csharp_using block or declaration. The IDisposable returned from your implementation will have its Dispose() called after Changed() is called, but before the write lock is released. Unless you have a very good reason to use the nested IDisposable , avoid it. If T is marked with NotifyPropertyChangesAttribute , the resulting object will implement INotifyPropertyChanged . Similarly, if T implements INotifyPropertyChanged , the resulting object will implement it and notify it too."
+ "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.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.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.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.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.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) 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[]) See Also ListConverter "
+ "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.Config.Stores.Converters.ListConverter-1.html": {
- "href": "api/IPA.Config.Stores.Converters.ListConverter-1.html",
- "title": "Class ListConverter",
- "keywords": "Class ListConverter A CollectionConverter for a List . Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter