C# Class Nexus.Client.ModManagement.ModActivator

Activates mods.

Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
Activate ( IMod p_modMod, ConfirmModUpgradeDelegate p_dlgUpgradeConfirmationDelegate, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate, ReadOnlyObservableList p_rolActiveMods ) : IBackgroundTaskSet	Activates the given mod. The given mod is either installed or upgraded, as appropriate.
ForceUpgrade ( IMod p_modOldMod, IMod p_modNewMod, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IBackgroundTaskSet	Forces an upgrade from one mod to another. No checks as to whether the two mods are actually related are performed. The new mod is reactivated as if it were the old mod, and the old mod is replaced by the new mod.
ModActivator ( IInstallLog p_ilgInstallLog, Nexus.Client.ModManagement.ModInstallerFactory p_mifInstallerFactory ) : System	A simple constructor that initializes the object with the given values.
Reactivate ( IMod p_modMod, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IBackgroundTaskSet	Reactivates the given mod. A reactivation is an upgrade of a mod to itself. It re-runs the activation, without changing the installed precedence of its files and installed values.

Method Details

Activate() public method

Activates the given mod.

The given mod is either installed or upgraded, as appropriate.

public Activate ( IMod p_modMod, ConfirmModUpgradeDelegate p_dlgUpgradeConfirmationDelegate, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate, ReadOnlyObservableList p_rolActiveMods ) : IBackgroundTaskSet
p_modMod	IMod	The mod to install.
p_dlgUpgradeConfirmationDelegate	ConfirmModUpgradeDelegate	The delegate that is called to confirm whether an upgrade install should be performed.
p_dlgOverwriteConfirmationDelegate	ConfirmItemOverwriteDelegate	The method to call in order to confirm an overwrite.
p_rolActiveMods	ReadOnlyObservableList	The list of active mods.
return	IBackgroundTaskSet

ForceUpgrade() public method

Forces an upgrade from one mod to another.

No checks as to whether the two mods are actually related are performed. The new mod is reactivated as if it were the old mod, and the old mod is replaced by the new mod.

Thrown if is already active.

public ForceUpgrade ( IMod p_modOldMod, IMod p_modNewMod, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IBackgroundTaskSet
p_modOldMod	IMod	The mod from which to upgrade.
p_modNewMod	IMod	The mod to which to upgrade.
p_dlgOverwriteConfirmationDelegate	ConfirmItemOverwriteDelegate	The method to call in order to confirm an overwrite.
return	IBackgroundTaskSet

ModActivator() public method

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

public ModActivator ( IInstallLog p_ilgInstallLog, Nexus.Client.ModManagement.ModInstallerFactory p_mifInstallerFactory ) : System
p_ilgInstallLog	IInstallLog	The install log to use to log file installations.
p_mifInstallerFactory	Nexus.Client.ModManagement.ModInstallerFactory	The factory to use to create mod installers.
return	System

Reactivate() public method

Reactivates the given mod.

A reactivation is an upgrade of a mod to itself. It re-runs the activation, without changing the installed precedence of its files and installed values.

public Reactivate ( IMod p_modMod, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IBackgroundTaskSet
p_modMod	IMod	The mod to reactivate.
p_dlgOverwriteConfirmationDelegate	ConfirmItemOverwriteDelegate	The method to call in order to confirm an overwrite.
return	IBackgroundTaskSet