C# Class Nexus.Client.Games.Gamebryo.GamebryoGameModeBase

Provides information required for the programme to manage Gamebryo based game plugins and mods.

Inheritance: GameModeBase

ファイルを表示 Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
GamebryoGameModeBase ( IEnvironmentInfo p_eifEnvironmentInfo, FileUtil p_futFileUtility ) : System	A simple constructor that initializes the object with the given values.
GetActivePluginLogSerializer ( IPluginOrderLog p_polPluginOrderLog ) : IActivePluginLogSerializer	Gets the serailizer that serializes and deserializes the list of active plugins for this game mode.
GetGameSpecificValueInstaller ( IMod p_modMod, IInstallLog p_ilgInstallLog, TxFileManager p_tfmFileManager, FileUtil p_futFileUtility, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IGameSpecificValueInstaller	Gets the installer to use to install game specific values.
GetGameSpecificValueUpgradeInstaller ( IMod p_modMod, IInstallLog p_ilgInstallLog, TxFileManager p_tfmFileManager, FileUtil p_futFileUtility, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IGameSpecificValueInstaller	Gets the installer to use to upgrade game specific values.
GetModFormatAdjustedPath ( IModFormat p_mftModFormat, string p_strPath ) : string	Adjusts the given path to be relative to the installation path of the game mode. This is basically a hack to allow older FOMod/OMods to work. Older FOMods assumed the installation path of Fallout games to be <games>/data, but this new manager specifies the installation path to be <games>. This breaks the older FOMods, so this method can detect the older FOMods (or other mod formats that needs massaging), and adjusts the given path to be relative to the new instaalation path to make things work.
GetPluginDiscoverer ( ) : IPluginDiscoverer	Gets the discoverer to use to find the plugins managed by this game mode.
GetPluginFactory ( ) : IPluginFactory	Gets the factory that builds plugins for this game mode.
GetPluginOrderLogSerializer ( ) : IPluginOrderLogSerializer	Gets the serializer that serializes and deserializes the plugin order for this game mode.
GetPluginOrderValidator ( ) : IPluginOrderValidator	Gets the object that validates plugin order for this game mode.
GetUpdaters ( ) : IEnumerable	Gets the updaters used by the game mode.
SortPlugins ( IList p_lstPlugins ) : string[]	Sorts the plugins.

Protected Methods

Method	Description
CreateSettingsFileContainer ( ) : GamebryoSettingsFiles	Instantiates the container to use to store the list of settings files.
Dispose ( bool p_booDisposing ) : void	Disposes of the unamanged resources.
SetupPluginManagement ( FileUtil p_futFileUtility ) : void	Setup for the plugin management libraries.
SetupSettingsFiles ( ) : void	Adds the settings files to the game mode's list.

Method Details

CreateSettingsFileContainer() protected abstract method

Instantiates the container to use to store the list of settings files.

protected abstract CreateSettingsFileContainer ( ) : GamebryoSettingsFiles
return	GamebryoSettingsFiles

Dispose() protected method

Disposes of the unamanged resources.

protected Dispose ( bool p_booDisposing ) : void
p_booDisposing	bool	Whether the method is being called from the method.
return	void

GamebryoGameModeBase() public method

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

public GamebryoGameModeBase ( IEnvironmentInfo p_eifEnvironmentInfo, FileUtil p_futFileUtility ) : System
p_eifEnvironmentInfo	IEnvironmentInfo	The application's environment info.
p_futFileUtility	Nexus.Client.Util.FileUtil	The file utility class to be used by the game mode.
return	System

GetActivePluginLogSerializer() public method

Gets the serailizer that serializes and deserializes the list of active plugins for this game mode.

public GetActivePluginLogSerializer ( IPluginOrderLog p_polPluginOrderLog ) : IActivePluginLogSerializer
p_polPluginOrderLog	IPluginOrderLog	The tracking plugin order for the current game mode.
return	IActivePluginLogSerializer

GetGameSpecificValueInstaller() public method

Gets the installer to use to install game specific values.

public GetGameSpecificValueInstaller ( IMod p_modMod, IInstallLog p_ilgInstallLog, TxFileManager p_tfmFileManager, FileUtil p_futFileUtility, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IGameSpecificValueInstaller
p_modMod	IMod	The mod being installed.
p_ilgInstallLog	IInstallLog	The install log to use to log the installation of the game specific values.
p_tfmFileManager	ChinhDo.Transactions.TxFileManager	The transactional file manager to use to interact with the file system.
p_futFileUtility	Nexus.Client.Util.FileUtil	The file utility class.
p_dlgOverwriteConfirmationDelegate	ConfirmItemOverwriteDelegate	The method to call in order to confirm an overwrite.
return	IGameSpecificValueInstaller

GetGameSpecificValueUpgradeInstaller() public method

Gets the installer to use to upgrade game specific values.

public GetGameSpecificValueUpgradeInstaller ( IMod p_modMod, IInstallLog p_ilgInstallLog, TxFileManager p_tfmFileManager, FileUtil p_futFileUtility, ConfirmItemOverwriteDelegate p_dlgOverwriteConfirmationDelegate ) : IGameSpecificValueInstaller
p_modMod	IMod	The mod being upgraded.
p_ilgInstallLog	IInstallLog	The install log to use to log the installation of the game specific values.
p_tfmFileManager	ChinhDo.Transactions.TxFileManager	The transactional file manager to use to interact with the file system.
p_futFileUtility	Nexus.Client.Util.FileUtil	The file utility class.
p_dlgOverwriteConfirmationDelegate	ConfirmItemOverwriteDelegate	The method to call in order to confirm an overwrite.
return	IGameSpecificValueInstaller

GetModFormatAdjustedPath() public method

Adjusts the given path to be relative to the installation path of the game mode.

This is basically a hack to allow older FOMod/OMods to work. Older FOMods assumed the installation path of Fallout games to be <games>/data, but this new manager specifies the installation path to be <games>. This breaks the older FOMods, so this method can detect the older FOMods (or other mod formats that needs massaging), and adjusts the given path to be relative to the new instaalation path to make things work.

public GetModFormatAdjustedPath ( IModFormat p_mftModFormat, string p_strPath ) : string
p_mftModFormat	IModFormat	The mod format for which to adjust the path.
p_strPath	string	The path to adjust
return	string

GetPluginDiscoverer() public method

Gets the discoverer to use to find the plugins managed by this game mode.

public GetPluginDiscoverer ( ) : IPluginDiscoverer
return	IPluginDiscoverer

GetPluginFactory() public method

Gets the factory that builds plugins for this game mode.

public GetPluginFactory ( ) : IPluginFactory
return	IPluginFactory

GetPluginOrderLogSerializer() public method

Gets the serializer that serializes and deserializes the plugin order for this game mode.

public GetPluginOrderLogSerializer ( ) : IPluginOrderLogSerializer
return	IPluginOrderLogSerializer

GetPluginOrderValidator() public method

Gets the object that validates plugin order for this game mode.

public GetPluginOrderValidator ( ) : IPluginOrderValidator
return	IPluginOrderValidator

GetUpdaters() public method

Gets the updaters used by the game mode.

public GetUpdaters ( ) : IEnumerable
return	IEnumerable

SetupPluginManagement() protected method

Setup for the plugin management libraries.

protected SetupPluginManagement ( FileUtil p_futFileUtility ) : void
p_futFileUtility	Nexus.Client.Util.FileUtil
return	void

SetupSettingsFiles() protected method

Adds the settings files to the game mode's list.

protected SetupSettingsFiles ( ) : void
return	void

SortPlugins() public method

Sorts the plugins.

public SortPlugins ( IList p_lstPlugins ) : string[]
p_lstPlugins	IList	The list of plugin to order.
return	string[]