You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
277 lines
113 KiB
277 lines
113 KiB
{
|
|
"api/IPA.Config.IModPrefs.html": {
|
|
"href": "api/IPA.Config.IModPrefs.html",
|
|
"title": "Interface IModPrefs",
|
|
"keywords": "Interface IModPrefs Allows to get and set preferences for your mod. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [Obsolete(\"Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.\")] public interface IModPrefs Methods | Improve this Doc View Source GetBool(String, String, Boolean, Boolean) Gets a bool from the ini. Declaration bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Boolean | Improve this Doc View Source GetFloat(String, String, Single, Boolean) Gets a float from the ini. Declaration float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Single defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Single | Improve this Doc View Source GetInt(String, String, Int32, Boolean) Gets an int from the ini. Declaration int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Int32 | Improve this Doc View Source GetString(String, String, String, Boolean) Gets a string from the ini. Declaration string GetString(string section, string name, string defaultValue = \"\", bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. String defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description String | Improve this Doc View Source HasKey(String, String) Checks whether or not a key exists in the ini. Declaration bool HasKey(string section, string name) Parameters Type Name Description String section Section of the key. String name Name of the key. Returns Type Description Boolean | Improve this Doc View Source SetBool(String, String, Boolean) Sets a bool in the ini. Declaration void SetBool(string section, string name, bool value) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean value Value that should be written. | Improve this Doc View Source SetFloat(String, String, Single) Sets a float in the ini. Declaration void SetFloat(string section, string name, float value) Parameters Type Name Description String section Section of the key. String name Name of the key. Single value Value that should be written. | Improve this Doc View Source SetInt(String, String, Int32) Sets an int in the ini. Declaration void SetInt(string section, string name, int value) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 value Value that should be written. | Improve this Doc View Source SetString(String, String, String) Sets a string in the ini. Declaration void SetString(string section, string name, string value) Parameters Type Name Description String section Section of the key. String name Name of the key. String value Value that should be written. Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Config.Config.html": {
|
|
"href": "api/IPA.Config.Config.html",
|
|
"title": "Class Config",
|
|
"keywords": "Class Config A class to handle updating ConfigProviders automatically Inheritance Object Config Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public static class Config Methods | Improve this Doc View Source GetProviderFor(String, String[]) Gets an IConfigProvider using the specified list of preferred config types. Declaration public static IConfigProvider GetProviderFor(string configName, params string[] extensions) Parameters Type Name Description String configName the name of the mod for this config String [] extensions the preferred config types to try to get Returns Type Description IConfigProvider an IConfigProvider of the requested type, or of type JSON. | Improve this Doc View Source MakeLink<T>(IConfigProvider, Action<IConfigProvider, Ref<T>>) Creates a linked Ref<T> for the config provider. This Ref<T> will be automatically updated whenever the file on-disk changes. Declaration public static Ref<T> MakeLink<T>(this IConfigProvider config, Action<IConfigProvider, Ref<T>> onChange = null) Parameters Type Name Description IConfigProvider config the IConfigProvider to create a link to Action < IConfigProvider , Ref <T>> onChange an action to perform on value change Returns Type Description Ref <T> a Ref<T> to an ever-changing value, mirroring whatever the file contains. Type Parameters Name Description T the type of the parsed value | Improve this Doc View Source Register(Type) Registers a IConfigProvider to use for configs. Declaration public static void Register(Type type) Parameters Type Name Description Type type the type to register | Improve this Doc View Source Register<T>() Registers a IConfigProvider to use for configs. Declaration public static void Register<T>() where T : IConfigProvider Type Parameters Name Description T the type to register | Improve this Doc View Source RemoveLinks(IConfigProvider) Removes all linked Ref<T> such that they are no longer updated. Declaration public static void RemoveLinks(this IConfigProvider config) Parameters Type Name Description IConfigProvider config the IConfigProvider to unlink"
|
|
},
|
|
"api/IPA.Config.Config.PreferAttribute.html": {
|
|
"href": "api/IPA.Config.Config.PreferAttribute.html",
|
|
"title": "Class Config.PreferAttribute",
|
|
"keywords": "Class Config.PreferAttribute Specifies that a particular parameter is preferred to be a specific type of IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. Inheritance Object Attribute Config.PreferAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Parameter)] public class PreferAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source PreferAttribute(String[]) Constructs the attribute with a specific preference list. Each entry is the extension without a '.' Declaration public PreferAttribute(params string[] preference) Parameters Type Name Description String [] preference The preferences in order of preference. Properties | Improve this Doc View Source PreferenceOrder The order of preference for the config type. Declaration public string[] PreferenceOrder { get; } Property Value Type Description String [] the list of config extensions in order of preference Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Utilities.html": {
|
|
"href": "api/IPA.Utilities.html",
|
|
"title": "Namespace IPA.Utilities",
|
|
"keywords": "Namespace IPA.Utilities Classes BeatSaber Provides some basic utility methods and properties of Beat Saber Extensions A class providing various extension methods. Ref Utilities to create Ref<T> using type inference. Ref<T> A class to store a reference for passing to methods which cannot take ref parameters. ReflectionUtil A utility class providing reflection helper methods. Utils A class providing static utility functions that in any other language would just exist . Enums BeatSaber.Release The different types of releases of the game."
|
|
},
|
|
"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 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<Exception, FileInfo, Boolean>) Copies all files from source to target . Declaration public static void CopyAll(DirectoryInfo source, DirectoryInfo target, string appendFileName = \"\", Func<Exception, FileInfo, bool> 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 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"
|
|
},
|
|
"api/IPA.Logging.Printers.GlobalLogFilePrinter.html": {
|
|
"href": "api/IPA.Logging.Printers.GlobalLogFilePrinter.html",
|
|
"title": "Class GlobalLogFilePrinter",
|
|
"keywords": "Class GlobalLogFilePrinter A printer for all messages to a unified log location. Inheritance Object LogPrinter GZFilePrinter GlobalLogFilePrinter Implements IDisposable Inherited Members GZFilePrinter.FileWriter GZFilePrinter.StartPrint() GZFilePrinter.EndPrint() GZFilePrinter.Dispose() GZFilePrinter.Dispose(Boolean) Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class GlobalLogFilePrinter : GZFilePrinter, IDisposable Properties | Improve this Doc View Source Filter Provides a filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source GetFileInfo() Gets the FileInfo for the target file. Declaration protected override FileInfo GetFileInfo() Returns Type Description FileInfo the target file to write to Overrides GZFilePrinter.GetFileInfo() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the associated file. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Implements System.IDisposable Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Logging.Printers.ColorlessConsolePrinter.html": {
|
|
"href": "api/IPA.Logging.Printers.ColorlessConsolePrinter.html",
|
|
"title": "Class ColorlessConsolePrinter",
|
|
"keywords": "Class ColorlessConsolePrinter A colorless version of ColoredConsolePrinter , that indiscriminantly prints to standard out. Inheritance Object LogPrinter ColorlessConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColorlessConsolePrinter : LogPrinter Properties | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter level for this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to standard out. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, 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 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.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Config.html": {
|
|
"href": "api/IPA.Config.html",
|
|
"title": "Namespace IPA.Config",
|
|
"keywords": "Namespace IPA.Config Classes Config A class to handle updating ConfigProviders automatically Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Config.PreferAttribute Specifies that a particular parameter is preferred to be a specific type of IConfigProvider . If it is not available, also specifies backups. If none are available, the default is used. Config.TypeAttribute Defines the type of the IConfigProvider ModPrefs Allows to get and set preferences for your mod. Interfaces IConfigProvider An interface for configuration providers. IModPrefs Allows to get and set preferences for your mod."
|
|
},
|
|
"api/IPA.Config.IConfigProvider.html": {
|
|
"href": "api/IPA.Config.IConfigProvider.html",
|
|
"title": "Interface IConfigProvider",
|
|
"keywords": "Interface IConfigProvider An interface for configuration providers. Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public interface IConfigProvider Properties | Improve this Doc View Source Dynamic Gets a dynamic object providing access to the configuration. Declaration dynamic Dynamic { get; } Property Value Type Description Object a dynamically bound object to use to access config values directly | Improve this Doc View Source Filename Will be set with the filename (no extension) to save to. When saving, the implementation should add the appropriate extension. Should error if set multiple times. Declaration string Filename { set; } Property Value Type Description String the extensionless filename to save to | Improve this Doc View Source HasChanged Returns true if object has changed since the last save Declaration bool HasChanged { get; } Property Value Type Description Boolean true if object has changed since the last save, else false | Improve this Doc View Source InMemoryChanged Returns true if the data in memory has been changed - notably including loads. Declaration bool InMemoryChanged { get; set; } Property Value Type Description Boolean true if the data in memory has been changed, else false | Improve this Doc View Source LastModified Gets the last time the config was modified. Declaration DateTime LastModified { get; } Property Value Type Description DateTime the last time the config file was modified Methods | Improve this Doc View Source Load() Loads the state of the file on disk. Declaration void Load() | Improve this Doc View Source Parse<T>() Loads the data provided by this IConfigProvider into an object of type T . Declaration T Parse<T>() Returns Type Description T the values from the config provider parsed into the object Type Parameters Name Description T the type of the object to parse into | Improve this Doc View Source Save() Saves configuration to file. Should error if not a root object. Declaration void Save() | Improve this Doc View Source Store<T>(T) Stores the data from obj into the IConfigProvider . Declaration void Store<T>(T obj) Parameters Type Name Description T obj the object containing the data to save Type Parameters Name Description T the type of obj Extension Methods Config.MakeLink<T>(IConfigProvider, Action<IConfigProvider, Ref<T>>) Config.RemoveLinks(IConfigProvider) ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Config.Config.TypeAttribute.html": {
|
|
"href": "api/IPA.Config.Config.TypeAttribute.html",
|
|
"title": "Class Config.TypeAttribute",
|
|
"keywords": "Class Config.TypeAttribute Defines the type of the IConfigProvider Inheritance Object Attribute Config.TypeAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [AttributeUsage(AttributeTargets.Class)] public class TypeAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source TypeAttribute(String) Constructs the attribute with a specified extension. Declaration public TypeAttribute(string ext) Parameters Type Name Description String ext the extension associated with this type, without the '.' Properties | Improve this Doc View Source Extension The extension associated with this type, without the '.' Declaration public string Extension { get; } Property Value Type Description String the extension to register the config provider as Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.PluginManager.PluginDisableDelegate.html": {
|
|
"href": "api/IPA.Loader.PluginManager.PluginDisableDelegate.html",
|
|
"title": "Delegate PluginManager.PluginDisableDelegate",
|
|
"keywords": "Delegate PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate void PluginDisableDelegate(PluginLoader.PluginMetadata plugin, bool needsRestart); Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin that was disabled Boolean needsRestart whether it needs a restart to take effect Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.IBeatSaberPlugin.html": {
|
|
"href": "api/IPA.IBeatSaberPlugin.html",
|
|
"title": "Interface IBeatSaberPlugin",
|
|
"keywords": "Interface IBeatSaberPlugin Interface for Beat Saber plugins. Every class that implements this will be loaded if the DLL is placed at data/Managed/Plugins. Namespace : IPA Assembly : IPA.Loader.dll Syntax public interface IBeatSaberPlugin 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 OnApplicationStart() Gets invoked when the application is started. THIS EVENT WILL NOT BE GUARANTEED TO FIRE. USE Init OR OnEnable() INSTEAD. Declaration void OnApplicationStart() | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | 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 | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Config.ModPrefs.html": {
|
|
"href": "api/IPA.Config.ModPrefs.html",
|
|
"title": "Class ModPrefs",
|
|
"keywords": "Class ModPrefs Allows to get and set preferences for your mod. Inheritance Object ModPrefs Implements IModPrefs Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax [Obsolete(\"Uses IniFile, which uses 16 bit system calls. Use BS Utils INI system for now.\")] public class ModPrefs : IModPrefs Constructors | Improve this Doc View Source ModPrefs(PluginLoader.PluginMetadata) Constructs a ModPrefs object for the provide plugin. Declaration public ModPrefs(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin to get the preferences file for Methods | Improve this Doc View Source GetBool(String, String, Boolean, Boolean) Gets a bool from the ini. Declaration public static bool GetBool(string section, string name, bool defaultValue = false, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Boolean | Improve this Doc View Source GetFloat(String, String, Single, Boolean) Gets a float from the ini. Declaration public static float GetFloat(string section, string name, float defaultValue = 0F, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Single defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Single | Improve this Doc View Source GetInt(String, String, Int32, Boolean) Gets an int from the ini. Declaration public static int GetInt(string section, string name, int defaultValue = 0, bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description Int32 | Improve this Doc View Source GetString(String, String, String, Boolean) Gets a string from the ini. Declaration public static string GetString(string section, string name, string defaultValue = \"\", bool autoSave = false) Parameters Type Name Description String section Section of the key. String name Name of the key. String defaultValue Value that should be used when no value is found. Boolean autoSave Whether or not the default value should be written if no value is found. Returns Type Description String | Improve this Doc View Source HasKey(String, String) Checks whether or not a key exists in the ini. Declaration public static bool HasKey(string section, string name) Parameters Type Name Description String section Section of the key. String name Name of the key. Returns Type Description Boolean | Improve this Doc View Source SetBool(String, String, Boolean) Sets a bool in the ini. Declaration public static void SetBool(string section, string name, bool value) Parameters Type Name Description String section Section of the key. String name Name of the key. Boolean value Value that should be written. | Improve this Doc View Source SetFloat(String, String, Single) Sets a float in the ini. Declaration public static void SetFloat(string section, string name, float value) Parameters Type Name Description String section Section of the key. String name Name of the key. Single value Value that should be written. | Improve this Doc View Source SetInt(String, String, Int32) Sets an int in the ini. Declaration public static void SetInt(string section, string name, int value) Parameters Type Name Description String section Section of the key. String name Name of the key. Int32 value Value that should be written. | Improve this Doc View Source SetString(String, String, String) Sets a string in the ini. Declaration public static void SetString(string section, string name, string value) Parameters Type Name Description String section Section of the key. String name Name of the key. String value Value that should be written. Explicit Interface Implementations | Improve this Doc View Source IModPrefs.GetBool(String, String, Boolean, Boolean) Declaration bool IModPrefs.GetBool(string section, string name, bool defaultValue, bool autoSave) Parameters Type Name Description String section String name Boolean defaultValue Boolean autoSave Returns Type Description Boolean | Improve this Doc View Source IModPrefs.GetFloat(String, String, Single, Boolean) Declaration float IModPrefs.GetFloat(string section, string name, float defaultValue, bool autoSave) Parameters Type Name Description String section String name Single defaultValue Boolean autoSave Returns Type Description Single | Improve this Doc View Source IModPrefs.GetInt(String, String, Int32, Boolean) Declaration int IModPrefs.GetInt(string section, string name, int defaultValue, bool autoSave) Parameters Type Name Description String section String name Int32 defaultValue Boolean autoSave Returns Type Description Int32 | Improve this Doc View Source IModPrefs.GetString(String, String, String, Boolean) Declaration string IModPrefs.GetString(string section, string name, string defaultValue, bool autoSave) Parameters Type Name Description String section String name String defaultValue Boolean autoSave Returns Type Description String | Improve this Doc View Source IModPrefs.HasKey(String, String) Declaration bool IModPrefs.HasKey(string section, string name) Parameters Type Name Description String section String name Returns Type Description Boolean | Improve this Doc View Source IModPrefs.SetBool(String, String, Boolean) Declaration void IModPrefs.SetBool(string section, string name, bool value) Parameters Type Name Description String section String name Boolean value | Improve this Doc View Source IModPrefs.SetFloat(String, String, Single) Declaration void IModPrefs.SetFloat(string section, string name, float value) Parameters Type Name Description String section String name Single value | Improve this Doc View Source IModPrefs.SetInt(String, String, Int32) Declaration void IModPrefs.SetInt(string section, string name, int value) Parameters Type Name Description String section String name Int32 value | Improve this Doc View Source IModPrefs.SetString(String, String, String) Declaration void IModPrefs.SetString(string section, string name, string value) Parameters Type Name Description String section String name String value Implements IModPrefs Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"articles/index.html": {
|
|
"href": "articles/index.html",
|
|
"title": "Getting Started",
|
|
"keywords": "Getting Started"
|
|
},
|
|
"index.html": {
|
|
"href": "index.html",
|
|
"title": "Beat Saber IPA Reloaded",
|
|
"keywords": "Beat Saber IPA Reloaded Beat Saber IPA - The mod injector tailored for Beat Saber How To Install Download a release Extract the contents into the game folder Run IPA.exe Start the game as usual A console window should open before the game starts if the installation was successful. To disable this console window, pass --no-console to the game. How To Uninstall Drag & drop the game exe onto IPA.exe while holding Alt Or run ipa -rn in a command window Arguments IPA.exe file-to-patch [arguments] --launch : Launch the game after patching --revert : Revert changes made by IPA (= unpatch the game) --nowait : Never keep the console open See -h or --help for more options. Unconsumed arguments will be passed on to the game in case of --launch . How To Develop Create a new Class Library C# project (.NET 4.6) Download a release and add IPA.Loader.dll to your references Implement IBeatSaberPlugin or IEnhancedBeatSaberPlugin Build the project and copy the DLL into the Plugins folder of the game. See Developing for more information. How To Keep The Game Patched BSIPA will automatically repatch the game when it updates, as long as winhttp.dll is present in the install directory. Notes for running under Wine For some reason, by default, Wine does not load DLLs in quite the same way that Windows does, causing issues with the injection. To make the injection work with Wine, winhttp has to have a DLL override set to native,builtin . This can be set either through Protontricks, or with the following .reg file. REGEDIT4 [HKEY_CURRENT_USER\\Software\\Wine\\DllOverrides] \"winhttp\"=\"native,builtin\" For Steam there's a per-game Wine prefix under compatdata . In this case SteamLibrary/steamapps/compatdata/620980/pfx/user.reg . Changes to this file will likely be ovewritten when the game updates or if local files are validated through Steam. Building Prerequisites Microsoft Visual Studio 2019 or later (2017 may work, no guarantees) Tools for C/C++ (MSVC) v141 .NET 4.6.1 SDK and .NET 4.7.2 SDK Building Clone with git clone https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded.git --recursive Create a file, bsinstalldir.txt in the solution root. Do NOT create this in Visual Studio; VS adds a BOM at the begginning of the file that the tools used cannot read. It should contain the path to your Beat Saber installation, using forward slashes with a trailing slash. e.g. C:/Program Files (x86)/Steam/steamapps/common/Beat Saber/ Open BSIPA.sln in Visual Studio. Choose the configuration x64 Rebuild all. When you make a change somewhere in BSIPA itself, right click on IPA and click Build . This sets up the output in path/to/solution/IPA/bin/<Configuration> to be what should be copied to the game directory. When making a change to the Mod List, you only need to build the mod list. Install by copying everything in path/to/solution/BSIPA-ModList/bin/<Configuration> to your game directory. When building a Debug build, all referenced assemblies from Beat Saber will be copied from the install directory provided in bsinstalldir.txt into Refs/ . Any new references should reference the copy in there. When building for Release, it just uses the files already in Refs/"
|
|
},
|
|
"api/index.html": {
|
|
"href": "api/index.html",
|
|
"title": "BSIPA API Documentation",
|
|
"keywords": "BSIPA API Documentation Welcome to the full class documentation! To see guides, head over to the Articles tab . Select a namespace and a class on the left to get started."
|
|
},
|
|
"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 CallNonStaticMethod(String, String, String, Type[], Object[]) Calls an instance method on a type specified by functionClass and dependency . Declaration public static object CallNonStaticMethod(string functionClass, string dependency, string function, Type[] methodSig, params object[] parameters) Parameters Type Name Description String functionClass the type name String dependency the assembly the type is in String function the name of the method to call Type [] methodSig the type signature of the method Object [] parameters the method parameters Returns Type Description Object the result of the call See Also CallNonStaticMethod(Type, String, Type[], Object[]) | Improve this Doc View Source CallNonStaticMethod(Type, String, Type[], Object[]) Calls an instance method on a new object. Declaration public static object CallNonStaticMethod(this Type type, string function, Type[] methodSig, params object[] parameters) Parameters Type Name Description Type type the object type String function the name of the method to call Type [] methodSig the type signature Object [] parameters the parameters Returns Type Description Object the result of the call | Improve this Doc View Source CallNonStaticMethod<T>(Type, String, Type[], Object[]) Calls an instance method on a new object. Declaration public static T CallNonStaticMethod<T>(this Type type, string function, Type[] methodSig, params object[] parameters) Parameters Type Name Description Type type the object type String function the name of the method to call Type [] methodSig the type signature Object [] parameters the parameters Returns Type Description T the result of the call Type Parameters Name Description T the return type See Also CallNonStaticMethod(Type, String, Type[], Object[]) | 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<T>(Component, GameObject, Type) A generic version of CopyComponent(Component, Type, GameObject, Type) . Declaration public static T CopyComponent<T>(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 GetPrivateField<T>(Object, String) Gets the value of a (potentially) private field. Declaration public static T GetPrivateField<T>(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 te field (result casted) | Improve this Doc View Source InvokePrivateMethod(Object, String, Object[]) Invokes a (potentially) private method. Declaration public static object InvokePrivateMethod(this object obj, string methodName, params object[] methodParams) Parameters Type Name Description Object obj the object to call from String methodName the method name Object [] methodParams the method parameters Returns Type Description Object the return value | Improve this Doc View Source InvokePrivateMethod<T>(Object, String, Object[]) Invokes a (potentially) private method. Declaration public static T InvokePrivateMethod<T>(this object obj, string methodName, params object[] methodParams) Parameters Type Name Description Object obj the object to call from String methodName the method name to call Object [] methodParams the method's parameters Returns Type Description T the return value Type Parameters Name Description T the return type | Improve this Doc View Source SetPrivateField(Object, String, Object) Sets a (potentially) private field on the target object. Declaration public static void SetPrivateField(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 | Improve this Doc View Source SetPrivateProperty(Object, String, Object) Sets a (potentially) private property on the target object. Declaration public static void SetPrivateProperty(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"
|
|
},
|
|
"api/IPA.Utilities.Ref.html": {
|
|
"href": "api/IPA.Utilities.Ref.html",
|
|
"title": "Class Ref",
|
|
"keywords": "Class Ref Utilities to create Ref<T> 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>(T) Creates a Ref<T> . Declaration public static Ref<T> Create<T>(T val) Parameters Type Name Description T val the default value. Returns Type Description Ref <T> the new Ref<T> . 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<T>",
|
|
"keywords": "Class Ref<T> A class to store a reference for passing to methods which cannot take ref parameters. Inheritance Object Ref<T> Implements IComparable <T> IComparable < Ref <T>> 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<T> : IComparable<T>, IComparable<Ref<T>> 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<T> | 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<T> 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<T>) Compares the wrapped object to the other wrapped object. Declaration public int CompareTo(Ref<T> other) Parameters Type Name Description Ref <T> 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<T>) 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>(T toConvert) Parameters Type Name Description T toConvert the value to wrap in the Ref Returns Type Description Ref <T> the Ref wrapping the value | Improve this Doc View Source Implicit(Ref<T> to T) Converts to referenced type, returning the stored reference. Declaration public static implicit operator T(Ref<T> self) Parameters Type Name Description Ref <T> self the object to be de-referenced Returns Type Description T the value referenced by the object Implements System.IComparable<T> System.IComparable<T> Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, 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 Unwrap(Nullable<Boolean>) Unwraps a Nullable<T> 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"
|
|
},
|
|
"api/IPA.Old.html": {
|
|
"href": "api/IPA.Old.html",
|
|
"title": "Namespace IPA.Old",
|
|
"keywords": "Namespace IPA.Old 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 at data/Managed/Plugins."
|
|
},
|
|
"api/IPA.Old.IPlugin.html": {
|
|
"href": "api/IPA.Old.IPlugin.html",
|
|
"title": "Interface IPlugin",
|
|
"keywords": "Interface IPlugin Interface for generic Illusion unity plugins. Every class that implements this will be loaded if the DLL is placed at data/Managed/Plugins. Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IBeatSaberPlugin\")] public interface IPlugin Properties | Improve this Doc View Source Name Gets the name of the plugin. Declaration string Name { get; } Property Value Type Description String | Improve this Doc View Source Version Gets the version of the plugin. Declaration string Version { get; } Property Value Type Description String Methods | Improve this Doc View Source OnApplicationQuit() Gets invoked when the application is closed. Declaration void OnApplicationQuit() | Improve this Doc View Source OnApplicationStart() Gets invoked when the application is started. Declaration void OnApplicationStart() | Improve this Doc View Source OnFixedUpdate() Gets invoked on ever physics update. Declaration void OnFixedUpdate() | Improve this Doc View Source OnLevelWasInitialized(Int32) Gets invoked after the first update cycle after a level was loaded. Declaration void OnLevelWasInitialized(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnLevelWasLoaded(Int32) Gets invoked whenever a level is loaded. Declaration void OnLevelWasLoaded(int level) Parameters Type Name Description Int32 level | Improve this Doc View Source OnUpdate() Gets invoked on every graphic update. Declaration void OnUpdate() Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Logging.Printers.html": {
|
|
"href": "api/IPA.Logging.Printers.html",
|
|
"title": "Namespace IPA.Logging.Printers",
|
|
"keywords": "Namespace IPA.Logging.Printers 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.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.html": {
|
|
"href": "api/IPA.Loader.html",
|
|
"title": "Namespace IPA.Loader",
|
|
"keywords": "Namespace IPA.Loader Classes PluginInitInjector The type that handles value injecting into a plugin's Init. PluginLoader A type to manage the loading of plugins. PluginLoader.PluginInfo A container object for all the data relating to a plugin. PluginLoader.PluginMetadata A class which describes a loaded plugin. PluginManager The manager class for all plugins. Delegates PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. PluginManager.PluginDisableDelegate An invoker for the PluginDisabled event. PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event."
|
|
},
|
|
"api/IPA.Loader.PluginManager.html": {
|
|
"href": "api/IPA.Loader.PluginManager.html",
|
|
"title": "Class PluginManager",
|
|
"keywords": "Class PluginManager The manager class for all plugins. Inheritance Object PluginManager Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginManager Properties | Improve this Doc View Source AllPlugins Gets a list of all BSIPA plugins. Declaration public static IEnumerable<PluginLoader.PluginInfo> AllPlugins { get; } Property Value Type Description IEnumerable < PluginLoader.PluginInfo > a collection of all enabled plugins as PluginLoader.PluginInfo s | Improve this Doc View Source DisabledPlugins Gets a list of disabled BSIPA plugins. Declaration public static IEnumerable<PluginLoader.PluginMetadata> DisabledPlugins { get; } Property Value Type Description IEnumerable < PluginLoader.PluginMetadata > a collection of all disabled plugins as PluginLoader.PluginMetadata | Improve this Doc View Source Plugins An IEnumerable of old IPA plugins. Declaration [Obsolete(\"I mean, IPlugin shouldn't be used, so why should this? Not renaming to extend support for old plugins.\")] public static IEnumerable<IPlugin> Plugins { get; } Property Value Type Description IEnumerable < IPlugin > all legacy plugin instances Methods | Improve this Doc View Source DisablePlugin(PluginLoader.PluginInfo) Disables a plugin, and all dependents. Declaration public static bool DisablePlugin(PluginLoader.PluginInfo plugin) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin to disable Returns Type Description Boolean whether or not it needs a restart to enable | Improve this Doc View Source DisablePlugin(String) Disables a plugin, and all dependents. Declaration public static bool DisablePlugin(string pluginId) Parameters Type Name Description String pluginId the ID, or name if the ID is null, of the plugin to disable Returns Type Description Boolean whether a restart is needed to activate | Improve this Doc View Source EnablePlugin(PluginLoader.PluginMetadata) Enables a plugin that had been previously disabled. Declaration public static bool EnablePlugin(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin to enable Returns Type Description Boolean whether a restart is needed to activate | Improve this Doc View Source EnablePlugin(String) Enables a plugin that had been previously disabled. Declaration public static bool EnablePlugin(string pluginId) Parameters Type Name Description String pluginId the ID, or name if the ID is null, of the plugin to enable Returns Type Description Boolean whether a restart is needed to activate | Improve this Doc View Source GetDisabledPlugin(String) Gets a disabled plugin's metadata by its name. Declaration public static PluginLoader.PluginMetadata GetDisabledPlugin(string name) Parameters Type Name Description String name the name of the disabled plugin to get Returns Type Description PluginLoader.PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetDisabledPluginFromId(String) Gets a disabled plugin's metadata by its ID. Declaration public static PluginLoader.PluginMetadata GetDisabledPluginFromId(string name) Parameters Type Name Description String name the ID of the disabled plugin to get Returns Type Description PluginLoader.PluginMetadata the metadata for the corresponding plugin | Improve this Doc View Source GetPlugin(String) Gets info about the plugin with the specified name. Declaration public static PluginLoader.PluginInfo GetPlugin(string name) Parameters Type Name Description String name the name of the plugin to get (must be an exact match) Returns Type Description PluginLoader.PluginInfo the plugin info for the requested plugin or null | Improve this Doc View Source GetPluginFromId(String) Gets info about the plugin with the specified ID. Declaration public static PluginLoader.PluginInfo GetPluginFromId(string name) Parameters Type Name Description String name the ID name of the plugin to get (must be an exact match) Returns Type Description PluginLoader.PluginInfo the plugin info for the requested plugin or null | Improve this Doc View Source GetPluginFromModSaberName(String) Gets info about the plugin with the specified ModSaber name. Declaration [Obsolete(\"Old name. Use GetPluginFromId instead.\")] public static PluginLoader.PluginInfo GetPluginFromModSaberName(string name) Parameters Type Name Description String name the ModSaber name of the plugin to get (must be an exact match) Returns Type Description PluginLoader.PluginInfo the plugin info for the requested plugin or null | Improve this Doc View Source InfoFromMetadata(PluginLoader.PluginMetadata) Converts a plugin's metadata to a PluginLoader.PluginInfo . Declaration public static PluginLoader.PluginInfo InfoFromMetadata(PluginLoader.PluginMetadata meta) Parameters Type Name Description PluginLoader.PluginMetadata meta the metadata Returns Type Description PluginLoader.PluginInfo the plugin info | Improve this Doc View Source IsDisabled(PluginLoader.PluginMetadata) Checks if a given plugin is disabled. Declaration public static bool IsDisabled(PluginLoader.PluginMetadata meta) Parameters Type Name Description PluginLoader.PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is disabled, false otherwise. | Improve this Doc View Source IsEnabled(PluginLoader.PluginMetadata) Checks if a given plugin is enabled. Declaration public static bool IsEnabled(PluginLoader.PluginMetadata meta) Parameters Type Name Description PluginLoader.PluginMetadata meta the plugin to check Returns Type Description Boolean true if the plugin is enabled, false otherwise. Events | Improve this Doc View Source PluginDisabled Called whenever a plugin is disabled. Declaration public static event PluginManager.PluginDisableDelegate PluginDisabled Event Type Type Description PluginManager.PluginDisableDelegate | Improve this Doc View Source PluginEnabled Called whenever a plugin is enabled. Declaration public static event PluginManager.PluginEnableDelegate PluginEnabled Event Type Type Description PluginManager.PluginEnableDelegate"
|
|
},
|
|
"api/IPA.Loader.PluginLoader.html": {
|
|
"href": "api/IPA.Loader.PluginLoader.html",
|
|
"title": "Class PluginLoader",
|
|
"keywords": "Class PluginLoader A type to manage the loading of plugins. Inheritance Object PluginLoader 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 class PluginLoader Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.PluginLoader.PluginMetadata.html": {
|
|
"href": "api/IPA.Loader.PluginLoader.PluginMetadata.html",
|
|
"title": "Class PluginLoader.PluginMetadata",
|
|
"keywords": "Class PluginLoader.PluginMetadata A class which describes a loaded plugin. Inheritance Object PluginLoader.PluginMetadata Inherited Members 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 class PluginMetadata Properties | Improve this Doc View Source Assembly The assembly the plugin was loaded from. Declaration public Assembly Assembly { get; } Property Value Type Description Assembly the loaded Assembly that contains the plugin main type | Improve this Doc View Source Features The features this plugin requests. Declaration public IReadOnlyList<Feature> Features { get; } Property Value Type Description IReadOnlyList < Feature > the list of features requested by the plugin | Improve this Doc View Source File The file the plugin was loaded from. Declaration public FileInfo File { get; } Property Value Type Description FileInfo the file the plugin was loaded from | Improve this Doc View Source Id The BeatMods ID of the plugin, or null if it doesn't have one. Declaration public string Id { get; } Property Value Type Description String the updater ID of the plugin | Improve this Doc View Source Name The human readable name of the plugin. Declaration public string Name { get; } Property Value Type Description String the name of the plugin | Improve this Doc View Source PluginType The TypeDefinition for the main type of the plugin. Declaration public TypeDefinition PluginType { get; } Property Value Type Description Mono.Cecil.TypeDefinition the Cecil definition for the plugin main type | Improve this Doc View Source Version The version of the plugin. Declaration public Version Version { get; } Property Value Type Description SemVer.Version the version of the plugin Methods | Improve this Doc View Source ToString() Gets all of the metadata as a readable string. Declaration public override string ToString() Returns Type Description String the readable printable metadata string Overrides Object.ToString() Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.PluginInitInjector.InjectParameter.html": {
|
|
"href": "api/IPA.Loader.PluginInitInjector.InjectParameter.html",
|
|
"title": "Delegate PluginInitInjector.InjectParameter",
|
|
"keywords": "Delegate PluginInitInjector.InjectParameter A typed injector for a plugin's Init method. When registered, called for all associated types. If it returns null, the default for the type will be used. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate object InjectParameter(object previous, ParameterInfo param, PluginLoader.PluginMetadata meta); Parameters Type Name Description Object previous the previous return value of the function, or null if never called for plugin. ParameterInfo param the ParameterInfo of the parameter being injected. PluginLoader.PluginMetadata meta the PluginLoader.PluginMetadata for the plugin being loaded. Returns Type Description Object the value to inject into that parameter. Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.Features.html": {
|
|
"href": "api/IPA.Loader.Features.html",
|
|
"title": "Namespace IPA.Loader.Features",
|
|
"keywords": "Namespace IPA.Loader.Features Classes Feature The root interface for a mod Feature."
|
|
},
|
|
"api/IPA.IGenericEnhancedPlugin.html": {
|
|
"href": "api/IPA.IGenericEnhancedPlugin.html",
|
|
"title": "Interface IGenericEnhancedPlugin",
|
|
"keywords": "Interface IGenericEnhancedPlugin A generic interface for the modification for enhanced plugins. Namespace : IPA Assembly : IPA.Loader.dll Syntax public interface IGenericEnhancedPlugin Properties | Improve this Doc View Source Filter Gets a list of executables this plugin should be executed on (without the file ending) Declaration [Obsolete(\"Ignored.\")] string[] Filter { get; } Property Value Type Description String [] Examples { \"PlayClub\", \"PlayClubStudio\" } Methods | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.IDisablablePlugin.html": {
|
|
"href": "api/IPA.IDisablablePlugin.html",
|
|
"title": "Interface IDisablablePlugin",
|
|
"keywords": "Interface IDisablablePlugin Provides methods to allow runtime enabling and disabling of a plugin. Namespace : IPA Assembly : IPA.Loader.dll Syntax public interface IDisablablePlugin 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. | 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. Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Old.IEnhancedPlugin.html": {
|
|
"href": "api/IPA.Old.IEnhancedPlugin.html",
|
|
"title": "Interface IEnhancedPlugin",
|
|
"keywords": "Interface IEnhancedPlugin An enhanced version of the standard IPA plugin. Inherited Members IPlugin.Name IPlugin.Version IPlugin.OnApplicationStart() IPlugin.OnApplicationQuit() IPlugin.OnLevelWasLoaded(Int32) IPlugin.OnLevelWasInitialized(Int32) IPlugin.OnUpdate() IPlugin.OnFixedUpdate() Namespace : IPA.Old Assembly : IPA.Loader.dll Syntax [Obsolete(\"When building plugins for Beat Saber, use IEnhancedBeatSaberPlugin\")] public interface IEnhancedPlugin : IPlugin Properties | Improve this Doc View Source Filter Gets a list of executables this plugin should be executed on (without the file ending) Declaration string[] Filter { get; } Property Value Type Description String [] Examples { \"PlayClub\", \"PlayClubStudio\" } Methods | Improve this Doc View Source OnLateUpdate() Called after Update. Declaration void OnLateUpdate() Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.ModsaberModInfo.html": {
|
|
"href": "api/IPA.ModsaberModInfo.html",
|
|
"title": "Class ModsaberModInfo",
|
|
"keywords": "Class ModsaberModInfo A class to provide information about a mod on ModSaber.ML Inheritance Object ModsaberModInfo Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA Assembly : IPA.Loader.dll Syntax [Obsolete(\"This is unused, and has been since the manifest was introduced. All functionality is provided by the manifest.\")] public class ModsaberModInfo Properties | Improve this Doc View Source CurrentVersion The version of the currently installed mod. Used to compare to the version on ModSaber. Should be a valid SemVer version. Declaration public string CurrentVersion { get; set; } Property Value Type Description String | Improve this Doc View Source InternalName The name the mod uses on ModSaber as an identifier. Declaration public string InternalName { get; set; } Property Value Type Description String Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Logging.html": {
|
|
"href": "api/IPA.Logging.html",
|
|
"title": "Namespace IPA.Logging",
|
|
"keywords": "Namespace IPA.Logging Classes Logger The logger base class. Provides the format for console logs. LoggerExtensions A class providing extensions for various loggers. LogPrinter The log printer's base class. StandardLogger The default (and standard) Logger implementation. Enums Logger.Level An enum specifying the level of the message. Resembles Syslog. Logger.LogLevel An enum providing log level filters."
|
|
},
|
|
"api/IPA.Logging.StandardLogger.html": {
|
|
"href": "api/IPA.Logging.StandardLogger.html",
|
|
"title": "Class StandardLogger",
|
|
"keywords": "Class StandardLogger The default (and standard) Logger implementation. Inheritance Object Logger StandardLogger Inherited Members Logger.LogFormat Logger.Log(Logger.Level, Exception) Logger.Debug(Exception) Logger.Info(String) Logger.Info(Exception) Logger.Notice(String) Logger.Notice(Exception) Logger.Warn(String) Logger.Warn(Exception) Logger.Error(String) Logger.Error(Exception) Logger.Critical(String) Logger.Critical(Exception) 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 class StandardLogger : Logger Remarks StandardLogger uses a multi-threaded approach to logging. All actual I/O is done on another thread, where all messaged are guaranteed to be logged in the order they appeared. It is up to the printers to format them. This logger supports child loggers. Use GetChildLogger(Logger, String) to safely get a child. The modification of printers on a parent are reflected down the chain. Properties | Improve this Doc View Source ConsoleWriter The TextWriter for writing directly to the console window, or stdout if no window open. Declaration public static TextWriter ConsoleWriter { get; } Property Value Type Description TextWriter a TextWriter for the current primary text output | Improve this Doc View Source PrintFilter All levels defined by this filter will be sent to loggers. All others will be ignored. Declaration public static Logger.LogLevel PrintFilter { get; set; } Property Value Type Description Logger.LogLevel the global filter level Methods | Improve this Doc View Source AddPrinter(LogPrinter) Adds a log printer to the logger. Declaration public void AddPrinter(LogPrinter printer) Parameters Type Name Description LogPrinter printer the printer to add | Improve this Doc View Source Debug(String) An override to Debug(String) which shows the method that called it. Declaration public override void Debug(string message) Parameters Type Name Description String message the message to log Overrides Logger.Debug(String) See Also Log ( Logger.Level , String ) | Improve this Doc View Source Log(Logger.Level, String) Logs a specific message at a given level. Declaration public override void Log(Logger.Level level, string message) Parameters Type Name Description Logger.Level level the message level String message the message to log Overrides Logger.Log(Logger.Level, String) Extension Methods LoggerExtensions.GetChildLogger(Logger, String) ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Logging.Printers.ColoredConsolePrinter.html": {
|
|
"href": "api/IPA.Logging.Printers.ColoredConsolePrinter.html",
|
|
"title": "Class ColoredConsolePrinter",
|
|
"keywords": "Class ColoredConsolePrinter Prints a pretty message to the console. Inheritance Object LogPrinter ColoredConsolePrinter Inherited Members LogPrinter.StartPrint() LogPrinter.EndPrint() Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging.Printers Assembly : IPA.Loader.dll Syntax public class ColoredConsolePrinter : LogPrinter Properties | Improve this Doc View Source Color The color to print messages as. Declaration public ConsoleColor Color { get; set; } Property Value Type Description ConsoleColor the color to print this message as | Improve this Doc View Source Filter A filter for this specific printer. Declaration public override Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the filter to apply to this printer Overrides LogPrinter.Filter Methods | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints an entry to the console window. Declaration public override void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the Logger.Level of the message DateTime time the DateTime the message was recorded at String logName the name of the log that sent the message String message the message to print Overrides LogPrinter.Print(Logger.Level, DateTime, String, String) Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Logging.LogPrinter.html": {
|
|
"href": "api/IPA.Logging.LogPrinter.html",
|
|
"title": "Class LogPrinter",
|
|
"keywords": "Class LogPrinter The log printer's base class. Inheritance Object LogPrinter ColoredConsolePrinter ColorlessConsolePrinter GZFilePrinter Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Logging Assembly : IPA.Loader.dll Syntax public abstract class LogPrinter Properties | Improve this Doc View Source Filter Provides a filter for which log levels to allow through. Declaration public abstract Logger.LogLevel Filter { get; set; } Property Value Type Description Logger.LogLevel the level to filter to Methods | Improve this Doc View Source EndPrint() Called after the last print in a group. May be called multiple times. Use this to dispose file handles and the like. Declaration public virtual void EndPrint() | Improve this Doc View Source Print(Logger.Level, DateTime, String, String) Prints a provided message from a given log at the specified time. Declaration public abstract void Print(Logger.Level level, DateTime time, string logName, string message) Parameters Type Name Description Logger.Level level the log level DateTime time the time the message was composed String logName the name of the log that created this message String message the message | Improve this Doc View Source StartPrint() Called before the first print in a group. May be called multiple times. Use this to create file handles and the like. Declaration public virtual void StartPrint() Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.PluginManager.PluginEnableDelegate.html": {
|
|
"href": "api/IPA.Loader.PluginManager.PluginEnableDelegate.html",
|
|
"title": "Delegate PluginManager.PluginEnableDelegate",
|
|
"keywords": "Delegate PluginManager.PluginEnableDelegate An invoker for the PluginEnabled event. Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public delegate void PluginEnableDelegate(PluginLoader.PluginInfo plugin, bool needsRestart); Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin that was enabled Boolean needsRestart whether it needs a restart to take effect Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Config.Config.NameAttribute.html": {
|
|
"href": "api/IPA.Config.Config.NameAttribute.html",
|
|
"title": "Class Config.NameAttribute",
|
|
"keywords": "Class Config.NameAttribute Specifies a preferred config name, instead of using the plugin's name. Inheritance Object Attribute Config.NameAttribute Implements _Attribute Inherited Members Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, Boolean) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, Boolean) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(ParameterInfo, Boolean) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, Boolean) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, Boolean) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, Boolean) Attribute.GetCustomAttributes(Module, Type, Boolean) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, Boolean) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, Boolean) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, Boolean) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, Boolean) Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, Boolean) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, Boolean) Attribute.Equals(Object) Attribute.GetHashCode() Attribute.Match(Object) Attribute.IsDefaultAttribute() Attribute._Attribute.GetTypeInfoCount(UInt32) Attribute._Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) Attribute._Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) Attribute._Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) Attribute.TypeId Object.ToString() Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetType() Object.MemberwiseClone() Namespace : IPA.Config Assembly : IPA.Loader.dll Syntax public class NameAttribute : Attribute, _Attribute Constructors | Improve this Doc View Source NameAttribute(String) Constructs the attribute with a specific name. Declaration public NameAttribute(string name) Parameters Type Name Description String name the name to use for the config. Properties | Improve this Doc View Source Name The name to use for the config. Declaration public string Name { get; } Property Value Type Description String the name to use for the config Implements System.Runtime.InteropServices._Attribute Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/BSIPA_ModList.UI.ViewControllers.html": {
|
|
"href": "api/BSIPA_ModList.UI.ViewControllers.html",
|
|
"title": "Namespace BSIPA_ModList.UI.ViewControllers",
|
|
"keywords": "Namespace BSIPA_ModList.UI.ViewControllers Classes MarkdownView A UI component that renders CommonMark Markdown in-game."
|
|
},
|
|
"api/IPA.html": {
|
|
"href": "api/IPA.html",
|
|
"title": "Namespace IPA",
|
|
"keywords": "Namespace IPA Classes ModsaberModInfo A class to provide information about a mod on ModSaber.ML Interfaces IBeatSaberPlugin Interface for Beat Saber plugins. Every class that implements this will be loaded if the DLL is placed at data/Managed/Plugins. IDisablablePlugin Provides methods to allow runtime enabling and disabling of a plugin. IEnhancedBeatSaberPlugin An enhanced version of a standard BeatSaber plugin. IGenericEnhancedPlugin A generic interface for the modification for enhanced plugins."
|
|
},
|
|
"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 Version GameVersion { get; } Property Value Type Description SemVer.Version 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.SetPrivateField(String, Object) ReflectionUtil.GetPrivateField<T>(String) ReflectionUtil.SetPrivateProperty(String, Object) ReflectionUtil.InvokePrivateMethod(String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(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.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, 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.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, 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. 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. Undefined Used for when the level is undefined. WarningOnly Only shows Warning messages. WarningUp Shows all messages warning and up. Extension Methods ReflectionUtil.SetPrivateField(String, Object) ReflectionUtil.GetPrivateField<T>(String) ReflectionUtil.SetPrivateProperty(String, Object) ReflectionUtil.InvokePrivateMethod(String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(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. Warning A warning message. Extension Methods ReflectionUtil.SetPrivateField(String, Object) ReflectionUtil.GetPrivateField<T>(String) ReflectionUtil.SetPrivateProperty(String, Object) ReflectionUtil.InvokePrivateMethod(String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(String, Object[])"
|
|
},
|
|
"api/IPA.Loader.PluginLoader.PluginInfo.html": {
|
|
"href": "api/IPA.Loader.PluginLoader.PluginInfo.html",
|
|
"title": "Class PluginLoader.PluginInfo",
|
|
"keywords": "Class PluginLoader.PluginInfo A container object for all the data relating to a plugin. Inheritance Object PluginLoader.PluginInfo Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public class PluginInfo Properties | Improve this Doc View Source Metadata Metadata for the plugin. Declaration public PluginLoader.PluginMetadata Metadata { get; } Property Value Type Description PluginLoader.PluginMetadata the metadata for this plugin Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.Loader.PluginInitInjector.html": {
|
|
"href": "api/IPA.Loader.PluginInitInjector.html",
|
|
"title": "Class PluginInitInjector",
|
|
"keywords": "Class PluginInitInjector The type that handles value injecting into a plugin's Init. Inheritance Object PluginInitInjector Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader Assembly : IPA.Loader.dll Syntax public static class PluginInitInjector Methods | Improve this Doc View Source AddInjector(Type, PluginInitInjector.InjectParameter) Adds an injector to be used when calling future plugins' Init methods. Declaration public static void AddInjector(Type type, PluginInitInjector.InjectParameter injector) Parameters Type Name Description Type type the type of the parameter. PluginInitInjector.InjectParameter injector the function to call for injection."
|
|
},
|
|
"api/IPA.Loader.Features.Feature.html": {
|
|
"href": "api/IPA.Loader.Features.Feature.html",
|
|
"title": "Class Feature",
|
|
"keywords": "Class Feature The root interface for a mod Feature. Inheritance Object Feature Inherited Members Object.ToString() Object.Equals(Object) Object.Equals(Object, Object) Object.ReferenceEquals(Object, Object) Object.GetHashCode() Object.GetType() Object.MemberwiseClone() Namespace : IPA.Loader.Features Assembly : IPA.Loader.dll Syntax public abstract class Feature Remarks Avoid storing any data in any subclasses. If you do, it may result in a failure to load the feature. Properties | Improve this Doc View Source InvalidMessage The message to be logged when the feature is not valid for a plugin. This should also be set whenever either BeforeLoad(PluginLoader.PluginMetadata) or BeforeInit(PluginLoader.PluginInfo) returns false. Declaration public virtual string InvalidMessage { get; protected set; } Property Value Type Description String the message to show when the feature is marked invalid | Improve this Doc View Source StoreOnPlugin Defines whether or not this feature will be accessible from the plugin metadata once loaded. Declaration protected virtual bool StoreOnPlugin { get; } Property Value Type Description Boolean true if this Feature will be stored on the plugin metadata, false otherwise Methods | Improve this Doc View Source AfterInit(PluginLoader.PluginInfo) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginLoader.PluginInfo plugin) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin that was just initialized | Improve this Doc View Source AfterInit(PluginLoader.PluginInfo, IBeatSaberPlugin) Called after a plugin has been fully initialized, whether or not there is an Init method. This should never throw an exception. Declaration public virtual void AfterInit(PluginLoader.PluginInfo plugin, IBeatSaberPlugin pluginInstance) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin that was just initialized IBeatSaberPlugin pluginInstance the instance of the plugin being initialized | Improve this Doc View Source BeforeInit(PluginLoader.PluginInfo) Called before a plugin's Init method is called. This will not be called if there is no Init method. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeInit(PluginLoader.PluginInfo plugin) Parameters Type Name Description PluginLoader.PluginInfo plugin the plugin to be initialized Returns Type Description Boolean whether or not to call the Init method | Improve this Doc View Source BeforeLoad(PluginLoader.PluginMetadata) Called before a plugin is loaded. This should never throw an exception. An exception will abort the loading of the plugin with an error. Declaration public virtual bool BeforeLoad(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin about to be loaded Returns Type Description Boolean whether or not the plugin should be loaded Remarks The assembly will still be loaded, but the plugin will not be constructed if this returns false . Any features it defines, for example, will still be loaded. | Improve this Doc View Source Evaluate() Evaluates the Feature for use in conditional meta-Features. This should be re-calculated on every call, unless it can be proven to not change. This will be called on every feature that returns true from Initialize(PluginLoader.PluginMetadata, String[]) Declaration public virtual bool Evaluate() Returns Type Description Boolean the truthiness of the Feature. | Improve this Doc View Source Initialize(PluginLoader.PluginMetadata, String[]) Initializes the feature with the parameters provided in the definition. Note: When no parenthesis are provided, parameters is an empty array. Declaration public abstract bool Initialize(PluginLoader.PluginMetadata meta, string[] parameters) Parameters Type Name Description PluginLoader.PluginMetadata meta the metadata of the plugin that is being prepared String [] parameters the parameters passed to the feature definition, or null Returns Type Description Boolean true if the feature is valid for the plugin, false otherwise Remarks This gets called BEFORE your Init method. Returning false does not prevent the plugin from being loaded. It simply prevents the feature from being used. | Improve this Doc View Source RequireLoaded(PluginLoader.PluginMetadata) Ensures a plugin's assembly is loaded. Do not use unless you need to. Declaration protected void RequireLoaded(PluginLoader.PluginMetadata plugin) Parameters Type Name Description PluginLoader.PluginMetadata plugin the plugin to ensure is loaded. Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"api/IPA.IEnhancedBeatSaberPlugin.html": {
|
|
"href": "api/IPA.IEnhancedBeatSaberPlugin.html",
|
|
"title": "Interface IEnhancedBeatSaberPlugin",
|
|
"keywords": "Interface IEnhancedBeatSaberPlugin An enhanced version of a standard BeatSaber plugin. Inherited Members IBeatSaberPlugin.OnApplicationStart() IBeatSaberPlugin.OnApplicationQuit() IBeatSaberPlugin.OnUpdate() IBeatSaberPlugin.OnFixedUpdate() IBeatSaberPlugin.OnSceneLoaded(Scene, LoadSceneMode) IBeatSaberPlugin.OnSceneUnloaded(Scene) IBeatSaberPlugin.OnActiveSceneChanged(Scene, Scene) IGenericEnhancedPlugin.Filter IGenericEnhancedPlugin.OnLateUpdate() Namespace : IPA Assembly : IPA.Loader.dll Syntax public interface IEnhancedBeatSaberPlugin : IBeatSaberPlugin, IGenericEnhancedPlugin Extension Methods ReflectionUtil.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[])"
|
|
},
|
|
"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<T>() UnityEngine.Component.GetComponent(System.String) UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentInChildren(System.Type) UnityEngine.Component.GetComponentInChildren<T>(System.Boolean) UnityEngine.Component.GetComponentInChildren<T>() UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInChildren(System.Type) UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean) UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>) UnityEngine.Component.GetComponentsInChildren<T>() UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>) UnityEngine.Component.GetComponentInParent(System.Type) UnityEngine.Component.GetComponentInParent<T>() UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean) UnityEngine.Component.GetComponentsInParent(System.Type) UnityEngine.Component.GetComponentsInParent<T>(System.Boolean) UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>) UnityEngine.Component.GetComponentsInParent<T>() UnityEngine.Component.GetComponents(System.Type) UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>) UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>) UnityEngine.Component.GetComponents<T>() 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>(T) UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion) UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform) UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform) UnityEngine.Object.Instantiate<T>(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<T>() UnityEngine.Object.FindObjectOfType<T>() 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 correctly. 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<string, bool> 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.SetPrivateField(Object, String, Object) ReflectionUtil.GetPrivateField<T>(Object, String) ReflectionUtil.SetPrivateProperty(Object, String, Object) ReflectionUtil.InvokePrivateMethod(Object, String, Object[]) ReflectionUtil.InvokePrivateMethod<T>(Object, String, Object[]) ReflectionUtil.CopyComponent(Component, Type, GameObject, Type) ReflectionUtil.CopyComponent<T>(Component, GameObject, Type)"
|
|
}
|
|
}
|