diff --git a/branch/4.0.0-beta/api/IPA.Config.Data.Text.html b/branch/4.0.0-beta/api/IPA.Config.Data.Text.html
index e8f2c6ef..2b22c55e 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Data.Text.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Data.Text.html
@@ -170,7 +170,7 @@ String is so that it doesn't conflict with Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html
index 8880dd60..69d7bbc8 100644
--- a/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.Config.Stores.Attributes.SerializedNameAttribute.html
@@ -276,7 +276,7 @@ However, if we were to add a Improve this Doc
- View Source
+ View Source
diff --git a/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 ca6ebeea..894cb582 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
@@ -172,7 +172,7 @@ to use as the underlying converter. Use this in the Improve this Doc
- View Source
+ View Source
NullableConverter()
@@ -237,7 +237,7 @@ to use as the underlying converter. Use this in the Improve this Doc
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 c6e901da..61fbe18a 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
@@ -117,7 +117,7 @@ Converters do not need to perform null checks, as the serializer and de
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
index 0b382f04..3b833f4e 100644
--- a/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
+++ b/branch/4.0.0-beta/api/IPA.Loader.PluginInitInjector.html
@@ -140,7 +140,7 @@ For all of the default injectors, only one of each will be generated, and any la
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html b/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html
index f675f396..9369c2b9 100644
--- a/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html
+++ b/branch/4.0.0-beta/api/IPA.Logging.StandardLogger.html
@@ -181,7 +181,7 @@ The modification of printers on a parent are reflected down the chain.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html b/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html
index 06c2560e..c62ea04f 100644
--- a/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.OnDisableAttribute.html
@@ -306,7 +306,7 @@ Typically, this will be used when the Improve this Doc
diff --git a/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html b/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html
index 0724b7b8..7758aabb 100644
--- a/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.OnEnableAttribute.html
@@ -306,7 +306,7 @@ Typically, this will be used when the Improve this Doc
diff --git a/branch/4.0.0-beta/api/IPA.OnExitAttribute.html b/branch/4.0.0-beta/api/IPA.OnExitAttribute.html
index 44ddc37c..b04fe0dd 100644
--- a/branch/4.0.0-beta/api/IPA.OnExitAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.OnExitAttribute.html
@@ -306,7 +306,7 @@ Typically, this will be used when the Improve this Doc
diff --git a/branch/4.0.0-beta/api/IPA.OnStartAttribute.html b/branch/4.0.0-beta/api/IPA.OnStartAttribute.html
index 2f4b650f..c2578ba7 100644
--- a/branch/4.0.0-beta/api/IPA.OnStartAttribute.html
+++ b/branch/4.0.0-beta/api/IPA.OnStartAttribute.html
@@ -306,7 +306,7 @@ Typically, this will be used when the Improve this Doc
diff --git a/branch/4.0.0-beta/api/IPA.RuntimeOptions.html b/branch/4.0.0-beta/api/IPA.RuntimeOptions.html
index 5f01a2ba..81b91020 100644
--- a/branch/4.0.0-beta/api/IPA.RuntimeOptions.html
+++ b/branch/4.0.0-beta/api/IPA.RuntimeOptions.html
@@ -186,7 +186,7 @@ With this option set, whether or not the plugin is disabled during a given run i
Improve this Doc
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 69234172..02a1f11d 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
@@ -126,7 +126,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -187,7 +187,7 @@ it is disposed. Create this with Improve this Doc
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 8cc418f6..10ff810e 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
@@ -126,7 +126,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.ReaderWriterLockSlimWriteLocker.html b/branch/4.0.0-beta/api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html
index 88bd1596..0b1ec8f7 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
@@ -126,7 +126,7 @@ it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -187,7 +187,7 @@ it is disposed. Create this with Improve this Doc
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 64f3ca06..191d143a 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
@@ -126,7 +126,7 @@ when it is disposed. Create this with Improve this Doc
- View Source
+ View Source
IDisposable.Dispose()
@@ -187,7 +187,7 @@ when it is disposed. Create this with Improve this Doc
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 339147e4..5072fb24 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
@@ -137,7 +137,7 @@ with whichever member you want to use, according to your lock type.
Improve this Doc
- View Source
+ View Source
diff --git a/branch/4.0.0-beta/api/index.html b/branch/4.0.0-beta/api/index.html
index aa6a5ed0..928bd45b 100644
--- a/branch/4.0.0-beta/api/index.html
+++ b/branch/4.0.0-beta/api/index.html
@@ -90,7 +90,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 77a25733..f36a656b 100644
--- a/branch/4.0.0-beta/articles/command-line.html
+++ b/branch/4.0.0-beta/articles/command-line.html
@@ -183,7 +183,7 @@ avaliable. If there is, it will be downloaded and installed on the next run. Thi
diff --git a/branch/4.0.0-beta/articles/contributing.html b/branch/4.0.0-beta/articles/contributing.html
index 22d0084e..a3ed9fc7 100644
--- a/branch/4.0.0-beta/articles/contributing.html
+++ b/branch/4.0.0-beta/articles/contributing.html
@@ -117,7 +117,7 @@ should reference the copy in there. When building for Release, it just uses the
diff --git a/branch/4.0.0-beta/articles/start-user.html b/branch/4.0.0-beta/articles/start-user.html
index 930257a5..4ad90696 100644
--- a/branch/4.0.0-beta/articles/start-user.html
+++ b/branch/4.0.0-beta/articles/start-user.html
@@ -161,7 +161,7 @@ the game directory, though your plugins will be moved to a different folder when
diff --git a/branch/4.0.0-beta/index.json b/branch/4.0.0-beta/index.json
index f98437e4..f75427c0 100644
--- a/branch/4.0.0-beta/index.json
+++ b/branch/4.0.0-beta/index.json
@@ -1,78 +1,93 @@
{
- "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html": {
- "href": "api/BSIPA_ModList.UI.ViewControllers.MarkdownView.html",
- "title": "Class MarkdownView",
- "keywords": "Class MarkdownView A UI component that renders CommonMark Markdown in-game. Inheritance Object UnityEngine.Object UnityEngine.Component UnityEngine.Behaviour UnityEngine.MonoBehaviour MarkdownView Inherited Members UnityEngine.MonoBehaviour.IsInvoking() UnityEngine.MonoBehaviour.CancelInvoke() UnityEngine.MonoBehaviour.Invoke(System.String, System.Single) UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single) UnityEngine.MonoBehaviour.CancelInvoke(System.String) UnityEngine.MonoBehaviour.IsInvoking(System.String) UnityEngine.MonoBehaviour.StartCoroutine(System.String) UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object) UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator) UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine) UnityEngine.MonoBehaviour.StopCoroutine(System.String) UnityEngine.MonoBehaviour.StopAllCoroutines() UnityEngine.MonoBehaviour.print(System.Object) UnityEngine.MonoBehaviour.useGUILayout UnityEngine.Behaviour.enabled UnityEngine.Behaviour.isActiveAndEnabled UnityEngine.Component.GetComponent(System.Type) UnityEngine.Component.GetComponent() UnityEngine.Component.GetComponent(System.String) UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentInChildren(System.Type) UnityEngine.Component.GetComponentInChildren(System.Boolean) UnityEngine.Component.GetComponentInChildren() UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Type) UnityEngine.Component.GetComponentsInChildren(System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Boolean, System.Collections.Generic.List) UnityEngine.Component.GetComponentsInChildren() UnityEngine.Component.GetComponentsInChildren(System.Collections.Generic.List) UnityEngine.Component.GetComponentInParent(System.Type) UnityEngine.Component.GetComponentInParent() UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Type) UnityEngine.Component.GetComponentsInParent(System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Boolean, System.Collections.Generic.List) UnityEngine.Component.GetComponentsInParent() UnityEngine.Component.GetComponents(System.Type) UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List) UnityEngine.Component.GetComponents(System.Collections.Generic.List) UnityEngine.Component.GetComponents() UnityEngine.Component.CompareTag(System.String) UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessageUpwards(System.String, System.Object) UnityEngine.Component.SendMessageUpwards(System.String) UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessage(System.String, System.Object) UnityEngine.Component.SendMessage(System.String) UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions) UnityEngine.Component.BroadcastMessage(System.String, System.Object) UnityEngine.Component.BroadcastMessage(System.String) UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions) UnityEngine.Component.transform UnityEngine.Component.gameObject UnityEngine.Component.tag UnityEngine.Object.GetInstanceID() UnityEngine.Object.GetHashCode() UnityEngine.Object.Equals(System.Object) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate(UnityEngine.Object) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform) UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean) UnityEngine.Object.Instantiate(T) UnityEngine.Object.Instantiate(T, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate(T, UnityEngine.Transform) UnityEngine.Object.Instantiate(T, UnityEngine.Transform, System.Boolean) UnityEngine.Object.Destroy(UnityEngine.Object, System.Single) UnityEngine.Object.Destroy(UnityEngine.Object) UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean) UnityEngine.Object.DestroyImmediate(UnityEngine.Object) UnityEngine.Object.FindObjectsOfType(System.Type) UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object) UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single) UnityEngine.Object.DestroyObject(UnityEngine.Object) UnityEngine.Object.FindSceneObjectsOfType(System.Type) UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type) UnityEngine.Object.FindObjectsOfType() UnityEngine.Object.FindObjectOfType() UnityEngine.Object.FindObjectsOfTypeAll(System.Type) UnityEngine.Object.FindObjectOfType(System.Type) UnityEngine.Object.ToString() UnityEngine.Object.name UnityEngine.Object.hideFlags Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : BSIPA_ModList.UI.ViewControllers Assembly : BSIPA-ModList.dll Syntax [RequireComponent(typeof(RectTransform))] public class MarkdownView : MonoBehaviour Constructors | Improve this Doc View Source MarkdownView() Creates a new MarkdownView . Should never be called directly. Instead, use UnityEngine.GameObject.AddComponent``1 . Declaration public MarkdownView() Fields | Improve this Doc View Source HasEmbeddedImage This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly. Declaration public Func HasEmbeddedImage Field Value Type Description Func < String , Boolean > a delegate for the function to call Properties | Improve this Doc View Source Markdown The text to be rendered. Declaration public string Markdown { get; set; } Property Value Type Description String the text to render as Markdown Remarks When this is assigned, the object is marked dirty. It will re-render on the next Update tick. | Improve this Doc View Source rectTransform A convenience property to access the UnityEngine.RectTransform on the UnityEngine.GameObject this is on. Declaration public RectTransform rectTransform { get; } Property Value Type Description UnityEngine.RectTransform the UnityEngine.RectTransform associated with this component 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[]) ReflectionUtil.CopyComponent(Component, Type, GameObject, Type) ReflectionUtil.CopyComponent(Component, GameObject, Type)"
- },
- "api/IPA.html": {
- "href": "api/IPA.html",
+ "api/IPA.Logging.Printers.html": {
+ "href": "api/IPA.Logging.Printers.html",
"title": "",
- "keywords": "Classes InitAttribute Marks a method or a constructor as an inialization method. OnDisableAttribute Indicates that the target method should be called when the plugin is disabled. OnEnableAttribute Indicates that the target method should be called when the plugin is enabled. OnExitAttribute Indicates that the target method should be called when the game exits. OnStartAttribute Indicates that the target method should be called when the game starts. PluginAttribute Marks a class as being a BSIPA plugin. Enums RuntimeOptions Options that a plugin must specify to describe how it expects to be run."
+ "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.Utilities.html": {
- "href": "api/IPA.Utilities.html",
+ "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.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.html": {
+ "href": "api/IPA.Loader.html",
"title": "",
- "keywords": "Classes AlmostVersion A type that wraps SemVer.Version so that the string of the version is stored when the string is not a valid SemVer.Version . AlmostVersionConverter A ValueConverter for AlmostVersion s. CriticalSection Provides utilities for managing various critical sections. EnumerableExtensions Extensions for IEnumerable that don't currently exist in System.Linq . Extensions A class providing various extension methods. Ref Utilities to create Ref using type inference. Ref A class to store a reference for passing to methods which cannot take ref parameters. ReflectionUtil A utility class providing reflection helper methods. UnityGame Provides some basic utility methods and properties of Beat Saber Utils A class providing static utility functions that in any other language would just exist . Enums AlmostVersion.StoredAs Represents a storage type of either parsed SemVer.Version object or raw String . UnityGame.Release The different types of releases of the game."
+ "keywords": "Classes PluginInitInjector The type that handles value injecting into a plugin's initialization methods. PluginManager The manager class for all plugins. PluginMetadata A class which describes a loaded plugin. StateTransitionTransaction Delegates PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event."
},
- "api/IPA.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(Version, Version) Compares a pair of SemVer.Version s ignoring both the prerelease and build fields. Declaration public static int VersionCompareNoPrerelease(Version l, 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.Loader.StateTransitionTransaction.html": {
+ "href": "api/IPA.Loader.StateTransitionTransaction.html",
+ "title": "Class StateTransitionTransaction",
+ "keywords": "Class StateTransitionTransaction Inheritance Object StateTransitionTransaction Implements IDisposable Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public sealed class StateTransitionTransaction : IDisposable Properties | Improve this Doc View Source DisabledPlugins Declaration public IEnumerable DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > | Improve this Doc View Source EnabledPlugins Declaration public IEnumerable EnabledPlugins { get; } Property Value Type Description IEnumerable < PluginMetadata > | Improve this Doc View Source WillNeedRestart Declaration public bool WillNeedRestart { get; } Property Value Type Description Boolean Methods | Improve this Doc View Source Commit() Declaration public Task Commit() Returns Type Description Task | Improve this Doc View Source Disable(PluginMetadata) Declaration public bool Disable(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta Returns Type Description Boolean | Improve this Doc View Source Dispose() Declaration public void Dispose() | Improve this Doc View Source Enable(PluginMetadata) Declaration public bool Enable(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta Returns Type Description Boolean | Improve this Doc View Source IsDisabled(PluginMetadata) Declaration public bool IsDisabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta Returns Type Description Boolean | Improve this Doc View Source IsEnabled(PluginMetadata) Declaration public bool IsEnabled(PluginMetadata meta) Parameters Type Name Description PluginMetadata meta Returns Type Description Boolean 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.Utilities.UnityGame.html": {
- "href": "api/IPA.Utilities.UnityGame.html",
- "title": "Class UnityGame",
- "keywords": "Class UnityGame Provides some basic utility methods and properties of Beat Saber Inheritance Object UnityGame 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 UnityGame 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 UnityGame.Release type of this installation of Beat Saber Declaration public static UnityGame.Release ReleaseType { get; } Property Value Type Description UnityGame.Release the type of release this is Remarks This only gives a | 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.Loader.PluginInitInjector.html": {
+ "href": "api/IPA.Loader.PluginInitInjector.html",
+ "title": "Class PluginInitInjector",
+ "keywords": "Class PluginInitInjector The type that handles value injecting into a plugin's initialization methods. Inheritance Object PluginInitInjector Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginInitInjector 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 | Improve this Doc View Source AddInjector(Type, PluginInitInjector.InjectParameter) Adds an injector to be used when calling future plugins' Init methods. Declaration public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector) Parameters Type Name Description Type type the type of the parameter. PluginInitInjector.InjectParameter injector the function to call for injection."
},
- "api/IPA.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.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.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.Loader.Features.html": {
+ "href": "api/IPA.Loader.Features.html",
+ "title": "",
+ "keywords": "Classes Feature The root interface for a mod Feature."
},
- "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.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.Utilities.Async.html": {
- "href": "api/IPA.Utilities.Async.html",
+ "api/IPA.InitAttribute.html": {
+ "href": "api/IPA.InitAttribute.html",
+ "title": "Class InitAttribute",
+ "keywords": "Class InitAttribute Marks a method or a constructor as an inialization method. Inheritance Object Attribute InitAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Constructor | AttributeTargets.Method, AllowMultiple = false, Inherited = false)] public sealed class InitAttribute : Attribute, _Attribute Remarks If more than one constructor is marked with this attribute, the one with the most parameters, whether or not they can be injected, will be used. Parameter injection is done with PluginInitInjector . Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) See Also PluginAttribute PluginInitInjector"
+ },
+ "api/IPA.Config.html": {
+ "href": "api/IPA.Config.html",
"title": "",
- "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) ."
+ "keywords": "Classes Config 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. Config.PreferAttribute Specifies that a particular parameter is preferred to use a particular IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. ConfigProvider A wrapper for an IConfigProvider and the FileInfo to use with it. ModPrefs Allows to get and set preferences for your mod. Interfaces IConfigProvider An interface for configuration providers. IConfigStore A storage for a config structure. IModPrefs Allows to get and set preferences for your mod."
},
- "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html": {
- "href": "api/IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html",
- "title": "Struct Synchronization.ReaderWriterLockSlimWriteLocker",
- "keywords": "Struct Synchronization.ReaderWriterLockSlimWriteLocker A locker for a write lock on a ReaderWriterLockSlim that automatically releases when it is disposed. Create this with LockWrite(ReaderWriterLockSlim) . Implements IDisposable Inherited Members ValueType.Equals(Object) ValueType.GetHashCode() ValueType.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Namespace : IPA.Utilities.Async Assembly : IPA.Loader.dll Syntax public struct ReaderWriterLockSlimWriteLocker : IDisposable Explicit Interface Implementations | Improve this Doc View Source IDisposable.Dispose() Declaration void IDisposable.Dispose() Implements System.IDisposable Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField(Object, String) ReflectionUtil.GetField(U, String) ReflectionUtil.SetProperty(Object, String, Object) ReflectionUtil.SetProperty(T, String, Object) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(T, String, Object[]) ReflectionUtil.InvokeMethod(Object, String, Object[]) ReflectionUtil.InvokeMethod(U, String, Object[]) See Also Synchronization LockWrite(ReaderWriterLockSlim)"
+ "api/IPA.Config.Stores.IValueConverter.html": {
+ "href": "api/IPA.Config.Stores.IValueConverter.html",
+ "title": "Interface IValueConverter",
+ "keywords": "Interface IValueConverter The base interface for a value converter for use by objects generated by Generated(Config, Boolean) . Namespace : IPA.Config.Stores Assembly : IPA.Loader.dll Syntax public interface IValueConverter Remarks The object returned from FromValue(Value, Object) , if fed into ToValue(Object, Object) , should return equivalent Value structures. Similarly, if the result of ToValue(Object, Object) is fed into FromValue(Value, Object) , the resulting object should be equivalent to the one passed to ToValue(Object, Object) . The parent parameter to ToValue(Object, Object) and FromValue(Value, Object) should be (ideally) the the top of the serialization tree, or some other generated object in that tree, rather than some arbitrary object in the middle that is not managed by the generatd config system. Converters do not need to perform null checks, as the serializer and deserializer will do that automatically. Properties | Improve this Doc View Source Type Gets the type that this IValueConverter handles. Declaration Type Type { get; } Property Value Type Description Type Methods | Improve this Doc View Source FromValue(Value, Object) Converts the given Value to the object type handled by this converter. Declaration object FromValue(Value value, object parent) Parameters Type Name Description Value value the Value to deserialize Object parent the object that will own the result Returns Type Description Object the deserialized object | Improve this Doc View Source ToValue(Object, Object) Converts the given object to a Value . Declaration Value ToValue(object obj, object parent) Parameters Type Name Description Object obj the object to convert Object parent the owning object of obj Returns Type Description Value a representation of obj as a Value structure 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.GeneratedExtension.html": {
+ "href": "api/IPA.Config.Stores.GeneratedExtension.html",
+ "title": "Class GeneratedExtension",
+ "keywords": "Class GeneratedExtension A class providing an extension for Config to make it easy to use generated config stores. Inheritance Object GeneratedExtension Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores Assembly : IPA.Loader.dll Syntax public static class GeneratedExtension Fields | Improve this Doc View Source AssemblyVisibilityTarget The name of the assembly that internals must be visible to to allow internal protection. Declaration public const string AssemblyVisibilityTarget = \"IPA.Config.Generated\" Field Value Type Description String Methods | Improve this Doc View Source Generated(Config, Boolean) Creates a generated IConfigStore of type T , registers it to the Config object, and returns it. This also forces a synchronous config load via LoadSync() if loadSync is true . Declaration public static T Generated(this Config cfg, bool loadSync = true) where T : class Parameters Type Name Description Config cfg the Config to register to Boolean loadSync whether to synchronously load the content, or trigger an async load Returns Type Description T a generated instance of T as a special IConfigStore Type Parameters Name Description T the type to wrap Remarks T must be a public non- sealed class. It can also be internal, but in that case, then your assembly must have the following attribute to allow the generated code to reference it. [assembly: InternalsVisibleTo(IPA.Config.Stores.GeneratedExtension.AssemblyVisibilityTarget)] Only fields and properties that are public or protected will be considered, and only properties where both the getter and setter are public or protected are considered. Any fields or properties with an IgnoreAttribute applied to them are also ignored. Having properties be virtual is not strictly necessary, however it allows the generated type to keep track of changes and lock around them so that the config will auto-save. All of the attributes in the IPA.Config.Stores.Attributes namespace are handled as described by them. If the T declares a public or protected, virtual method Changed() , then that method may be called to artificially signal to the runtime that the content of the object has changed. That method will also be called after the write locks are released when a property is set anywhere in the owning tree. This will only be called on the outermost generated object of the config structure, even if the change being signaled is somewhere deep into the tree. TODO: is this a good idea? Similarly, T can declare a public or protected, virtual method OnReload() , which will be called on the filesystem reader thread after the object has been repopulated with new data values. It will be called after the write lock for this object is released. This will only be called on the outermost generated object of the config structure. TODO: describe details of generated stores"
+ },
+ "api/IPA.Config.Stores.Converters.html": {
+ "href": "api/IPA.Config.Stores.Converters.html",
+ "title": "",
+ "keywords": "Classes CollectionConverter A base class for all ICollection type converters, providing most of the functionality. CollectionConverter A CollectionConverter which default constructs a converter for use as the value converter. Converter Provides utility functions for custom converters. Converter Provides generic utilities for converters for certain types. CustomObjectConverter A ValueConverter for objects normally serialized to config via Generated(Config, Boolean) . IListConverter A CollectionConverter for an IList , creating a List when deserializing. IListConverter An IListConverter which default constructs a converter for use as the value converter. ISetConverter A CollectionConverter for an ISet , creating a HashSet when deserializing. ISetConverter An ISetConverter which default constructs a converter for use as the value converter. ListConverter A CollectionConverter for a List . ListConverter A ListConverter which default constructs a converter for use as the value converter. NullableConverter A converter for a Nullable . NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute ."
},
"api/IPA.Config.Stores.Converters.NullableConverter-2.html": {
"href": "api/IPA.Config.Stores.Converters.NullableConverter-2.html",
"title": "Class NullableConverter",
"keywords": "Class NullableConverter A converter for a Nullable that default-constructs a converter of type TConverter to use as the underlying converter. Use this in the UseConverterAttribute . Inheritance Object ValueConverter < Nullable > NullableConverter NullableConverter Implements IValueConverter Inherited Members NullableConverter.FromValue(Value, Object) NullableConverter.ToValue(Nullable, 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 NullableConverter : NullableConverter, IValueConverter where T : struct where TConverter : ValueConverter, new() Type Parameters Name Description T the underlying type of the Nullable TConverter the type to use as an underlying converter Constructors | Improve this Doc View Source NullableConverter() Creates a converter with a new TConverter as the underlying converter. Declaration public NullableConverter() See Also NullableConverter(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 NullableConverter "
},
- "api/IPA.Config.Stores.Converters.ListConverter-1.html": {
- "href": "api/IPA.Config.Stores.Converters.ListConverter-1.html",
- "title": "Class ListConverter",
- "keywords": "Class ListConverter A CollectionConverter for a List . Inheritance Object ValueConverter < List > CollectionConverter > ListConverter ListConverter Implements IValueConverter Inherited Members CollectionConverter>.BaseConverter CollectionConverter>.Create(Int32, Object) CollectionConverter>.PopulateFromValue(List, List, Object) CollectionConverter>.FromValue(Value, Object) CollectionConverter>.ToValue(List, Object) ValueConverter>.ToValue(List, Object) ValueConverter>.FromValue(Value, Object) ValueConverter>.IValueConverter.ToValue(Object, Object) ValueConverter>.IValueConverter.FromValue(Value, Object) ValueConverter>.IValueConverter.Type Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config.Stores.Converters Assembly : IPA.Loader.dll Syntax public class ListConverter : CollectionConverter>, IValueConverter Type Parameters Name Description T the element type of the List Constructors | Improve this Doc View Source ListConverter() Creates an ListConverter using the default converter for T . Declaration public ListConverter() See Also CollectionConverter() | Improve this Doc View Source ListConverter(ValueConverter) Creates an ListConverter using the specified underlying converter for values. Declaration public ListConverter(ValueConverter underlying) Parameters Type Name Description ValueConverter underlying the underlying ValueConverter to use for the values Methods | Improve this Doc View Source Create(Int32, Object) Creates a new List for deserialization. Declaration protected override List Create(int size, object parent) Parameters Type Name Description Int32 size the size to initialize it to Object parent the object that will own the new object Returns Type Description List the new List Overrides IPA.Config.Stores.Converters.CollectionConverter>.Create(System.Int32, System.Object) Implements IValueConverter Extension Methods ReflectionUtil.SetField(Object, String, Object) ReflectionUtil.SetField(T, String, Object) ReflectionUtil.GetField