From 1df0877feaf70e80ee123310f59cd823c589496c 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. A class to handle updating ConfigProviders automatically An abstraction of a config file on disk, which handles synchronizing between a memory representation and the
+disk representation.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
@@ -549,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
@@ -360,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
@@ -361,7 +361,7 @@ public sealed class PreferAttribute : Attribute, _Attribute
Improve this Doc
Class Config
- Name
@@ -159,7 +160,7 @@
Improve this Doc
- View Source
+ View Source
Provider
@@ -192,7 +193,7 @@
Improve this Doc
- View Source
+ View Source
GetConfigFor(String, String[])
@@ -248,7 +249,7 @@
Improve this Doc
- View Source
+ View Source
LoadAsync()
@@ -279,7 +280,7 @@
Improve this Doc
- View Source
+ View Source
LoadSync()
@@ -295,7 +296,7 @@
Improve this Doc
- View Source
+ View Source
Register(Type)
@@ -329,7 +330,7 @@
Improve this Doc
- View Source
+ View Source
Register<T>()
@@ -362,7 +363,7 @@
Improve this Doc
- View Source
+ View Source
SetStore(IConfigStore)
@@ -452,7 +453,7 @@
Improve this Doc
Load()
@@ -161,7 +161,7 @@ and returns it.
Improve this Doc
- View Source
+ View Source
Store(Value)
@@ -232,7 +232,7 @@ and returns it.
Improve this Doc
Value
@@ -201,7 +201,7 @@
Improve this Doc
- View Source
+ View Source
ToString()
@@ -272,7 +272,7 @@
Improve this Doc
Value
@@ -202,7 +202,7 @@
Improve this Doc
- View Source
+ View Source
AsInteger()
@@ -234,7 +234,7 @@
Improve this Doc
- View Source
+ View Source
ToString()
@@ -305,7 +305,7 @@
Improve this Doc
parent
.<
Improve this Doc
- View Source
+ View Source
parent
Improve this Doc
- View Source
+ View Source
ToValue(TCollection, Object)
@@ -536,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 e8b295f3..73dcb4b2 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()
@@ -257,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 5c640215..c090556b 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 f1ceb00b..c947cbc2 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 1cb6c92d..6dff1d76 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)
@@ -447,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 285e535b..5b1a779b 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)
@@ -340,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 9d3ed05c..21e7d2c9 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()
@@ -256,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 35c5f591..629732d5 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)
@@ -340,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 7d0b4f37..890885ee 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()
@@ -256,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 9fb0a5a4..5fcd18b4 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)
@@ -340,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 911f0863..a10365cd 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()
@@ -256,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 6d714b2c..33829322 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)
@@ -375,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 866bc049..5d14fc22 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()
@@ -236,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 b649aeb1..6dd89c32 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 678f5d38..4b534ea2 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)
@@ -298,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 66993112..40c29a51 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
@@ -453,7 +453,7 @@
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.html b/branch/4.0.0-beta/api/IPA.Config.html
index 4ad753a9..2f08f0a0 100644
--- a/branch/4.0.0-beta/api/IPA.Config.html
+++ b/branch/4.0.0-beta/api/IPA.Config.html
@@ -85,7 +85,8 @@
Classes
Config
- A class to handle updating ConfigProviders automatically
+ An abstraction of a config file on disk, which handles synchronizing between a memory representation and the
+disk representation.
Config.NameAttribute
Specifies a preferred config name, instead of using the plugin's name.
diff --git a/branch/4.0.0-beta/api/IPA.IDisablablePlugin.html b/branch/4.0.0-beta/api/IPA.IDisablablePlugin.html
index 5bb68b6f..f37e0e82 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()
@@ -176,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 9d538b71..720fa8b0 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()
@@ -203,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 ef02bb1d..b30e1f33 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)
@@ -293,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 27ae26e0..de562a2a 100644
--- a/branch/4.0.0-beta/api/IPA.InitAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.InitAttribute.html
@@ -303,7 +303,7 @@ Parameter injection is done with 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 3eb730c3..d7acc1ae 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(PluginMetadata)
@@ -232,7 +232,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
AfterInit(PluginMetadata, Object)
@@ -272,7 +272,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
BeforeInit(PluginMetadata)
@@ -322,7 +322,7 @@ This should also be set whenever either Improve this Doc
- View Source
+ View Source
BeforeLoad(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(PluginMetadata, String[])
@@ -470,7 +470,7 @@ Any features it defines, for example, will still be loaded.
Improve this Doc
- View Source
+ View Source
RequireLoaded(PluginMetadata)
@@ -541,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 e36e06e5..2de6cd58 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
@@ -180,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 c1e3d7f4..572e97ab 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
@@ -121,6 +121,17 @@
public static class PluginInitInjector
+ Remarks
+ The default injectors and what they provide are shown in this table.
+
Parameter Type Injected Value Logger A StandardLogger specialized for the plugin being injected PluginMetadata The PluginMetadata of the plugin being injected Config
+A Config object for the plugin being injected.
+
+These parameters may have Config.NameAttribute and Config.PreferAttribute to control
+how it is constructed.
+
+
+For all of the default injectors, only one of each will be generated, and any later parameters will recieve the same value as the first one.
+
Methods
@@ -128,7 +139,7 @@
Improve this Doc
- View Source
+ View Source
AddInjector(Type, PluginInitInjector.InjectParameter)
@@ -174,7 +185,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 bbb38b51..bb43680f 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
@@ -158,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 85f50315..16d76788 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
@@ -158,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 966edff3..7ebdb7ad 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
GetDisabledPlugin(String)
@@ -277,7 +277,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
GetDisabledPluginFromId(String)
@@ -327,7 +327,7 @@ public static IEnumerable<IPlugin> Plugins { get; }
Improve this Doc
- View Source
+ View Source
Called whenever a plugin is disabled.
@@ -559,7 +559,7 @@ public static IEnumerable<IPlugin> Plugins { get; } Improve this Doc - View Source + View SourceCalled whenever a plugin is enabled.
@@ -595,7 +595,7 @@ public static IEnumerable<IPlugin> Plugins { get; } 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);
Improve this Doc
The StreamWriter that writes to the GZip file.
@@ -175,7 +175,7 @@ Improve this Doc - View Source + View SourceIndicates that this plugin supports runtime enabling and disabling.
++Indicates that this plugin supports runtime enabling and disabling. +
++When this is set, the plugin may be disabled at reasonable points during runtime. As with SingleStartInit, +it will be initialized and enabled with the game if it is enabled on startup, and disabled with the game if it is enabled +on shutdown. +
++When a plugin with this set is enabled mid-game, the first time it is enabled, its initialization methods will be called, +then its enable methods. All subsequent enables will NOT re-initialize, however the enable methods will be called. +
++When a plugin with this set is disabled mid-game, the plugin instance will NOT be destroyed, and will instead be +re-used for subsequent enables. The plugin is expected to handle this gracefully, and behave in a way that makes sense. +
Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game.
++Indicates that this plugin expects to be initialized and enabled with the game, and disabled with the game. +
++With this option set, whether or not the plugin is disabled during a given run is constant for that entire run. +
Improve 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)
@@ -905,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 a8d6f6ba..90a24739 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)
@@ -298,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 7e63bd1f..9c1331ad 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)
@@ -595,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 1461ce1e..7c3b53cb 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()
@@ -186,7 +186,7 @@ Create this with Improve this Doc
- View Source
+ View Source
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 ea509372..e70cdfae 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()
@@ -186,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 17317d1c..6dfce7f2 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()
@@ -225,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 e7a0c412..9562f876 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()
@@ -186,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 3e0df2b5..703df06e 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()
@@ -186,7 +186,7 @@ Create this with Improve this Doc
- View Source
+ View Source
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 9f293b0a..c3f8a2bc 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()
@@ -186,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 dea7f769..4edba186 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()
@@ -186,7 +186,7 @@ Create this with Improve this Doc
- View Source
+ View Source
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 8972bb35..6bd71299 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 abaabe94..fed9612a 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
@@ -156,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 14cfe152..85c06754 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 95cc808e..29cd87a2 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 99affde9..0d91fc93 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 cd7e3a78..8a9a74ab 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 c7a9fc0d..624f1a96 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)
@@ -513,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 681296e1..fc8f72fc 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 6ad589f8..f3fcc9b6 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)
@@ -367,7 +367,7 @@
Improve this Doc
- View Source
+ View Source
GetField<T, U>(U, String)
@@ -460,7 +460,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod(Object, String, Object[])
@@ -538,7 +538,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod<T>(T, String, Object[])
@@ -632,7 +632,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod<T>(Object, String, Object[])
@@ -730,7 +730,7 @@
Improve this Doc
- View Source
+ View Source
InvokeMethod<T, U>(U, String, Object[])
@@ -833,7 +833,7 @@
Improve this Doc
- View Source
+ View Source
SetField(Object, String, Object)
@@ -895,7 +895,7 @@
Improve this Doc
- View Source
+ View Source
SetField<T>(T, String, Object)
@@ -973,7 +973,7 @@
Improve this Doc
- View Source
+ View Source
SetProperty(Object, String, Object)
@@ -1035,7 +1035,7 @@
Improve this Doc
- View Source
+ View Source
SetProperty<T>(T, String, Object)
@@ -1119,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 42e3c5e1..5a702cf3 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 4ea2dd1d..9bc28626 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 fbf2a364..32a99f2b 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 92493c4a..b1893a1f 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 19c4ad9c..213e35c2 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 dd503503..a6a86e01 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 adbfe9d6..fcd04107 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 f60d709c..1ea8cccf 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 4e2c2aa4..9de4e7d2 100644
--- a/branch/4.0.0-beta/index.json
+++ b/branch/4.0.0-beta/index.json
@@ -1,8 +1,53 @@
{
- "api/BSIPA_ModList.UI.ViewControllers.html": {
- "href": "api/BSIPA_ModList.UI.ViewControllers.html",
+ "api/IPA.Utilities.Utils.html": {
+ "href": "api/IPA.Utilities.Utils.html",
+ "title": "Class Utils",
+ "keywords": "Class Utils A class providing static utility functions that in any other language would just exist . Inheritance Object Utils Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Utils Properties | Improve this Doc View Source CanUseDateTimeNowSafely Whether you can safely use Now without Mono throwing a fit. Declaration public static bool CanUseDateTimeNowSafely { get; } Property Value Type Description Boolean true if you can use Now safely, false otherwise Methods | Improve this Doc View Source ByteArrayToString(Byte[]) Converts a byte array to a hex string. Declaration public static string ByteArrayToString(byte[] ba) Parameters Type Name Description Byte [] ba the byte array Returns Type Description String the hex form of the array | Improve this Doc View Source CopyAll(DirectoryInfo, DirectoryInfo, String, Func
) Copies all files from source to target . Declaration public static void CopyAll(DirectoryInfo source, DirectoryInfo target, string appendFileName = \"\", Func onCopyException = null) Parameters Type Name Description DirectoryInfo source the source directory DirectoryInfo target the destination directory String appendFileName the filename of the file to append together Func < Exception , FileInfo , Boolean > onCopyException a delegate called when there is an error copying. Return true to keep going. | Improve this Doc View Source CurrentTime() Gets the current DateTime if supported, otherwise, if Mono would throw a fit, returns MinValue plus some value, such that each time it is called the value will be greater than the previous result. Not suitable for timing. Declaration public static DateTime CurrentTime() Returns Type Description DateTime the current DateTime if supported, otherwise some indeterminant increasing value. | Improve this Doc View Source GetRelativePath(String, String) Gets a path relative to the provided folder. Declaration public static string GetRelativePath(string file, string folder) Parameters Type Name Description String file the file to relativize String folder the source folder Returns Type Description String a path to get from folder to file | Improve this Doc View Source StringToByteArray(String) Converts a hex string to a byte array. Declaration public static byte[] StringToByteArray(string hex) Parameters Type Name Description String hex the hex stream Returns Type Description Byte [] the corresponding byte array | Improve this Doc View Source UnsafeCompare(Byte[], Byte[]) Uses unsafe code to compare 2 byte arrays quickly. Declaration public static bool UnsafeCompare(byte[] a1, byte[] a2) Parameters Type Name Description Byte [] a1 array 1 Byte [] a2 array 2 Returns Type Description Boolean whether or not they are byte-for-byte equal | Improve this Doc View Source VersionCompareNoPrerelease(SemVer.Version, SemVer.Version) Compares a pair of s ignoring both the prerelease and build fields. Declaration public static int VersionCompareNoPrerelease(SemVer.Version l, SemVer.Version r) Parameters Type Name Description SemVer.Version l the left value SemVer.Version r the right value Returns Type Description Int32 < 0 if l is less than r, 0 if they are equal in the numeric portion, or > 0 if l is greater than r"
+ },
+ "api/IPA.Utilities.ReflectionUtil.html": {
+ "href": "api/IPA.Utilities.ReflectionUtil.html",
+ "title": "Class ReflectionUtil",
+ "keywords": "Class ReflectionUtil A utility class providing reflection helper methods. Inheritance Object ReflectionUtil Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class ReflectionUtil Methods | Improve this Doc View Source CopyComponent(Component, Type, GameObject, Type) Copies a component original to a component of overridingType on the destination UnityEngine.GameObject . Declaration public static Component CopyComponent(this Component original, Type overridingType, GameObject destination, Type originalTypeOverride = null) Parameters Type Name Description UnityEngine.Component original the original component Type overridingType the new component's type UnityEngine.GameObject destination the destination GameObject Type originalTypeOverride overrides the source component type (for example, to a superclass) Returns Type Description UnityEngine.Component the copied component | Improve this Doc View Source CopyComponent(Component, GameObject, Type) A generic version of CopyComponent(Component, Type, GameObject, Type) . Declaration public static T CopyComponent(this Component original, GameObject destination, Type originalTypeOverride = null) where T : Component Parameters Type Name Description UnityEngine.Component original the original component UnityEngine.GameObject destination the destination game object Type originalTypeOverride overrides the source component type (for example, to a superclass) Returns Type Description T the copied component Type Parameters Name Description T the overriding type See Also CopyComponent(Component, Type, GameObject, Type) | Improve this Doc View Source GetField(Object, String) Gets the value of a field. Declaration public static T GetField(this object obj, string fieldName) Parameters Type Name Description Object 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) Exceptions Type Condition ArgumentException if fieldName does not exist on the runtime type of obj | Improve this Doc View Source GetField(U, String) Gets the value of a field. Declaration public static T GetField(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 | Improve this Doc View Source InvokeMethod(Object, String, Object[]) Invokes a method on an object. Declaration public static object InvokeMethod(this object obj, string methodName, params object[] methodArgs) Parameters Type Name Description Object obj the object to call from String methodName the method name Object [] methodArgs the method arguments Returns Type Description Object the return value Exceptions Type Condition ArgumentException if methodName does not exist on the runtime type of obj | Improve this Doc View Source InvokeMethod(T, String, Object[]) Invokes a method from T on an object. Declaration public static object InvokeMethod(this T obj, string methodName, params object[] args) Parameters Type Name Description T obj the object instance String methodName the method's name Object [] args the method arguments Returns Type Description Object the return value Type Parameters Name Description T the type to search for the method on Exceptions Type Condition ArgumentException if methodName does not exist on T | Improve this Doc View Source InvokeMethod(Object, String, Object[]) Invokes a method. Declaration public static T InvokeMethod(this object obj, string methodName, params object[] methodArgs) Parameters Type Name Description Object obj the object instance String methodName the method name to call Object [] methodArgs the method's arguments Returns Type Description T the return value Type Parameters Name Description T the return type Exceptions Type Condition ArgumentException if methodName does not exist on the runtime type of obj See Also InvokeMethod(Object, String, Object[]) | Improve this Doc View Source InvokeMethod(U, String, Object[]) Invokes a method from U on an object. Declaration public static T InvokeMethod(this U obj, string methodName, params object[] methodArgs) Parameters Type Name Description U obj the object instance String methodName the method name to call Object [] methodArgs the method's arguments Returns Type Description T the return value Type Parameters Name Description T the return type U the type to search for the method on Exceptions Type Condition ArgumentException if methodName does not exist on U See Also InvokeMethod(T, String, Object[]) | Improve this Doc View Source SetField(Object, String, Object) Sets a field on the target object. Declaration public static void SetField(this object obj, string fieldName, object value) Parameters Type Name Description Object obj the object instance String fieldName the field to set Object value the value to set it to Exceptions Type Condition ArgumentException if fieldName does not exist on the runtime type of obj | Improve this Doc View Source SetField(T, String, Object) Sets a field on the target object, as gotten from T . Declaration public static void SetField(this T obj, string fieldName, object value) Parameters Type Name Description T obj the object instance String fieldName the field to set Object value the value to set it to Type Parameters Name Description T the type to get the field from Exceptions Type Condition ArgumentException if fieldName does not exist on T | Improve this Doc View Source SetProperty(Object, String, Object) Sets a property on the target object. Declaration public static void SetProperty(this object obj, string propertyName, object value) Parameters Type Name Description Object obj the target object instance String propertyName the name of the property Object value the value to set it to Exceptions Type Condition ArgumentException if propertyName does not exist on the runtime type of obj | Improve this Doc View Source SetProperty(T, String, Object) Sets a property on the target object, as gotten from T Declaration public static void SetProperty(this T obj, string propertyName, object value) Parameters Type Name Description T obj the object instance String propertyName the property to set Object value the value to set it to Type Parameters Name Description T the type to get the property from Exceptions Type Condition ArgumentException if propertyName does not exist on T"
+ },
+ "api/IPA.Utilities.Ref.html": {
+ "href": "api/IPA.Utilities.Ref.html",
+ "title": "Class Ref",
+ "keywords": "Class Ref Utilities to create Ref using type inference. Inheritance Object Ref Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Ref Methods | Improve this Doc View Source Create(T) Creates a Ref . Declaration public static Ref Create(T val) Parameters Type Name Description T val the default value. Returns Type Description Ref the new Ref . Type Parameters Name Description T the type to reference."
+ },
+ "api/IPA.Utilities.Ref-1.html": {
+ "href": "api/IPA.Utilities.Ref-1.html",
+ "title": "Class Ref",
+ "keywords": "Class Ref A class to store a reference for passing to methods which cannot take ref parameters. Inheritance Object Ref Implements IComparable IComparable < Ref > Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public class Ref : IComparable, IComparable> Type Parameters Name Description T the type of the value Constructors | Improve this Doc View Source Ref(T) Constructor. Declaration public Ref(T reference) Parameters Type Name Description T reference the initial value of the reference Properties | Improve this Doc View Source Error An exception that was generated while creating the value. Declaration public Exception Error { get; set; } Property Value Type Description Exception the error held in this Ref | Improve this Doc View Source Value The value of the reference Declaration public T Value { get; set; } Property Value Type Description T the value wrapped by this Ref Methods | Improve this Doc View Source CompareTo(T) Compares the wrapped object to the other object. Declaration public int CompareTo(T other) Parameters Type Name Description T other the object to compare to Returns Type Description Int32 the value of the comparison | Improve this Doc View Source CompareTo(Ref) Compares the wrapped object to the other wrapped object. Declaration public int CompareTo(Ref other) Parameters Type Name Description Ref other the wrapped object to compare to Returns Type Description Int32 the value of the comparison | Improve this Doc View Source Verify() Throws error if one was set. Declaration public void Verify() Operators | Improve this Doc View Source Implicit(T to Ref) Converts a value T to a reference to that object. Will overwrite the reference in the left hand expression if there is one. Declaration public static implicit operator Ref(T toConvert) Parameters Type Name Description T toConvert the value to wrap in the Ref Returns Type Description Ref the Ref wrapping the value | Improve this Doc View Source Implicit(Ref to T) Converts to referenced type, returning the stored reference. Declaration public static implicit operator T(Ref self) Parameters Type Name Description Ref self the object to be de-referenced Returns Type Description T the value referenced by the object Implements System.IComparable System.IComparable 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.Utilities.Extensions.html": {
+ "href": "api/IPA.Utilities.Extensions.html",
+ "title": "Class Extensions",
+ "keywords": "Class Extensions A class providing various extension methods. Inheritance Object Extensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class Extensions Methods | Improve this Doc View Source GetDefault(Type) Gets the default value for a given Type . Declaration public static object GetDefault(this Type type) Parameters Type Name Description Type type the Type to get the default value for Returns Type Description Object the default value of type | Improve this Doc View Source IsSubPathOf(String, String) Returns true if path starts with the path baseDirPath . The comparison is case-insensitive, handles / and \\ slashes as folder separators and only matches if the base dir folder name is matched exactly (\"c:\\foobar\\file.txt\" is not a sub path of \"c:\\foo\"). Declaration public static bool IsSubPathOf(this string path, string baseDirPath) Parameters Type Name Description String path String baseDirPath Returns Type Description Boolean | Improve this Doc View Source Right(String, Int32) Gets the rightmost length characters from a string. Declaration public static string Right(this string value, int length) Parameters Type Name Description String value The string to retrieve the substring from. Int32 length The number of characters to retrieve. Returns Type Description String The substring. | Improve this Doc View Source Unwrap(Nullable) Unwraps a Nullable where T is Boolean such that if the value is null, it gives false . Declaration public static bool Unwrap(this bool? self) Parameters Type Name Description Nullable < Boolean > self the bool? to unwrap Returns Type Description Boolean the unwrapped value, or false if it was null | Improve this Doc View Source WithEnding(String, String) Returns str with the minimal concatenation of ending (starting from end) that results in satisfying .EndsWith(ending). Declaration public static string WithEnding(this string str, string ending) Parameters Type Name Description String str String ending Returns Type Description String Examples \"hel\".WithEnding(\"llo\") returns \"hello\", which is the result of \"hel\" + \"lo\"."
+ },
+ "api/IPA.Utilities.EnumerableExtensions.html": {
+ "href": "api/IPA.Utilities.EnumerableExtensions.html",
+ "title": "Class EnumerableExtensions",
+ "keywords": "Class EnumerableExtensions Extensions for IEnumerable that don't currently exist in System.Linq . Inheritance Object EnumerableExtensions Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class EnumerableExtensions Methods | Improve this Doc View Source Append(IEnumerable, T) Adds a value to the end of the sequence. Declaration public static IEnumerable Append(this IEnumerable seq, T app) Parameters Type Name Description IEnumerable seq a sequence of values T app the value to append to seq Returns Type Description IEnumerable a new sequence ending with app Type Parameters Name Description T the type of the elements of seq | Improve this Doc View Source NonNull(IEnumerable) LINQ extension method that filters null elements out of an enumeration. Declaration public static IEnumerable NonNull(this IEnumerable self) where T : class Parameters Type Name Description IEnumerable self the enumeration to filter Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the type of the enumeration | Improve this Doc View Source NonNull(IEnumerable>) LINQ extension method that filters null elements from an enumeration of nullable types. Declaration public static IEnumerable NonNull(this IEnumerable self) where T : struct Parameters Type Name Description IEnumerable < Nullable > self the enumeration to filter Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the underlying type of the nullable enumeration | Improve this Doc View Source NonNull(IEnumerable, Func) LINQ extension method that filters null elements out of an enumeration based on a converter. Declaration public static IEnumerable NonNull(this IEnumerable self, Func pred) where U : class Parameters Type Name Description IEnumerable self the enumeration to filter Func pred the predicate to select for filtering Returns Type Description IEnumerable a filtered enumerable Type Parameters Name Description T the type of the enumeration U the type to compare to null | Improve this Doc View Source Prepend(IEnumerable, T) Adds a value to the beginning of the sequence. Declaration public static IEnumerable Prepend(this IEnumerable seq, T prep) Parameters Type Name Description IEnumerable seq a sequence of values T prep the value to prepend to seq Returns Type Description IEnumerable a new sequence beginning with prep Type Parameters Name Description T the type of the elements of seq"
+ },
+ "api/IPA.Utilities.CriticalSection.html": {
+ "href": "api/IPA.Utilities.CriticalSection.html",
+ "title": "Class CriticalSection",
+ "keywords": "Class CriticalSection Provides utilities for managing various critical sections. Inheritance Object CriticalSection Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class CriticalSection Methods | Improve this Doc View Source EnterExecuteSection() Enters a critical execution section. Does not nest. Declaration public static void EnterExecuteSection() | Improve this Doc View Source EnterGCSection() Enters a GC critical section. Each call to this must be paired with a call to ExitGCSection() . Declaration public static void EnterGCSection() | Improve this Doc View Source ExitExecuteSection() Exits a critical execution section. Does not nest. Declaration public static void ExitExecuteSection() | Improve this Doc View Source ExitGCSection() Exits a GC critical section. Each call to this must have a preceding call to EnterGCSection() . Declaration public static void ExitGCSection()"
+ },
+ "api/IPA.Utilities.BeatSaber.html": {
+ "href": "api/IPA.Utilities.BeatSaber.html",
+ "title": "Class BeatSaber",
+ "keywords": "Class BeatSaber Provides some basic utility methods and properties of Beat Saber Inheritance Object BeatSaber Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public static class BeatSaber Properties | Improve this Doc View Source GameVersion Provides the current game version. Declaration public static AlmostVersion GameVersion { get; } Property Value Type Description AlmostVersion the SemVer version of the game | Improve this Doc View Source InstallPath Gets the path to the Beat Saber install directory. Declaration public static string InstallPath { get; } Property Value Type Description String the path of the game install directory | Improve this Doc View Source LibraryPath The path to the Libs folder. Use only if necessary. Declaration public static string LibraryPath { get; } Property Value Type Description String the path to the library directory | Improve this Doc View Source NativeLibraryPath The path to the Libs\\Native folder. Use only if necessary. Declaration public static string NativeLibraryPath { get; } Property Value Type Description String the path to the native library directory | Improve this Doc View Source PluginsPath The directory to load plugins from. Declaration public static string PluginsPath { get; } Property Value Type Description String the path to the plugin directory | Improve this Doc View Source ReleaseType Gets the BeatSaber.Release type of this installation of Beat Saber Declaration public static BeatSaber.Release ReleaseType { get; } Property Value Type Description BeatSaber.Release the type of release this is | Improve this Doc View Source UserDataPath The path to the UserData folder. Declaration public static string UserDataPath { get; } Property Value Type Description String the path to the user data directory"
+ },
+ "api/IPA.Utilities.BeatSaber.Release.html": {
+ "href": "api/IPA.Utilities.BeatSaber.Release.html",
+ "title": "Enum BeatSaber.Release",
+ "keywords": "Enum BeatSaber.Release The different types of releases of the game. Namespace : IPA.Utilities Assembly : IPA.Loader.dll Syntax public enum Release Fields Name Description Oculus Indicates an Oculus release. Steam Indicates a Steam release. Extension Methods ReflectionUtil.SetField(String, Object) ReflectionUtil.SetField(String, Object) ReflectionUtil.GetField(String) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[])"
+ },
+ "api/IPA.Utilities.Async.html": {
+ "href": "api/IPA.Utilities.Async.html",
"title": "",
- "keywords": "Classes MarkdownView A UI component that renders CommonMark Markdown in-game."
+ "keywords": "Classes SingleThreadTaskScheduler A single-threaded task scheduler that runs all of its tasks on the same thread. Synchronization Utilities for inter-thread synchronization. All Locker method acquire their object immediately, and should only be used with langword_csharp_using to automatically release them. Structs Synchronization.MutexLocker A locker for a Mutex that automatically releases when it is disposed. Create this with Lock(Mutex) . Synchronization.ReaderWriterLockSlimReadLocker A locker for a read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockRead(ReaderWriterLockSlim) . Synchronization.ReaderWriterLockSlimUpgradableReadLocker A locker for an upgradable read lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockReadUpgradable(ReaderWriterLockSlim) . Synchronization.ReaderWriterLockSlimWriteLocker A locker for a write lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockWrite(ReaderWriterLockSlim) . Synchronization.SemaphoreLocker A locker for a Semaphore that automatically releases when it is disposed. Create this with Lock(Semaphore) . Synchronization.SemaphoreSlimAsyncLocker A locker for a SemaphoreSlim that was created asynchronously and automatically releases when it is disposed. Create this with LockAsync(SemaphoreSlim) . Synchronization.SemaphoreSlimLocker A locker for a SemaphoreSlim that automatically releases when it is disposed. Create this with Lock(SemaphoreSlim) ."
},
"api/IPA.OnEnableAttribute.html": {
"href": "api/IPA.OnEnableAttribute.html",
@@ -19,6 +64,121 @@
"title": "",
"keywords": "Interfaces IEnhancedPlugin An enhanced version of the standard IPA plugin. IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed in Plugins."
},
+ "api/IPA.Logging.Printers.html": {
+ "href": "api/IPA.Logging.Printers.html",
+ "title": "",
+ "keywords": "Classes ColoredConsolePrinter Prints a pretty message to the console. ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. GlobalLogFilePrinter A printer for all messages to a unified log location. GZFilePrinter A LogPrinter abstract class that provides the utilities to write to a GZip file. PluginLogFilePrinter Prints log messages to the file specified by the name. PluginSubLogPrinter Prints log messages to the file specified by the name."
+ },
+ "api/IPA.Logging.Printers.PluginSubLogPrinter.html": {
+ "href": "api/IPA.Logging.Printers.PluginSubLogPrinter.html",
+ "title": "Class PluginSubLogPrinter",
+ "keywords": "Class PluginSubLogPrinter Prints log messages to the file specified by the name. Inheritance Object LogPrinter GZFilePrinter PluginSubLogPrinter 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 PluginSubLogPrinter : GZFilePrinter, IDisposable Constructors | Improve this Doc View Source PluginSubLogPrinter(String, String) Creates a new printer with the given name. Declaration public PluginSubLogPrinter(string mainname, string name) Parameters Type Name Description String mainname the name of the main logger 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 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.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.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.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.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.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.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.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.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.SetField(String, Object) ReflectionUtil.GetField(String) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(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.SetField(String, Object) ReflectionUtil.GetField(String) ReflectionUtil.GetField(String) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.SetProperty(String, Object) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(String, Object[]) ReflectionUtil.InvokeMethod(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, 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. PluginMetadata meta the 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.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.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(PluginMetadata) or BeforeInit(PluginMetadata) 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(PluginMetadata) 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(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin that was just initialized | Improve this Doc View Source AfterInit(PluginMetadata, Object) 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(PluginMetadata plugin, object pluginInstance) Parameters Type Name Description PluginMetadata plugin the plugin that was just initialized Object pluginInstance the instance of the plugin being initialized | Improve this Doc View Source BeforeInit(PluginMetadata) 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(PluginMetadata plugin) Parameters Type Name Description PluginMetadata plugin the plugin to be initialized Returns Type Description Boolean whether or not to call the Init method | Improve this Doc View Source BeforeLoad(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(PluginMetadata plugin) Parameters Type Name Description 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(PluginMetadata, String[]) Declaration public virtual bool Evaluate() Returns Type Description Boolean the truthiness of the Feature. | Improve this Doc View Source Initialize(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(PluginMetadata meta, string[] parameters) Parameters Type Name Description 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(PluginMetadata) Ensures a plugin's assembly is loaded. Do not use unless you need to. Declaration protected void RequireLoaded(PluginMetadata plugin) Parameters Type Name Description 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.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.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.CustomObjectConverter-1.html": {
+ "href": "api/IPA.Config.Stores.Converters.CustomObjectConverter-1.html",
+ "title": "Class CustomObjectConverter",
+ "keywords": "Class CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . Inheritance Object ValueConverter CustomObjectConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class CustomObjectConverter : ValueConverter, IValueConverter where T : class Type Parameters Name Description T the same type parameter that would be passed into Generated(Config, Boolean) Methods | Improve this Doc View Source Deserialize(Value, Object) Deserializes value into a T with the given parent . Declaration public static T Deserialize(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the parent object that will own the deserialized value Returns Type Description T the deserialized value See Also FromValue ( Value , Object ) | Improve this Doc View Source FromValue(Value, Object) Deserializes value into a T with the given parent . Declaration public override T FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the parent object that will own the deserialized value Returns Type Description T the deserialized value Overrides IPA.Config.Stores.ValueConverter.FromValue(IPA.Config.Data.Value, System.Object) See Also FromValue ( Value , Object ) | Improve this Doc View Source Serialize(T, Object) Serializes obj into a Value structure, given parent . Declaration public static Value Serialize(T obj, object parent) Parameters Type Name Description T obj the object to serialize Object parent the parent object that owns obj Returns Type Description Value the Value tree that represents obj See Also ToValue (T, Object ) | Improve this Doc View Source ToValue(T, Object) Serializes obj into a Value structure, given parent . Declaration public override Value ToValue(T obj, object parent) Parameters Type Name Description T obj the object to serialize Object parent the parent object that owns obj Returns Type Description Value the Value tree that represents obj Overrides IPA.Config.Stores.ValueConverter.ToValue(T, System.Object) See Also ToValue (T, Object ) Implements IValueConverter 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 Generated ( Config , Boolean )"
+ },
+ "api/IPA.Config.Stores.Converters.CollectionConverter-3.html": {
+ "href": "api/IPA.Config.Stores.Converters.CollectionConverter-3.html",
+ "title": "Class CollectionConverter",
+ "keywords": "Class CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Inheritance Object ValueConverter CollectionConverter CollectionConverter Implements IValueConverter Inherited Members CollectionConverter.BaseConverter CollectionConverter.Create(Int32, Object) CollectionConverter.PopulateFromValue(TCollection, List, Object) CollectionConverter.FromValue(Value, Object) CollectionConverter.ToValue(TCollection, Object) ValueConverter.ToValue(TCollection, Object) ValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public sealed class CollectionConverter : CollectionConverter, IValueConverter where TCollection : ICollection where TConverter : ValueConverter, new() Type Parameters Name Description T the value type of the collection TCollection the type of the colleciton TConverter the type of the converter to use for T Constructors | Improve this Doc View Source CollectionConverter() Creates a CollectionConverter using a default constructed TConverter element type. Equivalent to calling CollectionConverter(ValueConverter) with a default-constructed TConverter . Declaration public CollectionConverter() See Also CollectionConverter(ValueConverter) Implements IValueConverter 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 CollectionConverter "
+ },
+ "api/IPA.Config.Stores.Converters.CollectionConverter-2.html": {
+ "href": "api/IPA.Config.Stores.Converters.CollectionConverter-2.html",
+ "title": "Class CollectionConverter",
+ "keywords": "Class CollectionConverter A base class for all ICollection type converters, providing most of the functionality. Inheritance Object ValueConverter CollectionConverter CollectionConverter IListConverter ISetConverter ListConverter Implements IValueConverter Inherited Members ValueConverter.IValueConverter.ToValue(Object, Object) ValueConverter.IValueConverter.FromValue(Value, Object) ValueConverter.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class CollectionConverter : ValueConverter, IValueConverter where TCollection : ICollection Type Parameters Name Description T the type of the items in the collection TCollection the instantiated type of collection Constructors | Improve this Doc View Source CollectionConverter() Creates a CollectionConverter using the default converter for the element type. Equivalent to calling CollectionConverter(ValueConverter) with Default . Declaration public CollectionConverter() See Also CollectionConverter(ValueConverter) | Improve this Doc View Source CollectionConverter(ValueConverter) Creates a CollectionConverter using the specified underlying converter. Declaration public CollectionConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the ValueConverter to use to convert the values Properties | Improve this Doc View Source BaseConverter Gets the converter for the collection's value type. Declaration protected ValueConverter BaseConverter { get; } Property Value Type Description ValueConverter