 | ModManager Class |
A manager for loading, executing, configuring, unloading mods and loading resources from them.
Inheritance HierarchyNamespace: Kit.Modding
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0
SyntaxThe ModManager type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | ActiveMods | List of all loaded and enabled mods. |
| Mods | Returns the list of all loaded mods, enabled or disabled. |
Methods| Name | Description | |
|---|---|---|
 | AddGroup | Add a mod group. |
| ClearCache | Clear the cache. |
| DisableMod | Disable a mod. |
| EnableMod | Enable a mod. |
| ExecuteScripts | Execute all mod scripts. |
| ExecuteScriptsAsync | Execute all mod scripts asynchronously. |
| GetModdingPath(ResourceFolder) | Returns the relative path to a ResourceFolder. |
| GetModdingPath(ResourceFolder, String) | Returns the relative path to a file. |
| GetModOrder | Returns the load order of a mod. |
| GetModOrderInGroup | Returns the load order of a mod in a group. |
| GetModPathsByGroup | Returns potential mod locations by their group. |
| GetModsByGroup | Returns all mods in a given group |
| GetResourceInfo(Object) | Returns the information about a cached resource. |
| GetResourceInfo(Type, ResourceFolder, String) | Returns the information about a cached resource. |
| IsModEnabled | Returns whether a mod is enabled. |
| Load(Type, ResourceFolder, String) | Load a resource. |
| LoadT(ResourceFolder, String) | Load a resource. |
| LoadAll(Type, String) | Load a resource from all mods that have it. |
| LoadAll(Type, ResourceFolder, String) | Load a resource from all mods that have it. |
| LoadAllT(String) | Load a resource from all mods that have it. |
| LoadAllT(ResourceFolder, String) | Load a resource from all mods that have it. |
| LoadAllAsync(Type, String) | Load a resource from all mods that have it asynchronously. |
| LoadAllAsync(Type, ResourceFolder, String) | Load a resource from all mods that have it asynchronously. |
| LoadAllAsyncT(String) | Load a resource from all mods that have it asynchronously. |
| LoadAllAsyncT(ResourceFolder, String) | Load a resource from all mods that have it asynchronously. |
| LoadAsync(Type, ResourceFolder, String) | Load a resource asynchronously. |
| LoadAsyncT(ResourceFolder, String) | Load a resource asynchronously. |
| LoadMods(Boolean) | Load the mods. |
| LoadMods(DictionaryModGroup, String, Boolean) | Load the mods. |
| LoadModsAsync(Boolean) | Load the mods asynchronously. |
| LoadModsAsync(DictionaryModGroup, String, Boolean) | Load the mods asynchronously. |
| MoveModBottom | Move a mod to the bottom. |
| MoveModDown | Move a mod down. |
| MoveModOrder | Move a mod to a particular index. |
| MoveModTop | Move a mod to the top. |
| MoveModUp | Move a mod up. |
| ReadBytes(String) | Read the contents of a file in binary-mode. |
| ReadBytes(ResourceFolder, String) | Read the contents of a file in binary-mode. |
| ReadBytesAll(String) | Read contents of a file in binary-mode from all mods that have it. |
| ReadBytesAll(ResourceFolder, String) | Read contents of a file in binary-mode from all mods that have it. |
| ReadBytesAllAsync(String) | Read contents of a file in binary-mode asynchronously from all mods that have it. |
| ReadBytesAllAsync(ResourceFolder, String) | Read contents of a file in binary-mode asynchronously from all mods that have it. |
| ReadBytesAsync(String) | Read the contents of a file asynchronously in binary-mode. |
| ReadBytesAsync(ResourceFolder, String) | Read the contents of a file asynchronously in text-mode. |
| ReadText(String) | Read the contents of a file in text-mode. |
| ReadText(ResourceFolder, String) | Read the contents of a file in text-mode. |
| ReadTextAll(String) | Read contents of a file in text-mode from all mods that have it. |
| ReadTextAll(ResourceFolder, String) | Read contents of a file in text-mode from all mods that have it. |
| ReadTextAllAsync(String) | Read contents of a file in text-mode asynchronously from all mods that have it. |
| ReadTextAllAsync(ResourceFolder, String) | Read contents of a file in text-mode asynchronously from all mods that have it. |
| ReadTextAsync(String) | Read the contents of a file asynchronously in text-mode. |
| ReadTextAsync(ResourceFolder, String) | Read the contents of a file asynchronously in text-mode. |
| RemoveGroup | Remove a mod group. |
| ToggleMod(Mod) | Toggle a mod. |
| ToggleMod(Mod, Boolean) | Enable or disable a mod. |
| Unload(Object) | Unload a resource from cache and memory. |
| Unload(Type, ResourceFolder, String) | Unload a resource from cache and memory. |
| UnloadAll | Unload all resources loaded by a mod. |
| UnloadMod | Unload a mod. |
| UnloadMods | Unload all active mods. |
Events| Name | Description | |
|---|---|---|
 | ModLoaded | Event fired when a mod is loaded. |
| ModUnloaded | Event fired when a mod is unloaded. |
| ResourceLoaded | Event fired whenever a resource is loaded. Returns the folder, path, ResourceInfo, whether the resource was actually loaded or re-used from cache, respectively. |
| ResourceUnloaded | Event fired when a resource is unloaded. Returns the folder, path, and mod it was loaded with, respectively. |
Fields| Name | Description | |
|---|---|---|
 | Groups | |
| Loaders | All mod loaders registered with the system. |
| LogCategory | Category name to use for logging messages. |
| MetadataFile | Filename for the metadata file. |
See Also