C# Class Nexus.Client.Mods.Formats.OMod.OModFormat

Describes the OMod mod format.
This is the mod format that is commonly used for Oblivion mods. This format was introduced with the Oblivion Mod Manager (OBMM).
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.

GetModCompressor ( IEnvironmentInfo p_eifEnvironmentInfo ) : IModCompressor

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

OModFormat ( IModCacheManager p_mcmModCacheManager, IScriptTypeRegistry p_stgScriptTypeRegistry ) : System

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

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 The game mode creating the mod.
return IMod

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

OModFormat() public method

A simple constructor that initializes the object with the required dependencies.
public OModFormat ( 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