C# Class Nexus.Client.Mods.Formats.FOMod.FOModFormat

Describes the FOMod mod format.

This is the mod format that is commonly used for Fallout 3 and Fallout: New Vegas mods. This format was introduced with the Fallout Mod Manager (FOMM).

Inheritance: IModFormat

Exibir arquivo Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
CheckFormatCompliance ( string p_strPath ) : FormatConfidence	Determines if the specified file in a mod that conforms to the current format.
CreateMod ( string p_strPath, IGameMode p_gmdGameMode ) : IMod	Creates a mod from the specified file. The specified file must be in the current format.
FOModFormat ( IModCacheManager p_mcmModCacheManager, IScriptTypeRegistry p_stgScriptTypeRegistry ) : System	A simple constructor that initializes the object with the required dependencies.
GetModCompressor ( IEnvironmentInfo p_eifEnvironmentInfo ) : IModCompressor	Gets a IModCompressor that can compress a source folder into a mod of the current format.

Method Details

CheckFormatCompliance() public method

Determines if the specified file in a mod that conforms to the current format.

public CheckFormatCompliance ( string p_strPath ) : FormatConfidence
p_strPath	string	The path of the file for which it is to be determined whether it confroms /// to the current format.
return	FormatConfidence

CreateMod() public method

Creates a mod from the specified file.

The specified file must be in the current format.

public CreateMod ( string p_strPath, IGameMode p_gmdGameMode ) : IMod
p_strPath	string	The path of the file from which to create an .
p_gmdGameMode	IGameMode
return	IMod

FOModFormat() public method

A simple constructor that initializes the object with the required dependencies.

public FOModFormat ( IModCacheManager p_mcmModCacheManager, IScriptTypeRegistry p_stgScriptTypeRegistry ) : System
p_mcmModCacheManager	IModCacheManager	The manager for the current game mode's mod cache.
p_stgScriptTypeRegistry	IScriptTypeRegistry	The registry of supported script types.
return	System

GetModCompressor() public method

Gets a IModCompressor that can compress a source folder into a mod of the current format.

public GetModCompressor ( IEnvironmentInfo p_eifEnvironmentInfo ) : IModCompressor
p_eifEnvironmentInfo	IEnvironmentInfo	The application's envrionment info.
return	IModCompressor