C# Class Nexus.Client.ModManagement.BasicUninstallTask

Performs a standard mod uninstallation.
A basic uninstall uninstalls all of the changes made when the mod was installed.
Inheritance: BackgroundTask
Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Properties

Property Type Description
strPopupErrorMessageType string

Public Methods

Method Description
BasicUninstallTask ( IMod p_modMod, InstallerGroup p_igpInstallers, IInstallLog p_ilgModInstallLog, IGameMode p_gmdGameMode, ReadOnlyObservableList p_rolActiveMods ) : System

A simple constructor that initializes the object with the given values.
Execute ( ) : bool

Runs the uninstall task.

Protected Methods

Method Description
UninstallFiles ( ) : bool

Performs the actual uninstallation.

Method Details

BasicUninstallTask() public method

A simple constructor that initializes the object with the given values.
public BasicUninstallTask ( IMod p_modMod, InstallerGroup p_igpInstallers, IInstallLog p_ilgModInstallLog, IGameMode p_gmdGameMode, ReadOnlyObservableList p_rolActiveMods ) : System
p_modMod IMod The mod being installed.
p_igpInstallers InstallerGroup The utility class to use to install the mod items.
p_ilgModInstallLog IInstallLog The install log that tracks mod install info /// for the current game mode
p_gmdGameMode IGameMode The the current game mode.
p_rolActiveMods ReadOnlyObservableList The list of active mods.
return System

Execute() public method

Runs the uninstall task.
public Execute ( ) : bool
return bool

UninstallFiles() protected method

Performs the actual uninstallation.
protected UninstallFiles ( ) : bool
return bool

Property Details

strPopupErrorMessageType public property

public string strPopupErrorMessageType
return string