C# Class Nexus.Client.ModManagement.InstallationLog.InstallLog.DummyMod

A dummy mod that can be used as a placeholder.

Inheritance: ObservableObject, IMod

Public Methods

Method	Description
BeginReadOnlyTransaction ( FileUtil p_futFileUtil ) : void	Starts a read-only transaction. This puts the Mod into read-only mode. Read-only mode can greatly increase the speed at which multiple file are extracted.
DummyMod ( string p_strName, string p_strFileName ) : System	A simple constructor that initializes the object with the given values.
DummyMod ( string p_strName, string p_strFileName, System.Version p_verMachineVersion, string p_strHumanReadableVersion, string p_strLastKnownVersion, string p_strInstallDate ) : System	A simple constructor that initializes the object with the given values.
EndReadOnlyTransaction ( ) : void	Ends a read-only transaction. This takes the Mod out of read-only mode. Read-only mode can greatly increase the speed at which multiple file are extracted.
GetFile ( string p_strFile ) : byte[]	Retrieves the specified file from the mod.
GetFileList ( ) : List	Retrieves the list of files in this Mod.
GetFileList ( string p_strFolderPath, bool p_booRecurse ) : List	Retrieves the list of all files in the specified Mod folder.
IsMatchingVersion ( ) : bool	Determines if last known version is the same as the current version.
UpdateInfo ( IModInfo p_mifInfo, bool p_booOverwriteAllValues ) : void	Updates the object's proerties to the values of the given IModInfo.

Starts a read-only transaction.

This puts the Mod into read-only mode. Read-only mode can greatly increase the speed at which multiple file are extracted.

public BeginReadOnlyTransaction ( FileUtil p_futFileUtil ) : void
p_futFileUtil	Nexus.Client.Util.FileUtil
return	void

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

public DummyMod ( string p_strName, string p_strFileName ) : System
p_strName	string	The name of the dummy mod.
p_strFileName	string	The filename of the dummy mod.
return	System

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

public DummyMod ( string p_strName, string p_strFileName, System.Version p_verMachineVersion, string p_strHumanReadableVersion, string p_strLastKnownVersion, string p_strInstallDate ) : System
p_strName	string	The name of the dummy mod.
p_strFileName	string	The filename of the dummy mod.
p_verMachineVersion	System.Version	The version of the mod.
p_strHumanReadableVersion	string	The human readable form of the mod's version.
p_strLastKnownVersion	string	The the last known mod version.
p_strInstallDate	string	The install date of the mod.
return	System

Ends a read-only transaction.

This takes the Mod out of read-only mode. Read-only mode can greatly increase the speed at which multiple file are extracted.

public EndReadOnlyTransaction ( ) : void
return	void

Retrieves the specified file from the mod.

Thrown if the specified file /// is not in the mod.

public GetFile ( string p_strFile ) : byte[]
p_strFile	string	The file to retrieve.
return	byte[]

Retrieves the list of files in this Mod.

public GetFileList ( ) : List
return	List

Retrieves the list of all files in the specified Mod folder.

public GetFileList ( string p_strFolderPath, bool p_booRecurse ) : List
p_strFolderPath	string	The Mod folder whose file list is to be retrieved.
p_booRecurse	bool	Whether to return files that are in subdirectories of the given directory.
return	List

Determines if last known version is the same as the current version.

public IsMatchingVersion ( ) : bool
return	bool

Updates the object's proerties to the values of the given IModInfo.

public UpdateInfo ( IModInfo p_mifInfo, bool p_booOverwriteAllValues ) : void
p_mifInfo	IModInfo	The whose values /// are to be used to update this object's properties.
p_booOverwriteAllValues	bool	Whether to overwrite the current info values, /// or just the empty ones.
return	void