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

The base game mode factory that provides the commond functionality for factories that build game modes for Gamebryo based games.
Inheritance: IGameModeFactory
Datei anzeigen Open project: NexusMods/NexusModManager-4.5

Public Methods

Method Description
BuildGameMode ( FileUtil p_futFileUtility, ViewMessage &p_imsWarning ) : IGameMode

Builds the game mode.
GamebryoGameModeFactory ( IEnvironmentInfo p_eifEnvironmentInfo ) : System

A simple consturctor that initializes the object with the given values.
GetExecutablePath ( string p_strPath ) : string

Gets the path to the game executable.
GetInstallationPath ( ) : string

Gets the path where mod files should be installed.
GetInstallationPath ( string p_strGameInstallPath ) : string

Gets the path where mod files should be installed.

This method uses the given path to the installed game to determine the installaiton path for mods.

PerformInitialSetup ( ShowViewDelegate p_dlgShowView, ShowMessageDelegate p_dlgShowMessage ) : bool

Performs the initial setup for the game mode being created.
PerformInitialization ( ShowViewDelegate p_dlgShowView, ShowMessageDelegate p_dlgShowMessage ) : bool

Performs the initializtion for the game mode being created.

Protected Methods

Method Description
InstantiateGameMode ( FileUtil p_futFileUtility ) : GamebryoGameModeBase

Instantiates the game mode.

Method Details

BuildGameMode() public method

Builds the game mode.
public BuildGameMode ( FileUtil p_futFileUtility, ViewMessage &p_imsWarning ) : IGameMode
p_futFileUtility Nexus.Client.Util.FileUtil The file utility class to be used by the game mode.
p_imsWarning Nexus.Client.UI.ViewMessage The resultant warning resultant from the creation of the game mode. /// null if there are no warnings.
return IGameMode

GamebryoGameModeFactory() public method

A simple consturctor that initializes the object with the given values.
public GamebryoGameModeFactory ( IEnvironmentInfo p_eifEnvironmentInfo ) : System
p_eifEnvironmentInfo IEnvironmentInfo The application's environement info.
return System

GetExecutablePath() public method

Gets the path to the game executable.
public GetExecutablePath ( string p_strPath ) : string
p_strPath string
return string

GetInstallationPath() public method

Gets the path where mod files should be installed.
public GetInstallationPath ( ) : string
return string

GetInstallationPath() public method

Gets the path where mod files should be installed.
This method uses the given path to the installed game to determine the installaiton path for mods.
public GetInstallationPath ( string p_strGameInstallPath ) : string
p_strGameInstallPath string
return string

InstantiateGameMode() protected abstract method

Instantiates the game mode.
protected abstract InstantiateGameMode ( FileUtil p_futFileUtility ) : GamebryoGameModeBase
p_futFileUtility Nexus.Client.Util.FileUtil The file utility class to be used by the game mode.
return GamebryoGameModeBase

PerformInitialSetup() public method

Performs the initial setup for the game mode being created.
public PerformInitialSetup ( ShowViewDelegate p_dlgShowView, ShowMessageDelegate p_dlgShowMessage ) : bool
p_dlgShowView ShowViewDelegate The delegate to use to display a view.
p_dlgShowMessage ShowMessageDelegate The delegate to use to display a message.
return bool

PerformInitialization() public abstract method

Performs the initializtion for the game mode being created.
public abstract PerformInitialization ( ShowViewDelegate p_dlgShowView, ShowMessageDelegate p_dlgShowMessage ) : bool
p_dlgShowView ShowViewDelegate The delegate to use to display a view.
p_dlgShowMessage ShowMessageDelegate The delegate to use to display a message.
return bool