C# Class Nexus.Client.ModManagement.ModUpgrader

Installs a mod as an upgrade.
An upgrade installs the mod without changing the owners of installed files and other items.
Inheritance: ModInstaller
Mostra file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
ModUpgrader ( IMod p_modOldMod, IMod p_modNewMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, FileUtil p_futFileUtility, SynchronizationContext p_scxUIContext, IInstallLog p_ilgModInstallLog, IPluginManager p_pmgPluginManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : System

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

Protected Methods

Method Description
CreateFileInstaller ( TxFileManager p_tfmFileManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IModFileInstaller

Creates the file installer to use to install the mod's files.

This returns the upgrade ModFileUpgradeInstaller.

CreateGameSpecificValueInstaller ( TxFileManager p_tfmFileManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IGameSpecificValueInstaller

Creates the file installer to use to install the mod's game specific value edits.

This returns an upgrade IGameSpecificValueInstaller.

CreateIniInstaller ( TxFileManager p_tfmFileManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IIniInstaller

Creates the file installer to use to install the mod's ini edits.

This returns the upgrade IniUpgradeInstaller.

RegisterMod ( ) : void

Registers the mod being upgraded with the install log.

Method Details

CreateFileInstaller() protected method

Creates the file installer to use to install the mod's files.
This returns the upgrade ModFileUpgradeInstaller.
protected CreateFileInstaller ( TxFileManager p_tfmFileManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IModFileInstaller
p_tfmFileManager ChinhDo.Transactions.TxFileManager The transactional file manager to use to interact with the file system.
p_dlgOverwriteConfirmationDelegate ConfirmItemOverwriteDelegate The method to call in order to confirm an overwrite.
return IModFileInstaller

CreateGameSpecificValueInstaller() protected method

Creates the file installer to use to install the mod's game specific value edits.
This returns an upgrade IGameSpecificValueInstaller.
protected CreateGameSpecificValueInstaller ( TxFileManager p_tfmFileManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IGameSpecificValueInstaller
p_tfmFileManager ChinhDo.Transactions.TxFileManager The transactional file manager to use to interact with the file system.
p_dlgOverwriteConfirmationDelegate ConfirmItemOverwriteDelegate The method to call in order to confirm an overwrite.
return IGameSpecificValueInstaller

CreateIniInstaller() protected method

Creates the file installer to use to install the mod's ini edits.
This returns the upgrade IniUpgradeInstaller.
protected CreateIniInstaller ( TxFileManager p_tfmFileManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IIniInstaller
p_tfmFileManager ChinhDo.Transactions.TxFileManager The transactional file manager to use to interact with the file system.
p_dlgOverwriteConfirmationDelegate ConfirmItemOverwriteDelegate The method to call in order to confirm an overwrite.
return IIniInstaller

ModUpgrader() public method

A simple constructor that initializes the object with the given values.
public ModUpgrader ( IMod p_modOldMod, IMod p_modNewMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, FileUtil p_futFileUtility, SynchronizationContext p_scxUIContext, IInstallLog p_ilgModInstallLog, IPluginManager p_pmgPluginManager, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : System
p_modOldMod IMod The mod from which to upgrade.
p_modNewMod IMod The mod to which to upgrade.
p_gmdGameMode IGameMode The current game mode.
p_eifEnvironmentInfo IEnvironmentInfo The application's envrionment info.
p_futFileUtility Nexus.Client.Util.FileUtil The file utility class.
p_scxUIContext System.Threading.SynchronizationContext The to use to marshall UI interactions to the UI thread.
p_ilgModInstallLog IInstallLog The install log that tracks mod install info /// for the current game mode
p_pmgPluginManager IPluginManager The plugin manager.
p_dlgOverwriteConfirmationDelegate ConfirmItemOverwriteDelegate The method to call in order to confirm an overwrite.
return System

RegisterMod() protected method

Registers the mod being upgraded with the install log.
protected RegisterMod ( ) : void
return void