From 3f97d81ef185bade4e8b5bac7f87d00bc4a27077 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()
@@ -406,7 +406,7 @@ public class MarkdownView : MonoBehaviour
Improve this Doc
- View Source
+ View Source
HasEmbeddedImage
Markdown
@@ -474,7 +474,7 @@ public class MarkdownView : MonoBehaviour
Improve this Doc
- View Source
+ View Source
rectTransform
@@ -511,6 +511,9 @@ public class MarkdownView : MonoBehaviour
+
@@ -546,7 +549,7 @@ public class MarkdownView : MonoBehaviour
Improve this Doc
NameAttribute(String)
@@ -287,7 +287,7 @@ public sealed class NameAttribute : Attribute, _Attribute
Improve this Doc
- View Source
+ View Source
Name
@@ -328,6 +328,9 @@ public sealed class NameAttribute : Attribute, _Attribute
+
@@ -357,7 +360,7 @@ public sealed class NameAttribute : Attribute, _Attribute
Improve this Doc
PreferAttribute(String[])
@@ -288,7 +288,7 @@ public sealed class PreferAttribute : Attribute, _Attribute
Improve this Doc
- View Source
+ View Source
PreferenceOrder
@@ -329,6 +329,9 @@ public sealed class PreferAttribute : Attribute, _Attribute
+
@@ -358,7 +361,7 @@ public sealed class PreferAttribute : Attribute, _Attribute
Improve this Doc
Name
@@ -159,7 +159,7 @@
Improve this Doc
- View Source
+ View Source
Provider
@@ -192,7 +192,7 @@
Improve this Doc
- View Source
+ View Source
GetConfigFor(String, String[])
@@ -248,7 +248,7 @@
Improve this Doc
- View Source
+ View Source
LoadAsync()
@@ -279,7 +279,7 @@
Improve this Doc
- View Source
+ View Source
LoadSync()
@@ -295,7 +295,7 @@
Improve this Doc
- View Source
+ View Source
Register(Type)
@@ -329,7 +329,7 @@
Improve this Doc
- View Source
+ View Source
Register<T>()
@@ -362,7 +362,7 @@
Improve this Doc
- View Source
+ View Source
SetStore(IConfigStore)
@@ -417,6 +417,9 @@
+
@@ -449,7 +452,7 @@
Improve this Doc
Load()
@@ -161,7 +161,7 @@ and returns it.
parent
.<
Improve this Doc
- View Source
+ View Source
parent
Improve this Doc
- View Source
+ View Source
ToValue(TCollection, Object)
@@ -504,6 +504,9 @@ with the parent parent
+
@@ -533,7 +536,7 @@ with the parent parent
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html
index eb7e0b31..919f11ed 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CollectionConverter-3.html
@@ -190,7 +190,7 @@
Improve this Doc
- View Source
+ View Source
CollectionConverter()
@@ -221,6 +221,9 @@ with a default-constructed ReflectionUtil.GetField<T>(Object, String)
+
@@ -254,7 +257,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html
index 67633fd5..e8538db6 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter-1.html
@@ -144,7 +144,7 @@
Improve this Doc
- View Source
+ View Source
Default
@@ -181,7 +181,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html
index d7546845..a4d7fff5 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.Converter.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
FloatValue(Value)
@@ -179,7 +179,7 @@ or null if Improve this Doc
- View Source
+ View Source
IntValue(Value)
@@ -236,7 +236,7 @@ or null if Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html
index 2f2cd1fb..56ded72b 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html
@@ -158,7 +158,7 @@
Improve this Doc
- View Source
+ View Source
Deserialize(Value, Object)
@@ -218,7 +218,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -280,7 +280,7 @@
Improve this Doc
- View Source
+ View Source
Serialize(T, Object)
@@ -340,7 +340,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -411,6 +411,9 @@
+
@@ -444,7 +447,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html
index 1e6ec0fa..c59f2f39 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-1.html
@@ -181,7 +181,7 @@
Improve this Doc
- View Source
+ View Source
IListConverter()
@@ -201,7 +201,7 @@
Improve this Doc
- View Source
+ View Source
IListConverter(ValueConverter<T>)
@@ -237,7 +237,7 @@
Improve this Doc
- View Source
+ View Source
Create(Int32, Object)
@@ -304,6 +304,9 @@
+
@@ -337,7 +340,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html
index da459255..220a219a 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.IListConverter-2.html
@@ -189,7 +189,7 @@
Improve this Doc
- View Source
+ View Source
IListConverter()
@@ -220,6 +220,9 @@ with a default-constructed ReflectionUtil.GetField<T>(Object, String)
+
@@ -253,7 +256,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html
index 3a0afa46..cb7febcb 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-1.html
@@ -181,7 +181,7 @@
Improve this Doc
- View Source
+ View Source
ISetConverter()
@@ -201,7 +201,7 @@
Improve this Doc
- View Source
+ View Source
ISetConverter(ValueConverter<T>)
@@ -237,7 +237,7 @@
Improve this Doc
- View Source
+ View Source
Create(Int32, Object)
@@ -304,6 +304,9 @@
+
@@ -337,7 +340,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html
index 1c7c836c..3e7fe551 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ISetConverter-2.html
@@ -189,7 +189,7 @@
Improve this Doc
- View Source
+ View Source
ISetConverter()
@@ -220,6 +220,9 @@ with a default-constructed ReflectionUtil.GetField<T>(Object, String)
+
@@ -253,7 +256,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html
index 3e787f51..3b4dc8d6 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-1.html
@@ -181,7 +181,7 @@
Improve this Doc
- View Source
+ View Source
ListConverter()
@@ -201,7 +201,7 @@
Improve this Doc
- View Source
+ View Source
ListConverter(ValueConverter<T>)
@@ -237,7 +237,7 @@
Improve this Doc
- View Source
+ View Source
Create(Int32, Object)
@@ -304,6 +304,9 @@
+
@@ -337,7 +340,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html
index 26f42f6d..e75c3bc9 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.ListConverter-2.html
@@ -189,7 +189,7 @@
Improve this Doc
- View Source
+ View Source
ListConverter()
@@ -220,6 +220,9 @@ with a default-constructed ReflectionUtil.GetField<T>(Object, String)
+
@@ -253,7 +256,7 @@ with a default-constructed Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html
index f70d7a95..9843fbc0 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-1.html
@@ -159,7 +159,7 @@
Improve this Doc
- View Source
+ View Source
NullableConverter()
@@ -182,7 +182,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
NullableConverter(ValueConverter<T>)
@@ -218,7 +218,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -276,7 +276,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
ToValue(Nullable<T>, Object)
@@ -343,6 +343,9 @@ Equivalent to
+
@@ -372,7 +375,7 @@ Equivalent to
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html
index 5a2603e2..3d575c80 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Converters.NullableConverter-2.html
@@ -171,7 +171,7 @@ to use as the underlying converter. Use this in the Improve this Doc
- View Source
+ View Source
NullableConverter()
@@ -200,6 +200,9 @@ to use as the underlying converter. Use this in the ReflectionUtil.GetField<T>(Object, String)
+
@@ -233,7 +236,7 @@ to use as the underlying converter. Use this in the Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html b/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html
index 233b40df..f55c1977 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.GeneratedExtension.html
@@ -129,7 +129,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.
@@ -161,7 +161,7 @@ config stores.
Improve this Doc
- View Source
+ View Source
Generated<T>(Config, Boolean)
@@ -275,7 +275,7 @@ TODO: describe details of generated stores
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html b/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html
index 1ab85789..3630894c 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.IValueConverter.html
@@ -116,7 +116,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
Type
@@ -149,7 +149,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -205,7 +205,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
ToValue(Object, Object)
@@ -266,6 +266,9 @@ Converters do not need to perform null checks, as the serializer and de
+
@@ -295,7 +298,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html b/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html
index ceaf07e7..c68b6548 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.ValueConverter-1.html
@@ -152,7 +152,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -212,7 +212,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(T, Object)
@@ -274,7 +274,7 @@
Improve this Doc
- View Source
+ View Source
IValueConverter.FromValue(Value, Object)
@@ -326,7 +326,7 @@
Improve this Doc
- View Source
+ View Source
IValueConverter.ToValue(Object, Object)
@@ -378,7 +378,7 @@
Improve this Doc
- View Source
+ View Source
IValueConverter.Type
@@ -417,6 +417,9 @@
+
@@ -450,7 +453,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.IDisablablePlugin.html b/branch/4.0.0-beta/api/IPA.IDisablablePlugin.html
index 7e2a69c4..ebd8e408 100644
--- a/branch/4.0.0-beta/api/IPA.IDisablablePlugin.html
+++ b/branch/4.0.0-beta/api/IPA.IDisablablePlugin.html
@@ -118,7 +118,7 @@ public interface IDisablablePlugin : IPlugin
Improve this Doc
- View Source
+ View Source
OnDisable()
@@ -144,6 +144,9 @@ plugin is disabled at runtime.
+
@@ -173,7 +176,7 @@ plugin is disabled at runtime.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.IEnhancedPlugin.html b/branch/4.0.0-beta/api/IPA.IEnhancedPlugin.html
index 0f5f235c..07137fc1 100644
--- a/branch/4.0.0-beta/api/IPA.IEnhancedPlugin.html
+++ b/branch/4.0.0-beta/api/IPA.IEnhancedPlugin.html
@@ -118,7 +118,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
OnFixedUpdate()
@@ -134,7 +134,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
OnLateUpdate()
@@ -150,7 +150,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
OnUpdate()
@@ -171,6 +171,9 @@ public interface IEnhancedPlugin : IPlugin
+
@@ -200,7 +203,7 @@ public interface IEnhancedPlugin : IPlugin
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.IPlugin.html b/branch/4.0.0-beta/api/IPA.IPlugin.html
index a0fe7ce5..0c6309a0 100644
--- a/branch/4.0.0-beta/api/IPA.IPlugin.html
+++ b/branch/4.0.0-beta/api/IPA.IPlugin.html
@@ -105,7 +105,7 @@ with the "no-runtime-enable" feature.
Improve this Doc
- View Source
+ View Source
OnActiveSceneChanged(Scene, Scene)
@@ -145,7 +145,7 @@ with the "no-runtime-enable" feature.
Improve this Doc
- View Source
+ View Source
OnApplicationQuit()
@@ -161,7 +161,7 @@ with the "no-runtime-enable" feature.
Improve this Doc
- View Source
+ View Source
OnEnable()
@@ -182,7 +182,7 @@ When a plugin is disabled at startup, neither this nor Init will be called until
Improve this Doc
- View Source
+ View Source
OnSceneLoaded(Scene, LoadSceneMode)
@@ -222,7 +222,7 @@ When a plugin is disabled at startup, neither this nor Init will be called until
Improve this Doc
- View Source
+ View Source
OnSceneUnloaded(Scene)
@@ -261,6 +261,9 @@ When a plugin is disabled at startup, neither this nor Init will be called until
+
@@ -290,7 +293,7 @@ When a plugin is disabled at startup, neither this nor Init will be called until
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.InitAttribute.html b/branch/4.0.0-beta/api/IPA.InitAttribute.html
index 4db4a73f..7acdaaa6 100644
--- a/branch/4.0.0-beta/api/IPA.InitAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.InitAttribute.html
@@ -257,6 +257,9 @@ public sealed class InitAttribute : Attribute, _Attribute
+
@@ -286,7 +289,7 @@ public sealed class InitAttribute : Attribute, _Attribute
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html b/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html
index 97d6cc99..0a30571f 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.Features.Feature.html
@@ -131,7 +131,7 @@
Improve this Doc
- View Source
+ View Source
InvalidMessage
@@ -164,7 +164,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
StoreOnPlugin
@@ -198,7 +198,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
AfterInit(PluginLoader.PluginInfo)
@@ -232,7 +232,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
AfterInit(PluginLoader.PluginInfo, IPlugin)
@@ -272,7 +272,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
BeforeInit(PluginLoader.PluginInfo)
@@ -322,7 +322,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
BeforeLoad(PluginLoader.PluginMetadata)
@@ -376,7 +376,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
Evaluate()
@@ -409,7 +409,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
Initialize(PluginLoader.PluginMetadata, String[])
@@ -470,7 +470,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
RequireLoaded(PluginLoader.PluginMetadata)
@@ -509,6 +509,9 @@ Any features it defines, for example, will still be loaded.
+
@@ -538,7 +541,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html
index 69162db8..cc61119d 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.InjectParameter.html
@@ -148,6 +148,9 @@
+
@@ -177,7 +180,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
index 2a99bec7..78c6b076 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
AddInjector(Type, PluginInitInjector.InjectParameter)
@@ -174,7 +174,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginInfo.html b/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginInfo.html
index 48460067..adfa8dcd 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginInfo.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginInfo.html
@@ -129,7 +129,7 @@ public class PluginInfo
Improve this Doc
- View Source
+ View Source
Metadata
@@ -166,6 +166,9 @@ public class PluginInfo
+
@@ -195,7 +198,7 @@ public class PluginInfo
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginMetadata.html b/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginMetadata.html
index 56e1f592..fff17a8a 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginMetadata.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.PluginMetadata.html
@@ -125,7 +125,7 @@
Improve this Doc
- View Source
+ View Source
Assembly
@@ -157,7 +157,7 @@
Improve this Doc
- View Source
+ View Source
Features
@@ -189,7 +189,7 @@
Improve this Doc
- View Source
+ View Source
File
@@ -221,7 +221,7 @@
Improve this Doc
- View Source
+ View Source
Id
@@ -253,7 +253,7 @@
Improve this Doc
- View Source
+ View Source
IsAttributePlugin
@@ -283,7 +283,7 @@
Improve this Doc
- View Source
+ View Source
IsBare
@@ -315,7 +315,7 @@
Improve this Doc
- View Source
+ View Source
Name
@@ -347,7 +347,7 @@
Improve this Doc
- View Source
+ View Source
PluginType
@@ -379,7 +379,7 @@
Improve this Doc
- View Source
+ View Source
RuntimeOptions
@@ -409,7 +409,7 @@
Improve this Doc
- View Source
+ View Source
Version
@@ -443,7 +443,7 @@
Improve this Doc
- View Source
+ View Source
ToString()
@@ -482,6 +482,9 @@
+
@@ -511,7 +514,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.html b/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.html
index 9b716c97..a4935e48 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginLoader.html
@@ -131,6 +131,9 @@
+
@@ -160,7 +163,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html
index 91001a83..4756221f 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginDisableDelegate.html
@@ -126,6 +126,9 @@
+
@@ -155,7 +158,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html
index 5709f0fd..6faa5156 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.PluginEnableDelegate.html
@@ -126,6 +126,9 @@
+
@@ -155,7 +158,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html
index 0dbc82f2..1dbfcc95 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginManager.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
AllPlugins
@@ -160,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
DisabledPlugins
@@ -192,7 +192,7 @@
Improve this Doc
- View Source
+ View Source
Plugins
@@ -227,7 +227,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
DisablePlugin(PluginLoader.PluginInfo)
@@ -277,7 +277,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
Called whenever a plugin is disabled.
@@ -860,7 +860,7 @@ public static PluginLoader.PluginInfo GetPluginFromModSaberName(string name)Improve this Doc - View Source + View SourceCalled whenever a plugin is enabled.
@@ -896,7 +896,7 @@ public static PluginLoader.PluginInfo GetPluginFromModSaberName(string name)Improve this DocLog(Level.Critical, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Critical, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Debug, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Debug, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Error, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Error, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Info, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Info, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Info, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Info, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Notice, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Notice, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Trace, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Trace, message);
Improve this Doc
- View Source
+ View Source
Log(Level.Warning, e);
Improve this Doc
- View Source
+ View Source
Log(Level.Warning, message);
+
@@ -826,7 +829,7 @@ Equivalent to Log(Level.Warning, message);
Improve this Doc
The StreamWriter that writes to the GZip file.
@@ -175,7 +175,7 @@ Improve this Doc - View Source + View SourceImprove this Doc
- View Source
+ View Source
SemverValue
@@ -309,7 +309,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
StorageMode
@@ -341,7 +341,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
StringValue
@@ -375,7 +375,7 @@ the storage mode specified in Improve this Doc
- View Source
+ View Source
CompareTo(AlmostVersion)
@@ -433,7 +433,7 @@ or Improve this Doc
- View Source
+ View Source
CompareTo(SemVer.Version)
@@ -491,7 +491,7 @@ be thrown.
Improve this Doc
- View Source
+ View Source
Equals(Object)
@@ -550,7 +550,7 @@ be thrown.
Improve this Doc
- View Source
+ View Source
GetHashCode()
@@ -588,7 +588,7 @@ be thrown.
Improve this Doc
- View Source
+ View Source
ToString()
@@ -629,7 +629,7 @@ stored as a , it is equivalent to calling Improve this Doc
- View Source
+ View Source
Equality(AlmostVersion, AlmostVersion)
@@ -694,7 +694,7 @@ does not.
Improve this Doc
- View Source
+ View Source
Implicit(AlmostVersion to SemVer.Version)
@@ -748,7 +748,7 @@ If not applicable, returns null
Improve this Doc
- View Source
+ View Source
Implicit(SemVer.Version to AlmostVersion)
@@ -801,7 +801,7 @@ If not applicable, returns null
Improve this Doc
- View Source
+ View Source
Inequality(AlmostVersion, AlmostVersion)
@@ -873,6 +873,9 @@ If not applicable, returns null
+
@@ -902,7 +905,7 @@ If not applicable, returns null
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html
index d979d0c6..fa7d5ccc 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.AlmostVersionConverter.html
@@ -142,7 +142,7 @@
Improve this Doc
- View Source
+ View Source
FromValue(Value, Object)
@@ -199,7 +199,7 @@
Improve this Doc
- View Source
+ View Source
ToValue(AlmostVersion, Object)
@@ -266,6 +266,9 @@
+
@@ -295,7 +298,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html
index f89d2072..60061031 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.SingleThreadTaskScheduler.html
@@ -157,7 +157,7 @@
Improve this Doc
- View Source
+ View Source
IsRunning
@@ -206,7 +206,7 @@
Improve this Doc
- View Source
+ View Source
Dispose()
@@ -222,7 +222,7 @@
Improve this Doc
- View Source
+ View Source
Dispose(Boolean)
@@ -256,7 +256,7 @@
Improve this Doc
- View Source
+ View Source
Exit()
@@ -307,7 +307,7 @@
Improve this Doc
- View Source
+ View Source
GetScheduledTasks()
@@ -357,7 +357,7 @@
Improve this Doc
- View Source
+ View Source
Join()
@@ -392,7 +392,7 @@
Improve this Doc
- View Source
+ View Source
QueueTask(Task)
@@ -445,7 +445,7 @@ scheduled for this Improve this Doc
- View Source
+ View Source
Start()
@@ -477,7 +477,7 @@ scheduled for this Improve this Doc
- View Source
+ View Source
TryExecuteTaskInline(Task, Boolean)
@@ -563,6 +563,9 @@ make sense to run it inline.
+
@@ -592,7 +595,7 @@ make sense to run it inline.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html
index a3e213f5..b3e32923 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.MutexLocker.html
@@ -125,7 +125,7 @@ Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -143,18 +143,33 @@ Create this with ReflectionUtil.SetField(Object, String, Object)
+
+
+
+
+
See Also
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html
index f1b228cc..8e219ad3 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html
@@ -125,7 +125,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -143,18 +143,33 @@ it is disposed. Create this with ReflectionUtil.SetField(Object, String, Object)
+
+
+
+
+
See Also
@@ -171,7 +186,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
index 170fff41..7b44ab7f 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html
@@ -125,7 +125,7 @@ when it is disposed. Create this with Improve this Doc
- View Source
+ View Source
Upgrade()
@@ -164,7 +164,7 @@ upgrading the current thread's lock.
Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -182,18 +182,33 @@ upgrading the current thread's lock.
+
+
+
+
+
See Also
@@ -210,7 +225,7 @@ upgrading the current thread's lock.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
index 20cc4c9e..a924947d 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
@@ -125,7 +125,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -143,18 +143,33 @@ it is disposed. Create this with ReflectionUtil.SetField(Object, String, Object)
+
+
+
+
+
See Also
@@ -171,7 +186,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html
index fedd5ef6..a91adffa 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html
@@ -125,7 +125,7 @@ Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -143,18 +143,33 @@ Create this with ReflectionUtil.SetField(Object, String, Object)
+
+
+
+
+
See Also
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
index f13c82d6..be48b9b4 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html
@@ -125,7 +125,7 @@ when it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -143,18 +143,33 @@ when it is disposed. Create this with ReflectionUtil.SetField(Object, String, Object)
+
+
+
+
+
See Also
@@ -171,7 +186,7 @@ when it is disposed. Create this with Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html
index 93219849..d2370901 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html
@@ -125,7 +125,7 @@ Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -143,18 +143,33 @@ Create this with ReflectionUtil.SetField(Object, String, Object)
+
+
+
+
+
See Also
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html
index 3341050a..4ef9193b 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.html
@@ -136,7 +136,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
Lock(Mutex)
@@ -186,7 +186,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
Lock(Semaphore)
@@ -236,7 +236,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
Lock(SemaphoreSlim)
@@ -286,7 +286,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockAsync(SemaphoreSlim)
@@ -336,7 +336,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockRead(ReaderWriterLockSlim)
@@ -386,7 +386,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockReadUpgradable(ReaderWriterLockSlim)
@@ -436,7 +436,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
LockWrite(ReaderWriterLockSlim)
@@ -492,7 +492,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.Release.html b/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.Release.html
index 0e1423ff..8d111cc3 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.Release.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.Release.html
@@ -118,18 +118,33 @@
+
+
+
+
+
@@ -141,7 +156,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.html b/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.html
index b4d9f4ef..96ab34a2 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.BeatSaber.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
GameVersion
@@ -160,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
InstallPath
@@ -192,7 +192,7 @@
Improve this Doc
- View Source
+ View Source
LibraryPath
@@ -224,7 +224,7 @@
Improve this Doc
- View Source
+ View Source
NativeLibraryPath
@@ -256,7 +256,7 @@
Improve this Doc
- View Source
+ View Source
PluginsPath
@@ -288,7 +288,7 @@
Improve this Doc
- View Source
+ View Source
ReleaseType
@@ -320,7 +320,7 @@
Improve this Doc
- View Source
+ View Source
UserDataPath
@@ -358,7 +358,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html b/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html
index e247bfe9..657acc7d 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.CriticalSection.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
EnterExecuteSection()
@@ -144,7 +144,7 @@
Improve this Doc
- View Source
+ View Source
EnterGCSection()
@@ -160,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
ExitExecuteSection()
@@ -176,7 +176,7 @@
Improve this Doc
- View Source
+ View Source
ExitGCSection()
@@ -198,7 +198,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html b/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html
index 7f98c523..294b8f72 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.EnumerableExtensions.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
Append<T>(IEnumerable<T>, T)
@@ -200,7 +200,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T>(IEnumerable<T>)
@@ -267,7 +267,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T>(IEnumerable<Nullable<T>>)
@@ -334,7 +334,7 @@
Improve this Doc
- View Source
+ View Source
NonNull<T, U>(IEnumerable<T>, Func<T, U>)
@@ -412,7 +412,7 @@
Improve this Doc
- View Source
+ View Source
Prepend<T>(IEnumerable<T>, T)
@@ -490,7 +490,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html b/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html
index 41828557..402fc51c 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Extensions.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
GetDefault(Type)
@@ -178,7 +178,7 @@
Improve this Doc
- View Source
+ View Source
IsSubPathOf(String, String)
@@ -233,7 +233,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)
@@ -289,7 +289,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>)
@@ -339,7 +339,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)
@@ -402,7 +402,7 @@ results in satisfying .EndsWith(ending).
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html b/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html
index 44ec1d02..780b751f 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Ref-1.html
@@ -149,7 +149,7 @@
Improve this Doc
- View Source
+ View Source
Ref(T)
@@ -185,7 +185,7 @@
Improve this Doc
- View Source
+ View Source
Error
@@ -217,7 +217,7 @@
Improve this Doc
- View Source
+ View Source
Value
@@ -251,7 +251,7 @@
Improve this Doc
- View Source
+ View Source
CompareTo(T)
@@ -301,7 +301,7 @@
Improve this Doc
- View Source
+ View Source
CompareTo(Ref<T>)
@@ -351,7 +351,7 @@
Improve this Doc
- View Source
+ View Source
Verify()
@@ -369,7 +369,7 @@
Improve this Doc
- View Source
+ View Source
Implicit(T to Ref<T>)
@@ -419,7 +419,7 @@
Improve this Doc
- View Source
+ View Source
Implicit(Ref<T> to T)
@@ -481,6 +481,9 @@
+
@@ -510,7 +513,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Ref.html b/branch/4.0.0-beta/api/IPA.Utilities.Ref.html
index ec3eb6a9..a50d4622 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Ref.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Ref.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
Create<T>(T)
@@ -200,7 +200,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html b/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html
index 2d8b12dd..f9e428e0 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.ReflectionUtil.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
CopyComponent(Component, Type, GameObject, Type)
@@ -196,7 +196,7 @@
Improve this Doc
- View Source
+ View Source
CopyComponent<T>(Component, GameObject, Type)
@@ -279,7 +279,7 @@
Improve this Doc
- View Source
+ View Source
GetField<T>(Object, String)
@@ -342,6 +342,115 @@
T
the type of the field (result casted)
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if fieldName
does not exist on the runtime type of obj
+
+
+
+
+
+ |
+ Improve this Doc
+
+
+ View Source
+
+
+ GetField<T, U>(U, String)
+ Gets the value of a field.
+
+
+ Declaration
+
+ public static T GetField<T, U>(this U obj, string fieldName)
+
+ Parameters
+
+
+
+ Type
+ Name
+ Description
+
+
+
+
+ U
+ obj
+ the object instance to pull from
+
+
+
+ String
+ fieldName
+ the name of the field to read
+
+
+
+
+ Returns
+
+
+
+ Type
+ Description
+
+
+
+
+ T
+ the value of the field
+
+
+
+
+ Type Parameters
+
+
+
+ Name
+ Description
+
+
+
+
+ T
+ the type of the field (result casted)
+
+
+
+ U
+ the type to get the field from
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if fieldName
does not exist on U
@@ -351,7 +460,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod(Object, String, Object[])
@@ -404,6 +513,22 @@
Object
the return value
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if methodName
does not exist on the runtime type of obj
@@ -413,7 +538,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod<T>(T, String, Object[])
@@ -422,8 +547,7 @@
Declaration
- public static object InvokeMethod<T>(this T obj, string methodName, params object[] args)
- where T : class
+ public static object InvokeMethod<T>(this T obj, string methodName, params object[] args)
Parameters
@@ -483,6 +607,22 @@
T
the type to search for the method on
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if methodName
does not exist on T
@@ -492,7 +632,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod<T>(Object, String, Object[])
@@ -565,12 +705,32 @@
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if methodName
does not exist on the runtime type of obj
+
+
+
+
+ See Also
+
|
Improve this Doc
- View Source
+ View Source
InvokeMethod<T, U>(U, String, Object[])
@@ -579,8 +739,7 @@
Declaration
- public static T InvokeMethod<T, U>(this U obj, string methodName, params object[] methodArgs)
- where U : class
+ public static T InvokeMethod<T, U>(this U obj, string methodName, params object[] methodArgs)
Parameters
@@ -649,12 +808,32 @@
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if methodName
does not exist on U
+
+
+
+
+ See Also
+
|
Improve this Doc
- View Source
+ View Source
SetField(Object, String, Object)
@@ -691,6 +870,22 @@
Object
value
the value to set it to
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if fieldName
does not exist on the runtime type of obj
@@ -700,7 +895,7 @@
Improve this Doc
- View Source
+ View Source
SetField<T>(T, String, Object)
@@ -709,8 +904,7 @@
Declaration
- public static void SetField<T>(this T obj, string fieldName, object value)
- where T : class
+ public static void SetField<T>(this T obj, string fieldName, object value)
Parameters
@@ -754,6 +948,22 @@
T
the type to get the field from
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if fieldName
does not exist on T
@@ -763,7 +973,7 @@
Improve this Doc
- View Source
+ View Source
SetProperty(Object, String, Object)
@@ -800,6 +1010,22 @@
Object
value
the value to set it to
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if propertyName
does not exist on the runtime type of obj
@@ -809,7 +1035,7 @@
Improve this Doc
- View Source
+ View Source
SetProperty<T>(T, String, Object)
@@ -818,8 +1044,7 @@
Declaration
- public static void SetProperty<T>(this T obj, string propertyName, object value)
- where T : class
+ public static void SetProperty<T>(this T obj, string propertyName, object value)
Parameters
@@ -863,6 +1088,22 @@
T
the type to get the property from
+
+
+
+
+ Exceptions
+
+
+
+ Type
+ Condition
+
+
+
+
+ ArgumentException
+ if propertyName
does not exist on T
@@ -878,7 +1119,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Utilities.Utils.html b/branch/4.0.0-beta/api/IPA.Utilities.Utils.html
index 88fe51ee..f810e27b 100644
--- a/branch/4.0.0-beta/api/IPA.Utilities.Utils.html
+++ b/branch/4.0.0-beta/api/IPA.Utilities.Utils.html
@@ -128,7 +128,7 @@
Improve this Doc
- View Source
+ View Source
CanUseDateTimeNowSafely
@@ -162,7 +162,7 @@
Improve this Doc
- View Source
+ View Source
ByteArrayToString(Byte[])
@@ -212,7 +212,7 @@
Improve this Doc
- View Source
+ View Source
CopyAll(DirectoryInfo, DirectoryInfo, String, Func<Exception, FileInfo, Boolean>)
@@ -264,7 +264,7 @@
Improve this Doc
- View Source
+ View Source
CurrentTime()
@@ -298,7 +298,7 @@ the value will be greater than the previous result. Not suitable for timing.
Improve this Doc
- View Source
+ View Source
GetRelativePath(String, String)
@@ -354,7 +354,7 @@ the value will be greater than the previous result. Not suitable for timing.
Improve this Doc
- View Source
+ View Source
StringToByteArray(String)
@@ -404,7 +404,7 @@ the value will be greater than the previous result. Not suitable for timing.
Improve this Doc
- View Source
+ View Source
UnsafeCompare(Byte[], Byte[])
@@ -460,7 +460,7 @@ the value will be greater than the previous result. Not suitable for timing.
Improve this Doc
- View Source
+ View Source
VersionCompareNoPrerelease(SemVer.Version, SemVer.Version)
@@ -522,7 +522,7 @@ the value will be greater than the previous result. Not suitable for timing.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/index.html b/branch/4.0.0-beta/api/index.html
index 53b2aa13..326b48f0 100644
--- a/branch/4.0.0-beta/api/index.html
+++ b/branch/4.0.0-beta/api/index.html
@@ -89,7 +89,7 @@ Select a namespace and a class on the left to get started.
diff --git a/branch/4.0.0-beta/articles/command-line.html b/branch/4.0.0-beta/articles/command-line.html
index 2f0d203c..964655b8 100644
--- a/branch/4.0.0-beta/articles/command-line.html
+++ b/branch/4.0.0-beta/articles/command-line.html
@@ -182,7 +182,7 @@ avaliable. If there is, it will be downloaded and installed on the next run. Thi
diff --git a/branch/4.0.0-beta/articles/contributing.html b/branch/4.0.0-beta/articles/contributing.html
index 7b735350..e21fccba 100644
--- a/branch/4.0.0-beta/articles/contributing.html
+++ b/branch/4.0.0-beta/articles/contributing.html
@@ -116,7 +116,7 @@ should reference the copy in there. When building for Release, it just uses the
diff --git a/branch/4.0.0-beta/articles/index.html b/branch/4.0.0-beta/articles/index.html
index b177d8ca..b82eda2b 100644
--- a/branch/4.0.0-beta/articles/index.html
+++ b/branch/4.0.0-beta/articles/index.html
@@ -93,7 +93,7 @@
diff --git a/branch/4.0.0-beta/articles/start-dev.html b/branch/4.0.0-beta/articles/start-dev.html
index 76b80495..f00836d8 100644
--- a/branch/4.0.0-beta/articles/start-dev.html
+++ b/branch/4.0.0-beta/articles/start-dev.html
@@ -87,7 +87,7 @@
diff --git a/branch/4.0.0-beta/articles/start-user.html b/branch/4.0.0-beta/articles/start-user.html
index 90d38824..1297c0db 100644
--- a/branch/4.0.0-beta/articles/start-user.html
+++ b/branch/4.0.0-beta/articles/start-user.html
@@ -160,7 +160,7 @@ the game directory, though your plugins will be moved to a different folder when
diff --git a/branch/4.0.0-beta/index.html b/branch/4.0.0-beta/index.html
index ef5fd5cd..c1af22c4 100644
--- a/branch/4.0.0-beta/index.html
+++ b/branch/4.0.0-beta/index.html
@@ -100,7 +100,7 @@
diff --git a/branch/4.0.0-beta/index.json b/branch/4.0.0-beta/index.json
index 01f2b2e7..5ed40a50 100644
--- a/branch/4.0.0-beta/index.json
+++ b/branch/4.0.0-beta/index.json
@@ -1,23 +1,28 @@
{
- "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(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "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(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Config.Config.html": {
- "href": "api/IPA.Config.Config.html",
- "title": "Class Config",
- "keywords": "Class Config A class to handle updating ConfigProviders automatically 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(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) GeneratedExtension.Generated(Config, Boolean)"
+ "api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html": {
+ "href": "api/IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html",
+ "title": "Struct Synchronization.SemaphoreSlimAsyncLocker",
+ "keywords": "Struct Synchronization.SemaphoreSlimAsyncLocker A locker for a SemaphoreSlim that was created asynchronously and automatically releases when it is disposed. Create this with LockAsync(SemaphoreSlim) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct SemaphoreSlimAsyncLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) See Also Synchronization LockAsync(SemaphoreSlim)"
},
- "api/BSIPA_ModList.UI.ViewControllers.html": {
- "href": "api/BSIPA_ModList.UI.ViewControllers.html",
- "title": "",
- "keywords": "Classes MarkdownView A UI component that renders CommonMark Markdown in-game."
+ "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html": {
+ "href": "api/IPA.Utilities.Async.Synchronization.SemaphoreLocker.html",
+ "title": "Struct Synchronization.SemaphoreLocker",
+ "keywords": "Struct Synchronization.SemaphoreLocker A locker for a Semaphore that automatically releases when it is disposed. Create this with Lock(Semaphore) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct SemaphoreLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) See Also Synchronization Lock(Semaphore)"
+ },
+ "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html": {
+ "href": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html",
+ "title": "Struct Synchronization.ReaderWriterLockSlimWriteLocker",
+ "keywords": "Struct Synchronization.ReaderWriterLockSlimWriteLocker A locker for a write lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockWrite(ReaderWriterLockSlim) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct ReaderWriterLockSlimWriteLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) See Also Synchronization LockWrite(ReaderWriterLockSlim)"
},
"api/IPA.OnDisableAttribute.html": {
"href": "api/IPA.OnDisableAttribute.html",
"title": "Class OnDisableAttribute",
- "keywords": "Class OnDisableAttribute Inheritance Object Attribute OnDisableAttribute 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 Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnDisableAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "keywords": "Class OnDisableAttribute Inheritance Object Attribute OnDisableAttribute 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 Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class OnDisableAttribute : Attribute, _Attribute, IEdgeLifecycleAttribute Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
"api/IPA.Old.html": {
"href": "api/IPA.Old.html",
@@ -27,302 +32,227 @@
"api/IPA.Old.IPlugin.html": {
"href": "api/IPA.Old.IPlugin.html",
"title": "Interface IPlugin",
- "keywords": "Interface IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins. Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IBeatSaberPlugin\")] public interface IPlugin Properties | Improve this Doc View Source Name Gets the name of the plugin. Declaration string Name { get; } Property Value Type Description String | Improve this Doc View Source Version Gets the version of the plugin. Declaration string Version { get; } Property Value Type Description String Methods | Improve this Doc View Source OnApplicationQuit() Gets invoked when the application is closed. Declaration void OnApplicationQuit() | Improve this Doc View Source OnApplicationStart() Gets invoked when the application is started. Declaration void OnApplicationStart() | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLevelWasInitialized(Int32) Gets invoked after the first update cycle after a level was loaded. Declaration void OnLevelWasInitialized(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnLevelWasLoaded(Int32) Gets invoked whenever a level is loaded. Declaration void OnLevelWasLoaded(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "keywords": "Interface IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins. Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IBeatSaberPlugin\")] public interface IPlugin Properties | Improve this Doc View Source Name Gets the name of the plugin. Declaration string Name { get; } Property Value Type Description String | Improve this Doc View Source Version Gets the version of the plugin. Declaration string Version { get; } Property Value Type Description String Methods | Improve this Doc View Source OnApplicationQuit() Gets invoked when the application is closed. Declaration void OnApplicationQuit() | Improve this Doc View Source OnApplicationStart() Gets invoked when the application is started. Declaration void OnApplicationStart() | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLevelWasInitialized(Int32) Gets invoked after the first update cycle after a level was loaded. Declaration void OnLevelWasInitialized(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnLevelWasLoaded(Int32) Gets invoked whenever a level is loaded. Declaration void OnLevelWasLoaded(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
"api/IPA.Old.IEnhancedPlugin.html": {
"href": "api/IPA.Old.IEnhancedPlugin.html",
"title": "Interface IEnhancedPlugin",
- "keywords": "Interface IEnhancedPlugin An enhanced version of the standard IPA plugin. Inherited Members IPlugin.Name IPlugin.Version IPlugin.OnApplicationStart() IPlugin.OnApplicationQuit() IPlugin.OnLevelWasLoaded(Int32) IPlugin.OnLevelWasInitialized(Int32) IPlugin.OnUpdate() IPlugin.OnFixedUpdate() Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IPA.IEnhancedPlugin\")] public interface IEnhancedPlugin : IPlugin Properties | Improve this Doc View Source Filter Gets a list of executables this plugin should be executed on (without the file ending) Declaration string[] Filter { get; } Property Value Type Description String [] Examples { \"PlayClub\", \"PlayClubStudio\" } Methods | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
- },
- "api/IPA.Logging.Printers.PluginLogFilePrinter.html": {
- "href": "api/IPA.Logging.Printers.PluginLogFilePrinter.html",
- "title": "Class PluginLogFilePrinter",
- "keywords": "Class PluginLogFilePrinter Prints log messages to the file specified by the name. Inheritance Object LogPrinter GZFilePrinter PluginLogFilePrinter Implements IDisposable Inherited Members GZFilePrinter.FileWriter GZFilePrinter.StartPrint() GZFilePrinter.EndPrint() GZFilePrinter.Dispose() GZFilePrinter.Dispose(Boolean) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class PluginLogFilePrinter : GZFilePrinter, IDisposable Constructors | Improve this Doc View Source PluginLogFilePrinter(String) Creates a new printer with the given name. Declaration public PluginLogFilePrinter(string name) Parameters Type Name Description String name the name of the logger Properties | Improve this Doc View Source Filter Provides a filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the target file. Declaration protected override FileInfo GetFileInfo() Returns Type Description FileInfo the file to write to Overrides GZFilePrinter.GetFileInfo() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the associated file. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
- },
- "api/IPA.Logging.Printers.GZFilePrinter.html": {
- "href": "api/IPA.Logging.Printers.GZFilePrinter.html",
- "title": "Class GZFilePrinter",
- "keywords": "Class GZFilePrinter A LogPrinter abstract class that provides the utilities to write to a GZip file. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter PluginLogFilePrinter PluginSubLogPrinter Implements IDisposable Inherited Members LogPrinter.Filter LogPrinter.Print(Logger.Level, DateTime, String, String) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public abstract class GZFilePrinter : LogPrinter, IDisposable Fields | Improve this Doc View Source FileWriter The StreamWriter that writes to the GZip file. Declaration protected StreamWriter FileWriter Field Value Type Description StreamWriter the writer to the underlying filestream Methods | Improve this Doc View Source Dispose() Declaration public void Dispose() | Improve this Doc View Source Dispose(Boolean) Disposes the file printer. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description Boolean disposing does nothing | Improve this Doc View Source EndPrint() Called at the end of any print session. Declaration public override sealed void EndPrint() Overrides LogPrinter.EndPrint() | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the file to write to. Declaration protected abstract FileInfo GetFileInfo() Returns Type Description FileInfo the file to write to | Improve this Doc View Source StartPrint() Called at the start of any print session. Declaration public override sealed void StartPrint() Overrides LogPrinter.StartPrint() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
- },
- "api/IPA.Logging.Printers.GlobalLogFilePrinter.html": {
- "href": "api/IPA.Logging.Printers.GlobalLogFilePrinter.html",
- "title": "Class GlobalLogFilePrinter",
- "keywords": "Class GlobalLogFilePrinter A printer for all messages to a unified log location. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter Implements IDisposable Inherited Members GZFilePrinter.FileWriter GZFilePrinter.StartPrint() GZFilePrinter.EndPrint() GZFilePrinter.Dispose() GZFilePrinter.Dispose(Boolean) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class GlobalLogFilePrinter : GZFilePrinter, IDisposable Properties | Improve this Doc View Source Filter Provides a filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the target file. Declaration protected override FileInfo GetFileInfo() Returns Type Description FileInfo the target file to write to Overrides GZFilePrinter.GetFileInfo() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the associated file. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
- },
- "api/IPA.Logging.Printers.ColorlessConsolePrinter.html": {
- "href": "api/IPA.Logging.Printers.ColorlessConsolePrinter.html",
- "title": "Class ColorlessConsolePrinter",
- "keywords": "Class ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. Inheritance Object LogPrinter ColorlessConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColorlessConsolePrinter : LogPrinter Properties | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to standard out. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
- },
- "api/IPA.Logging.Logger.LogLevel.html": {
- "href": "api/IPA.Logging.Logger.LogLevel.html",
- "title": "Enum Logger.LogLevel",
- "keywords": "Enum Logger.LogLevel An enum providing log level filters. Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax [Flags] public enum LogLevel : byte Fields Name Description All Shows all messages. CriticalOnly Only shows Critical messages. DebugOnly Only shows Debug messages. DebugUp Shows all messages debug and up. ErrorOnly Only shows Error messages. ErrorUp Shows all messages error and up. InfoOnly Only shows info messages. InfoUp Shows all messages info and up. None Allow no messages through. NoticeOnly Only shows notice messages. NoticeUp Shows all messages Notice and up. TraceOnly Only shows Trace messages. Undefined Used for when the level is undefined. WarningOnly Only shows Warning messages. WarningUp Shows all messages warning and up. Extension Methods ReflectionUtil.SetField(String, Object) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[])"
- },
- "api/IPA.Logging.Logger.Level.html": {
- "href": "api/IPA.Logging.Logger.Level.html",
- "title": "Enum Logger.Level",
- "keywords": "Enum Logger.Level An enum specifying the level of the message. Resembles Syslog. Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public enum Level : byte Fields Name Description Critical A critical error message. Debug A debug message. Error An error message. Info An informational message. None No associated level. These never get shown. Notice A notice. More significant than Info, but less than a warning. Trace A trace message. These are ignored incredibly early. Warning A warning message. Extension Methods ReflectionUtil.SetField(String, Object) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[])"
+ "keywords": "Interface IEnhancedPlugin An enhanced version of the standard IPA plugin. Inherited Members IPlugin.Name IPlugin.Version IPlugin.OnApplicationStart() IPlugin.OnApplicationQuit() IPlugin.OnLevelWasLoaded(Int32) IPlugin.OnLevelWasInitialized(Int32) IPlugin.OnUpdate() IPlugin.OnFixedUpdate() Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IPA.IEnhancedPlugin\")] public interface IEnhancedPlugin : IPlugin Properties | Improve this Doc View Source Filter Gets a list of executables this plugin should be executed on (without the file ending) Declaration string[] Filter { get; } Property Value Type Description String [] Examples { \"PlayClub\", \"PlayClubStudio\" } Methods | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Loader.html": {
- "href": "api/IPA.Loader.html",
- "title": "",
- "keywords": "Classes PluginInitInjector The type that handles value injecting into a plugin's Init. PluginLoader A type to manage the loading of plugins. PluginLoader.PluginInfo A container object for all the data relating to a plugin. PluginLoader.PluginMetadata A class which describes a loaded plugin. PluginManager The manager class for all plugins. Delegates PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event."
+ "api/IPA.Logging.Printers.ColoredConsolePrinter.html": {
+ "href": "api/IPA.Logging.Printers.ColoredConsolePrinter.html",
+ "title": "Class ColoredConsolePrinter",
+ "keywords": "Class ColoredConsolePrinter Prints a pretty message to the console. Inheritance Object LogPrinter ColoredConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColoredConsolePrinter : LogPrinter Properties | Improve this Doc View Source Color The color to print messages as. Declaration public ConsoleColor Color { get; set; } Property Value Type Description ConsoleColor the color to print this message as | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter to apply to this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the console window. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Loader.PluginManager.html": {
- "href": "api/IPA.Loader.PluginManager.html",
- "title": "Class PluginManager",
- "keywords": "Class PluginManager The manager class for all plugins. Inheritance Object PluginManager Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginManager Properties | Improve this Doc View Source AllPlugins Gets a list of all BSIPA plugins. Declaration public static IEnumerable AllPlugins { get; } Property Value Type Description IEnumerable < PluginLoader.PluginInfo > a collection of all enabled plugins as PluginLoader.PluginInfo s | Improve this Doc View Source DisabledPlugins Gets a list of disabled BSIPA plugins. Declaration public static IEnumerable DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginLoader.PluginMetadata > a collection of all disabled plugins as PluginLoader.PluginMetadata | Improve this Doc View Source Plugins An IEnumerable of old IPA plugins. Declaration [Obsolete(\"I mean, IPlugin shouldn't be used, so why should this? Not renaming to extend support for old plugins.\")] public static IEnumerable Plugins { get; } Property Value Type Description IEnumerable < IPlugin > all legacy plugin instances Methods | Improve this Doc View Source DisablePlugin(PluginLoader.PluginInfo) Disables a plugin, and all dependents. Declaration public static bool DisablePlugin(PluginLoader.PluginInfo plugin) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin to disable Returns Type Description Boolean whether or not it needs a restart to enable | Improve this Doc View Source DisablePlugin(String) Disables a plugin, and all dependents. Declaration public static bool DisablePlugin(string pluginId) Parameters Type Name Description String pluginId the ID, or name if the ID is null, of the plugin to disable Returns Type Description Boolean whether a restart is needed to activate | Improve this Doc View Source EnablePlugin(PluginLoader.PluginMetadata) Enables a plugin that had been previously disabled. Declaration public static bool EnablePlugin(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin to enable Returns Type Description Boolean whether a restart is needed to activate | Improve this Doc View Source EnablePlugin(String) Enables a plugin that had been previously disabled. Declaration public static bool EnablePlugin(string pluginId) Parameters Type Name Description String pluginId the ID, or name if the ID is null, of the plugin to enable Returns Type Description Boolean whether a restart is needed to activate | Improve this Doc View Source GetDisabledPlugin(String) Gets a disabled plugin's metadata by its name. Declaration public static PluginLoader.PluginMetadata GetDisabledPlugin(string name) Parameters Type Name Description String name the name of the disabled plugin to get Returns Type Description PluginLoader.PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetDisabledPluginFromId(String) Gets a disabled plugin's metadata by its ID. Declaration public static PluginLoader.PluginMetadata GetDisabledPluginFromId(string name) Parameters Type Name Description String name the ID of the disabled plugin to get Returns Type Description PluginLoader.PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetPlugin(String) Gets info about the plugin with the specified name. Declaration public static PluginLoader.PluginInfo GetPlugin(string name) Parameters Type Name Description String name the name of the plugin to get (must be an exact match) Returns Type Description PluginLoader.PluginInfo the plugin info for the requested plugin or null | Improve this Doc View Source GetPluginFromId(String) Gets info about the plugin with the specified ID. Declaration public static PluginLoader.PluginInfo GetPluginFromId(string name) Parameters Type Name Description String name the ID name of the plugin to get (must be an exact match) Returns Type Description PluginLoader.PluginInfo the plugin info for the requested plugin or null | Improve this Doc View Source GetPluginFromModSaberName(String) Gets info about the plugin with the specified ModSaber name. Declaration [Obsolete(\"Old name. Use GetPluginFromId instead.\")] public static PluginLoader.PluginInfo GetPluginFromModSaberName(string name) Parameters Type Name Description String name the ModSaber name of the plugin to get (must be an exact match) Returns Type Description PluginLoader.PluginInfo the plugin info for the requested plugin or null | Improve this Doc View Source InfoFromMetadata(PluginLoader.PluginMetadata) Converts a plugin's metadata to a PluginLoader.PluginInfo . Declaration public static PluginLoader.PluginInfo InfoFromMetadata(PluginLoader.PluginMetadata meta) Parameters Type Name Description PluginLoader.PluginMetadata meta the metadata Returns Type Description PluginLoader.PluginInfo the plugin info | Improve this Doc View Source IsDisabled(PluginLoader.PluginMetadata) Checks if a given plugin is disabled. Declaration public static bool IsDisabled(PluginLoader.PluginMetadata meta) Parameters Type Name Description PluginLoader.PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is disabled, false otherwise. | Improve this Doc View Source IsEnabled(PluginLoader.PluginMetadata) Checks if a given plugin is enabled. Declaration public static bool IsEnabled(PluginLoader.PluginMetadata meta) Parameters Type Name Description PluginLoader.PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is enabled, false otherwise. Events | Improve this Doc View Source PluginDisabled Called whenever a plugin is disabled. Declaration public static event PluginManager.PluginDisableDelegate PluginDisabled Event Type Type Description PluginManager.PluginDisableDelegate | Improve this Doc View Source PluginEnabled Called whenever a plugin is enabled. Declaration public static event PluginManager.PluginEnableDelegate PluginEnabled Event Type Type Description PluginManager.PluginEnableDelegate"
+ "api/IPA.Logging.LogPrinter.html": {
+ "href": "api/IPA.Logging.LogPrinter.html",
+ "title": "Class LogPrinter",
+ "keywords": "Class LogPrinter The log printer's base class. Inheritance Object LogPrinter ColoredConsolePrinter ColorlessConsolePrinter GZFilePrinter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public abstract class LogPrinter Properties | Improve this Doc View Source Filter Provides a filter for which log levels to allow through. Declaration public abstract Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the level to filter to Methods | Improve this Doc View Source EndPrint() Called after the last print in a group. May be called multiple times. Use this to dispose file handles and the like. Declaration public virtual void EndPrint() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints a provided message from a given log at the specified time. Declaration public abstract void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the log level DateTime time the time the message was composed String logName the name of the log that created this message String message the message | Improve this Doc View Source StartPrint() Called before the first print in a group. May be called multiple times. Use this to create file handles and the like. Declaration public virtual void StartPrint() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Loader.PluginLoader.PluginInfo.html": {
- "href": "api/IPA.Loader.PluginLoader.PluginInfo.html",
- "title": "Class PluginLoader.PluginInfo",
- "keywords": "Class PluginLoader.PluginInfo A container object for all the data relating to a plugin. Inheritance Object PluginLoader.PluginInfo Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax [Obsolete(\"No longer useful as a construct\")] public class PluginInfo Properties | Improve this Doc View Source Metadata Metadata for the plugin. Declaration public PluginLoader.PluginMetadata Metadata { get; } Property Value Type Description PluginLoader.PluginMetadata the metadata for this plugin Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "api/IPA.Logging.LoggerExtensions.html": {
+ "href": "api/IPA.Logging.LoggerExtensions.html",
+ "title": "Class LoggerExtensions",
+ "keywords": "Class LoggerExtensions A class providing extensions for various loggers. Inheritance Object LoggerExtensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public static class LoggerExtensions Methods | Improve this Doc View Source GetChildLogger(Logger, String) Gets a child logger, if supported. Currently the only defined and supported logger is StandardLogger , and most plugins will only ever receive this anyway. Declaration public static Logger GetChildLogger(this Logger logger, string name) Parameters Type Name Description Logger logger the parent Logger String name the name of the child Returns Type Description Logger the child logger"
},
- "api/IPA.Loader.PluginInitInjector.html": {
- "href": "api/IPA.Loader.PluginInitInjector.html",
- "title": "Class PluginInitInjector",
- "keywords": "Class PluginInitInjector The type that handles value injecting into a plugin's Init. Inheritance Object PluginInitInjector Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginInitInjector Methods | Improve this Doc View Source AddInjector(Type, PluginInitInjector.InjectParameter) Adds an injector to be used when calling future plugins' Init methods. Declaration public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector) Parameters Type Name Description Type type the type of the parameter. PluginInitInjector.InjectParameter injector the function to call for injection."
+ "api/IPA.Logging.Logger.html": {
+ "href": "api/IPA.Logging.Logger.html",
+ "title": "Class Logger",
+ "keywords": "Class Logger The logger base class. Provides the format for console logs. Inheritance Object Logger StandardLogger Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public abstract class Logger Properties | Improve this Doc View Source LogFormat The standard format for log messages. Declaration public static string LogFormat { get; protected set; } Property Value Type Description String the format for the standard loggers to print in Methods | Improve this Doc View Source Critical(Exception) Sends an exception as a critical message. Equivalent to Log(Level.Critical, e); Declaration public virtual void Critical(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Critical(String) Sends a critical message. Equivalent to Log(Level.Critical, message); Declaration public virtual void Critical(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Debug(Exception) Sends an exception as a debug message. Equivalent to Log(Level.Debug, e); Declaration public virtual void Debug(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Debug(String) Sends a debug message. Equivalent to Log(Level.Debug, message); Declaration public virtual void Debug(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Error(Exception) Sends an exception as an error message. Equivalent to Log(Level.Error, e); Declaration public virtual void Error(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Error(String) Sends an error message. Equivalent to Log(Level.Error, message); Declaration public virtual void Error(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Info(Exception) Sends an exception as an info message. Equivalent to Log(Level.Info, e); Declaration public virtual void Info(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Info(String) Sends an info message. Equivalent to Log(Level.Info, message); Declaration public virtual void Info(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Log(Logger.Level, Exception) A basic log function taking an exception to log. Declaration public virtual void Log(Logger.Level level, Exception e) Parameters Type Name Description Logger.Level level the level of the message Exception e the exception to log | Improve this Doc View Source Log(Logger.Level, String) A basic log function. Declaration public abstract void Log(Logger.Level level, string message) Parameters Type Name Description Logger.Level level the level of the message String message the message to log | Improve this Doc View Source Notice(Exception) Sends an exception as a notice message. Equivalent to Log(Level.Notice, e); Declaration public virtual void Notice(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Notice(String) Sends a notice message. Equivalent to Log(Level.Notice, message); Declaration public virtual void Notice(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Trace(Exception) Sends an exception as a trace message. Equivalent to Log(Level.Trace, e); Declaration public virtual void Trace(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Trace(String) Sends a trace message. Equivalent to Log(Level.Trace, message); Declaration public virtual void Trace(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) | Improve this Doc View Source Warn(Exception) Sends an exception as a warning message. Equivalent to Log(Level.Warning, e); Declaration public virtual void Warn(Exception e) Parameters Type Name Description Exception e the exception to log See Also Log(Logger.Level, Exception) | Improve this Doc View Source Warn(String) Sends a warning message. Equivalent to Log(Level.Warning, message); Declaration public virtual void Warn(string message) Parameters Type Name Description String message the message to log See Also Log(Logger.Level, String) Extension Methods LoggerExtensions.GetChildLogger(Logger, String) ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Loader.PluginInitInjector.InjectParameter.html": {
- "href": "api/IPA.Loader.PluginInitInjector.InjectParameter.html",
- "title": "Delegate PluginInitInjector.InjectParameter",
- "keywords": "Delegate PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate object InjectParameter(object previous, ParameterInfo param, PluginLoader.PluginMetadata meta); Parameters Type Name Description Object previous the previous return value of the function, or null if never called for plugin. ParameterInfo param the ParameterInfo of the parameter being injected. PluginLoader.PluginMetadata meta the PluginLoader.PluginMetadata for the plugin being loaded. Returns Type Description Object the value to inject into that parameter. Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "api/IPA.Loader.Features.Feature.html": {
+ "href": "api/IPA.Loader.Features.Feature.html",
+ "title": "Class Feature",
+ "keywords": "Class Feature The root interface for a mod Feature. Inheritance Object Feature Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader.Features Assembly : IPA.Loader.dll Syntax public abstract class Feature Remarks Avoid storing any data in any subclasses. If you do, it may result in a failure to load the feature. Properties | Improve this Doc View Source InvalidMessage The message to be logged when the feature is not valid for a plugin. This should also be set whenever either BeforeLoad(PluginLoader.PluginMetadata) or BeforeInit(PluginLoader.PluginInfo) returns false. Declaration public virtual string InvalidMessage { get; protected set; } Property Value Type Description String the message to show when the feature is marked invalid | Improve this Doc View Source StoreOnPlugin Defines whether or not this feature will be accessible from the plugin metadata once loaded. Declaration protected virtual bool StoreOnPlugin { get; } Property Value Type Description Boolean true if this Feature will be stored on the plugin metadata, false otherwise Methods | Improve this Doc View Source AfterInit(PluginLoader.PluginInfo) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginLoader.PluginInfo plugin) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin that was just initialized | Improve this Doc View Source AfterInit(PluginLoader.PluginInfo, IPlugin) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginLoader.PluginInfo plugin, IPlugin pluginInstance) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin that was just initialized IPlugin pluginInstance the instance of the plugin being initialized | Improve this Doc View Source BeforeInit(PluginLoader.PluginInfo) Called before a plugin's Init method is called. This will not be called if there is no Init method. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeInit(PluginLoader.PluginInfo plugin) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin to be initialized Returns Type Description Boolean whether or not to call the Init method | Improve this Doc View Source BeforeLoad(PluginLoader.PluginMetadata) Called before a plugin is loaded. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeLoad(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin about to be loaded Returns Type Description Boolean whether or not the plugin should be loaded Remarks The assembly will still be loaded, but the plugin will not be constructed if this returns false . Any features it defines, for example, will still be loaded. | Improve this Doc View Source Evaluate() Evaluates the Feature for use in conditional meta-Features. This should be re-calculated on every call, unless it can be proven to not change. This will be called on every feature that returns true from Initialize(PluginLoader.PluginMetadata, String[]) Declaration public virtual bool Evaluate() Returns Type Description Boolean the truthiness of the Feature. | Improve this Doc View Source Initialize(PluginLoader.PluginMetadata, String[]) Initializes the feature with the parameters provided in the definition. Note: When no parenthesis are provided, parameters is an empty array. Declaration public abstract bool Initialize(PluginLoader.PluginMetadata meta, string[] parameters) Parameters Type Name Description PluginLoader.PluginMetadata meta the metadata of the plugin that is being prepared String [] parameters the parameters passed to the feature definition, or null Returns Type Description Boolean true if the feature is valid for the plugin, false otherwise Remarks This gets called BEFORE your Init method. Returning false does not prevent the plugin from being loaded. It simply prevents the feature from being used. | Improve this Doc View Source RequireLoaded(PluginLoader.PluginMetadata) Ensures a plugin's assembly is loaded. Do not use unless you need to. Declaration protected void RequireLoaded(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin to ensure is loaded. Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Loader.Features.html": {
- "href": "api/IPA.Loader.Features.html",
- "title": "",
- "keywords": "Classes Feature The root interface for a mod Feature."
+ "api/IPA.IPlugin.html": {
+ "href": "api/IPA.IPlugin.html",
+ "title": "Interface IPlugin",
+ "keywords": "Interface IPlugin Interface for BSIPA plugins. Every class that implements this will be loaded if the DLL is placed at /Plugins. Namespace : IPA Assembly : IPA.Loader.dll Syntax [Obsolete(\"Use the attribute-based system instead.\")] public interface IPlugin Remarks Mods implemented with this interface should handle being enabled at runtime properly, unless marked with the \"no-runtime-enable\" feature. Methods | Improve this Doc View Source OnActiveSceneChanged(Scene, Scene) Gets invoked whenever a scene is changed Declaration void OnActiveSceneChanged(Scene prevScene, Scene nextScene) Parameters Type Name Description UnityEngine.SceneManagement.Scene prevScene The Scene that was previously loaded UnityEngine.SceneManagement.Scene nextScene The Scene being loaded | Improve this Doc View Source OnApplicationQuit() Gets invoked when the application is closed. Declaration void OnApplicationQuit() | Improve this Doc View Source OnEnable() Called when a plugin is enabled. This is where you should set up Harmony patches and the like. Declaration void OnEnable() Remarks This will be called after Init , and will be called when the plugin loads normally too. When a plugin is disabled at startup, neither this nor Init will be called until it is enabled. Init will only ever be called once. | Improve this Doc View Source OnSceneLoaded(Scene, LoadSceneMode) Gets invoked whenever a scene is loaded. Declaration void OnSceneLoaded(Scene scene, LoadSceneMode sceneMode) Parameters Type Name Description UnityEngine.SceneManagement.Scene scene The scene currently loaded UnityEngine.SceneManagement.LoadSceneMode sceneMode The type of loading | Improve this Doc View Source OnSceneUnloaded(Scene) Gets invoked whenever a scene is unloaded Declaration void OnSceneUnloaded(Scene scene) Parameters Type Name Description UnityEngine.SceneManagement.Scene scene The unloaded scene Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
"api/IPA.InitAttribute.html": {
"href": "api/IPA.InitAttribute.html",
"title": "Class InitAttribute",
- "keywords": "Class InitAttribute Inheritance Object Attribute InitAttribute 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 Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Constructor | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class InitAttribute : Attribute, _Attribute Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "keywords": "Class InitAttribute Inheritance Object Attribute InitAttribute 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 Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Constructor | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class InitAttribute : Attribute, _Attribute Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
"api/IPA.IEnhancedPlugin.html": {
"href": "api/IPA.IEnhancedPlugin.html",
"title": "Interface IEnhancedPlugin",
- "keywords": "Interface IEnhancedPlugin An enhanced version of a standard BeatSaber plugin. Inherited Members IPlugin.OnEnable() IPlugin.OnApplicationQuit() IPlugin.OnSceneLoaded(Scene, LoadSceneMode) IPlugin.OnSceneUnloaded(Scene) IPlugin.OnActiveSceneChanged(Scene, Scene) Namespace : IPA Assembly : IPA.Loader.dll Syntax [Obsolete(\"Use the attribute-based system instead.\")] public interface IEnhancedPlugin : IPlugin Methods | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
+ "keywords": "Interface IEnhancedPlugin An enhanced version of a standard BeatSaber plugin. Inherited Members IPlugin.OnEnable() IPlugin.OnApplicationQuit() IPlugin.OnSceneLoaded(Scene, LoadSceneMode) IPlugin.OnSceneUnloaded(Scene) IPlugin.OnActiveSceneChanged(Scene, Scene) Namespace : IPA Assembly : IPA.Loader.dll Syntax [Obsolete(\"Use the attribute-based system instead.\")] public interface IEnhancedPlugin : IPlugin Methods | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Config.Stores.html": {
- "href": "api/IPA.Config.Stores.html",
- "title": "",
- "keywords": "Classes GeneratedExtension A class providing an extension for Config to make it easy to use generated config stores. ValueConverter A strongly-typed IValueConverter . Interfaces IValueConverter The base interface for a value converter for use by objects generated by Generated(Config, Boolean) ."
- },
- "api/IPA.Config.Stores.ValueConverter-1.html": {
- "href": "api/IPA.Config.Stores.ValueConverter-1.html",
- "title": "Class ValueConverter",
- "keywords": "Class ValueConverter A strongly-typed IValueConverter . Inheritance Object ValueConverter CollectionConverter CustomObjectConverter NullableConverter AlmostVersionConverter Implements IValueConverter 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 abstract class ValueConverter : IValueConverter Type Parameters Name Description T the type of object to handle Methods | Improve this Doc View Source FromValue(Value, Object) Converts the given Value to the object type handled by this converter. Declaration public abstract T FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the object that will own the result Returns Type Description T the deserialized object See Also FromValue ( Value , Object ) | Improve this Doc View Source ToValue(T, Object) Converts the given object to a Value . Declaration public abstract Value ToValue(T obj, object parent) Parameters Type Name Description T obj the object to convert Object parent the owning object of obj Returns Type Description Value a representation of obj as a Value structure See Also ToValue ( Object , Object ) Explicit Interface Implementations | Improve this Doc View Source IValueConverter.FromValue(Value, Object) Declaration object IValueConverter.FromValue(Value value, object parent) Parameters Type Name Description Value value Object parent Returns Type Description Object | Improve this Doc View Source IValueConverter.ToValue(Object, Object) Declaration Value IValueConverter.ToValue(object obj, object parent) Parameters Type Name Description Object obj Object parent Returns Type Description Value | Improve this Doc View Source IValueConverter.Type Declaration Type IValueConverter.Type { get; } Returns Type Description Type Implements IValueConverter Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) See Also IValueConverter"
+ "api/IPA.IDisablablePlugin.html": {
+ "href": "api/IPA.IDisablablePlugin.html",
+ "title": "Interface IDisablablePlugin",
+ "keywords": "Interface IDisablablePlugin Provides methods to allow runtime disabling of a plugin. Inherited Members IPlugin.OnEnable() IPlugin.OnApplicationQuit() IPlugin.OnSceneLoaded(Scene, LoadSceneMode) IPlugin.OnSceneUnloaded(Scene) IPlugin.OnActiveSceneChanged(Scene, Scene) Namespace : IPA Assembly : IPA.Loader.dll Syntax [Obsolete(\"Use the attribute-based system instead.\")] public interface IDisablablePlugin : IPlugin Methods | Improve this Doc View Source OnDisable() Called when a plugin is disabled at runtime. This should disable things like Harmony patches and unsubscribe from events. After this is called there should be no lingering effects of the mod. Declaration void OnDisable() Remarks This will get called at shutdown, after OnApplicationQuit() , as well as when the plugin is disabled at runtime. Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[])"
},
- "api/IPA.Config.Stores.Converters.html": {
- "href": "api/IPA.Config.Stores.Converters.html",
+ "api/IPA.Config.html": {
+ "href": "api/IPA.Config.html",
"title": "",
- "keywords": "Classes 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) . 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. 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 ."
+ "keywords": "Classes Config A class to handle updating ConfigProviders automatically Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Config.PreferAttribute Specifies that a particular parameter is preferred to use a particular IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. ConfigProvider A wrapper for an IConfigProvider and the FileInfo to use with it. ModPrefs Allows to get and set preferences for your mod. Interfaces IConfigProvider An interface for configuration providers. IConfigStore A storage for a config structure. IModPrefs Allows to get and set preferences for your mod."
},
- "api/IPA.Config.Stores.Converters.NullableConverter-2.html": {
- "href": "api/IPA.Config.Stores.Converters.NullableConverter-2.html",
- "title": "Class NullableConverter",
- "keywords": "Class 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 . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members NullableConverter