+
A UI component that renders Markdown in-game.
+A UI component that renders CommonMark Markdown in-game.
This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly.
@@ -416,7 +426,7 @@ public class MarkdownView : MonoBehavioura delegate for the function to call
The text to be rendered.
+the text to render as Markdown
+When this is assigned, the object is marked dirty. It will re-render on the next Update tick.
++
A UI component that renders Markdown in-game.
+A UI component that renders CommonMark Markdown in-game.
+
Specifies a preferred config name, instead of using the plugin's name.
+Specifies a preferred config name, instead of using the plugin's name.
the name to use for the config.
+
Constructs the attribute with a specific preference list. Each entry is the extension without a '.'
+Constructs the attribute with a specific preference list. Each entry is the extension without a '.'
The preferences in order of preference.
The order of preference for the config type.
+The order of preference for the config type.
+
the extension associated with this type, without the '.'
+the extension associated with this type, without the '.'
The extension associated with this type, without the '.'
+The extension associated with this type, without the '.'
+
the name of the mod for this config
the preferred config types to try to get
an action to perform on value change
the type to register
+
a dynamically bound object to use to access config values directly
the extensionless filename to save to
true if object has changed since the last save, else false
-true if the data in memory has been changed, else false
-the last time the config file was modified
+
Allows to get and set preferences for your mod.
+Allows to get and set preferences for your mod.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Section of the key.
Name of the key.
Value that should be written.
Section of the key.
Name of the key.
Value that should be written.
Section of the key.
Name of the key.
Value that should be written.
Section of the key.
Name of the key.
Value that should be written.
+
Allows to get and set preferences for your mod.
+Allows to get and set preferences for your mod.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Value that should be used when no value is found.
Whether or not the default value should be written if no value is found.
Section of the key.
Name of the key.
Section of the key.
Name of the key.
Value that should be written.
Section of the key.
Name of the key.
Value that should be written.
Section of the key.
Name of the key.
Value that should be written.
Section of the key.
Name of the key.
Value that should be written.
+
A class to handle updating ConfigProviders automatically
Specifies a preferred config name, instead of using the plugin's name.
+Specifies a preferred config name, instead of using the plugin's name.
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.
@@ -90,7 +100,7 @@Defines the type of the IConfigProvider
Allows to get and set preferences for your mod.
+Allows to get and set preferences for your mod.
An interface for configuration providers.
Allows to get and set preferences for your mod.
+Allows to get and set preferences for your mod.
+
+
+
+
+
the message to show when the feature is marked invalid
true if this Feature will be stored on the plugin metadata, false otherwise
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.
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.
whether or not to call the Init method
whether or not the plugin should be loaded
the truthiness of the Feature.
the parameters passed to the feature definition, or null
true if the feature is valid for the plugin, false otherwise
Ensures a plugin's assembly is loaded. Do not use unless you need to.
+Ensures a plugin's assembly is loaded. Do not use unless you need to.
+
+
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.
+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.
the previous return value of the function, or null if never called for plugin.
the System.Reflection.ParameterInfo of the parameter being injected.
+the ParameterInfo of the parameter being injected.
the value to inject into that parameter.
+
The type that handles value injecting into a plugin's Init.
+The type that handles value injecting into a plugin's Init.
Adds an injector to be used when calling future plugins' Init methods.
+Adds an injector to be used when calling future plugins' Init methods.
the type of the parameter.
+
+
the loaded Assembly that contains the plugin main type
the list of features requested by the plugin
the file the plugin was loaded from
The BeatMods ID of the plugin, or null if it doesn't have one.
+The BeatMods ID of the plugin, or null if it doesn't have one.
the updater ID of the plugin
the name of the plugin
the readable printable metadata string
+
+
whether it needs a restart to take effect
+
whether it needs a restart to take effect
+
a collection of all enabled plugins as PluginLoader.PluginInfos
a collection of all disabled plugins as PluginLoader.PluginMetadata
An System.Collections.IEnumerable of old IPA plugins.
+An IEnumerable of old IPA plugins.
all legacy plugin instances
whether or not it needs a restart to enable
the ID, or name if the ID is null, of the plugin to disable
whether a restart is needed to activate
whether a restart is needed to activate
the ID, or name if the ID is null, of the plugin to enable
whether a restart is needed to activate
Gets a disabled plugin's metadata by its name.
+Gets a disabled plugin's metadata by its name.
the name of the disabled plugin to get
Gets a disabled plugin's metadata by its ID.
+Gets a disabled plugin's metadata by its ID.
the ID of the disabled plugin to get
the name of the plugin to get (must be an exact match)
the ID name of the plugin to get (must be an exact match)
the ModSaber name of the plugin to get (must be an exact match)
Converts a plugin's metadata to a PluginLoader.PluginInfo.
+Converts a plugin's metadata to a PluginLoader.PluginInfo.
true if the plugin is disabled, false otherwise.
true if the plugin is enabled, false otherwise.
+
The type that handles value injecting into a plugin's Init.
+The type that handles value injecting into a plugin's Init.
A type to manage the loading of plugins.
@@ -95,7 +105,7 @@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.
+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.
An invoker for the PluginDisabled event.
diff --git a/api/IPA.Logging.LogPrinter.html b/api/IPA.Logging.LogPrinter.html index 3daca7e6..b347706d 100644 --- a/api/IPA.Logging.LogPrinter.html +++ b/api/IPA.Logging.LogPrinter.html @@ -16,12 +16,12 @@ - + - - + ++
The log printer's base class.
+The log printer's base class.
the time the message was composed
the name of the log that created this message
the message
+
+
+
the format for the standard loggers to print in
Log(Level.Critical, e);
the exception to log
Log(Level.Critical, message);
the message to log
Log(Level.Debug, e);
the exception to log
Log(Level.Debug, message);
the message to log
Log(Level.Error, e);
the exception to log
Log(Level.Error, message);
the message to log
Log(Level.Info, e);
the exception to log
Log(Level.Info, message);
the message to log
Log(Level.Info, message);
the exception to log
Log(Level.Info, message);
the message to log
Log(Level.Notice, e);
the exception to log
Log(Level.Notice, message);
the message to log
Log(Level.Warning, e);
the exception to log
Log(Level.Warning, message);
the message to log
+
the name of the child
+
the color to print this message as
the System.DateTime the message was recorded at
+the DateTime the message was recorded at
the name of the log that sent the message
the message to print
+
the System.DateTime the message was recorded at
+the DateTime the message was recorded at
the name of the log that sent the message
the message to print
+
The System.IO.StreamWriter that writes to the GZip file.
+The StreamWriter that writes to the GZip file.
the writer to the underlying filestream
does nothing
Gets the System.IO.FileInfo for the file to write to.
+Gets the FileInfo for the file to write to.
the file to write to
+
Gets the System.IO.FileInfo for the target file.
+Gets the FileInfo for the target file.
the target file to write to
the System.DateTime the message was recorded at
+the DateTime the message was recorded at
the name of the log that sent the message
the message to print
+
the name of the logger
Gets the System.IO.FileInfo for the target file.
+Gets the FileInfo for the target file.
the file to write to
the System.DateTime the message was recorded at
+the DateTime the message was recorded at
the name of the log that sent the message
the message to print
+
the name of the main logger
the name of the logger
Gets the System.IO.FileInfo for the target file.
+Gets the FileInfo for the target file.
the file to write to
the System.DateTime the message was recorded at
+the DateTime the message was recorded at
the name of the log that sent the message
the message to print
+
+
The System.IO.TextWriter for writing directly to the console window, or stdout if no window open.
+The TextWriter for writing directly to the console window, or stdout if no window open.
a System.IO.TextWriter for the current primary text output
+a TextWriter for the current primary text output
the message to log
the message to log
+
A class providing extensions for various loggers.
The log printer's base class.
+The log printer's base class.
The default (and standard) Logger implementation.
diff --git a/api/IPA.ModsaberModInfo.html b/api/IPA.ModsaberModInfo.html index 09b30392..98f8d044 100644 --- a/api/IPA.ModsaberModInfo.html +++ b/api/IPA.ModsaberModInfo.html @@ -16,12 +16,12 @@ - + - - + ++
+
+
+
+
+
the path of the game install directory
the path to the library directory
the path to the native library directory
the path to the plugin directory
the path to the user data directory
+
Gets the default value for a given System.Type.
+Gets the default value for a given Type.
the System.Type to get the default value for
+the Type to get the default value for
the default value of type
Unwraps a System.Nullable<T> where T is System.Boolean such that if the value is null, it gives false.
+Unwraps a Nullable<T> where T is Boolean such that if the value is null, it gives false.
the bool? to unwrap
the unwrapped value, or false if it was null
+
the error held in this Ref<T>
the value of the comparison
the value of the comparison
+
+
the type name
the assembly the type is in
the name of the method to call
the type signature of the method
the method parameters
the result of the call
the object type
the name of the method to call
the type signature
the parameters
the result of the call
the object type
the name of the method to call
the type signature
the parameters
the new component's type
+the new component's type
overrides the source component type (for example, to a superclass)
A generic version of CopyComponent(Component, Type, GameObject, Type).
+A generic version of CopyComponent(Component, Type, GameObject, Type).
overrides the source component type (for example, to a superclass)
the object instance to pull from
the name of the field to read
the object to call from
the method name
the method parameters
the return value
the object to call from
the method name to call
the method's parameters
+the method's parameters
the object instance
the field to set
the value to set it to
the target object instance
the name of the property
the value to set it to
+
the byte array
the hex form of the array
the source directory
the destination directory
the filename of the file to append together
a delegate called when there is an error copying. Return true to keep going.
the file to relativize
the source folder
a path to get from folder to file
the hex stream
the corresponding byte array
array 1
array 2
whether or not they are byte-for-byte equal
+
+
+
TODO: Add .NET projects to the src folder and run docfx to generate REAL 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.
+
TODO
+
The game-agnostic mod injector for Unity, that happens to have been written for Beat Saber!
-Take a look at the getting started guide to see how to get going.
+Take a look at Getting Started to see how to get going.
TODO: finish