C# Class Nexus.Client.ModManagement.BasicInstallTask

Performs a standard mod installation.
A basic install installs all of the files in the mod to the installation directory, and activates all plugin files.
Inheritance: ThreadedBackgroundTask
Datei anzeigen Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
BasicInstallTask ( IMod p_modMod, IGameMode p_gmdGameMode, IModFileInstaller p_mfiFileInstaller, IPluginManager p_pmgPluginManager, bool p_booSkipReadme, ReadOnlyObservableList p_rolActiveMods ) : System

A simple constructor that initializes the object with the given values.

Execute ( ) : bool

Runs the basic install task.

Protected Methods

Method Description
ActivatePlugin ( string p_strPlugin ) : void
DoWork ( object p_objArgs ) : object

The method that is called to start the backgound task.

This method installs all of the files in the IMod being installed.

Method Details

ActivatePlugin() protected method

protected ActivatePlugin ( string p_strPlugin ) : void
p_strPlugin string
return void

BasicInstallTask() public method

A simple constructor that initializes the object with the given values.
public BasicInstallTask ( IMod p_modMod, IGameMode p_gmdGameMode, IModFileInstaller p_mfiFileInstaller, IPluginManager p_pmgPluginManager, bool p_booSkipReadme, ReadOnlyObservableList p_rolActiveMods ) : System
p_modMod IMod The mod being installed.
p_gmdGameMode IGameMode The the current game mode.
p_mfiFileInstaller IModFileInstaller The file installer to use.
p_pmgPluginManager IPluginManager The plugin manager.
p_booSkipReadme bool Whether to skip the installation of readme files.
p_rolActiveMods ReadOnlyObservableList The list of active mods.
return System

DoWork() protected method

The method that is called to start the backgound task.
This method installs all of the files in the IMod being installed.
protected DoWork ( object p_objArgs ) : object
p_objArgs object Arguments to for the task execution.
return object

Execute() public method

Runs the basic install task.
public Execute ( ) : bool
return bool