ModDirectory Class |
Helper class used to manage a local directory where mods are located.
Helps developers to manage a specific directory where mods should be installed.
Inheritance HierarchyNamespace: UMod
Assembly: UMod (in UMod.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class ModDirectory
The ModDirectory type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ModDirectory(DirectoryInfo, Boolean, Boolean) | Initializes a new instance of the ModDirectory class |
| ModDirectory(String, Boolean, Boolean) | Initializes a new instance of the ModDirectory class |
Properties| Name | Description | |
|---|---|---|
 | AllowSubDirectories |
Should sub folders of Location also be detected.
When true, sub folders will be checked reccursivley as well as the target folder.
|
| CaseSensitive |
Are mod name searches case sensitive.
Default is false.
|
| Exists |
Check whether the target mod directory actually exists.
The directory should exists otherwise you may receive DirectoryNotFoundException when calling associated methods.
|
| HasMods |
Allows the developer to determine whether any mods are installed.
This property will return true if there are any mods located in the Location directory.
|
| Location |
Get the DirectoryInfo for this current ModDirectory.
|
| ModCount |
Allows the devloper to determine how many mods are installed.
Get the number of mods that are inside the directory.
|
Methods| Name | Description | |
|---|---|---|
| Create |
Attempts to create the mod directory at the file system Location.
The mod directory should exist before calling other associated methods.
|
 | GetMod(FileInfo) | |
| GetMod(Byte, String) | |
| GetMod(String, String) | |
| GetMod(ModIdentifier, String) | |
| GetModNameFromPath | |
| GetModNames | |
| GetModPath(FileInfo) | |
| GetModPath(Byte, String) | |
| GetModPath(String, String) | |
| GetModPath(ModIdentifier, String) | |
| GetModPaths | |
| GetModPaths(String) | |
| GetMods | |
| GetMods(String) | |
| InstallModFrom | |
| InstallModFromAsync | |
| IsModFile |
Returns true if the specified FileInfo is a valid mod file.
|
| IsModInstalled(Byte, String) | |
| IsModInstalled(String, String) |
Attempts to search through the mod directory looking for a mod with the specified name and version.
If a mod with the specified name and version was found then the return value will be true.
|
| IsModInstalled(ModIdentifier, String) | |
| Refresh |
Refreshes the directory location in order to detect newly added mods.
If you add a new mod into the directory location then you will need to call this method in order for it to be detcted and returned by all other methods.
|
See Also