C# Class Nexus.Client.Games.Morrowind.PluginManagement.Boss.BossSorter

The interface for BOSS functionality.

This use BAPI to expose BOSS's pluing sorting and activation abilities.

Inheritance: ILoadOrderManager, IDisposable

Datei anzeigen Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
BossSorter ( IEnvironmentInfo p_eifEnvironmentInfo, MorrowindGameMode p_gmdGameMode, FileUtil p_futFileUtility, string p_strMasterlistPath ) : System	A simple constructor that initializes the object with the given dependencies.
Dispose ( ) : void	Disposes of any resources that the sorter allocated.
GetActivePlugins ( ) : string[]	Gets the list of active plugins.
GetIndexedPlugin ( Int32 p_intIndex ) : string	Gets the plugin at the specified load index.
GetLoadOrder ( ) : string[]	Gets the list of plugin, sorted by load order.
GetPluginLoadOrder ( string p_strPlugin ) : Int32	Gets the load index of the specified plugin.
IsMaster ( string p_strPlugin ) : bool	Gets whether the plugin is a master file.
IsPluginActive ( string p_strPlugin ) : bool	Determines if the specified plugin is active.
Load ( string p_strMasterlistPath, string p_strUserlistPath ) : void	Loads the specified masterlist. Loads the masterlist and userlist from the paths specified. Can be called multiple times. On error, the database is unchanged.
MasterlistHasUpdate ( ) : bool	Updates the masterlist at the given path.
SetActivePlugins ( string p_strActivePlugins ) : void	Sets the list of active plugins.
SetLoadOrder ( string p_strPlugins ) : void	Sets the load order of the plugins. The returned list of sorted plugins will include plugins that were not included in the specified order list, if plugins exist that weren't included. The extra plugins will be apeended to the end of the given order.
SetPluginActive ( string p_strPlugin, bool p_booActive ) : void	Sets the active status of the specified plugin.
SetPluginLoadOrder ( string p_strPlugin, Int32 p_intIndex ) : void	Sets the load order of the specified plugin. Sets the load order of the specified plugin, removing it from its current position if it has one. The first position in the load order is 0. If the index specified is greater than the number of plugins in the load order, the plugin will be inserted at the end of the load order.
SortMods ( bool p_booTrialOnly ) : string[]	Sorts the user's mods
UpdateMasterlist ( ) : void	Updates the masterlist at the given path.

Protected Methods

Method	Description
AddPluginDirectory ( string p_strPlugin ) : string	Makes the given plugin path absolute.
Dispose ( bool p_booDisposing ) : void	Disposes of the unamanged resources need for BAPI.
MarshalPluginArray ( IntPtr p_ptrPluginArray, UInt32 p_uintLength ) : string[]	Marshal the given pointer to an array of plugins. This adjusts the plugin paths to be in the format expected by the mod manager.
StripPluginDirectory ( string p_strPlugin ) : string	Removes the plugin directory from the given plugin path. BAPI expects plugin paths to be relative to the plugins directory. This adjusts the plugin path for that purpose.
StripPluginDirectory ( string p_strPlugins ) : string[]	Removes the plugin directory from the given plugin paths. BAPI expects plugin paths to be relative to the plugins directory. This adjusts the plugin paths for that purpose.

Private Methods

Method	Description
CreateBossDb ( ) : IntPtr	Creates the BOSS DB. Explicitly manage database lifetime. Allows clients to free memory when they want/need to. This function also checks that plugins.txt and loadorder.txt (if they both exist) are in sync.
DestroyBossDb ( ) : void	Destroys the BOSS DB.
EvalConditionals ( ) : void	Evaluates the loaded masterlist. Evaluates all conditional lines and regex mods the loaded masterlist. This exists so that Load() doesn't need to be called whenever the mods installed are changed. Evaluation does not take place unless this function is called. Repeated calls re-evaluate the masterlist from scratch each time, ignoring the results of any previous evaluations. Paths are case-sensitive if the underlying filesystem is case-sensitive.
FreeLibrary ( IntPtr hModule ) : bool
GetLastErrorDetails ( ) : string	Gets the details of the last error.
GetProcAddress ( IntPtr hModule, [ procName ) : IntPtr
HandleStatusCode ( UInt32 p_uintStatusCode ) : void	Handles the status code returned by the BAPI methods.
LoadLibrary ( [ fileName ) : IntPtr
LoadMethods ( ) : void	Loads the native BAPI methods.
RemoveNonExistentPlugins ( string p_strPlugins ) : string[]	Removes non-existent and ghosted plugins from the given list.

Method Details

AddPluginDirectory() protected method

Makes the given plugin path absolute.

protected AddPluginDirectory ( string p_strPlugin ) : string
p_strPlugin	string	The plugin path to adjust.
return	string

BossSorter() public method

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

public BossSorter ( IEnvironmentInfo p_eifEnvironmentInfo, MorrowindGameMode p_gmdGameMode, FileUtil p_futFileUtility, string p_strMasterlistPath ) : System
p_eifEnvironmentInfo	IEnvironmentInfo	The application's envrionment info.
p_gmdGameMode	MorrowindGameMode	The game mode for which plugins are being managed.
p_futFileUtility	Nexus.Client.Util.FileUtil	The file utility class.
p_strMasterlistPath	string	The path to the masterlist file to use.
return	System

Dispose() public method

Disposes of any resources that the sorter allocated.

public Dispose ( ) : void
return	void

Dispose() protected method

Disposes of the unamanged resources need for BAPI.

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

GetActivePlugins() public method

Gets the list of active plugins.

public GetActivePlugins ( ) : string[]
return	string[]

GetIndexedPlugin() public method

Gets the plugin at the specified load index.

public GetIndexedPlugin ( Int32 p_intIndex ) : string
p_intIndex	System.Int32	The load index of the plugin to retrieve.
return	string

GetLoadOrder() public method

Gets the list of plugin, sorted by load order.

public GetLoadOrder ( ) : string[]
return	string[]

GetPluginLoadOrder() public method

Gets the load index of the specified plugin.

public GetPluginLoadOrder ( string p_strPlugin ) : Int32
p_strPlugin	string	The plugin whose load order is to be retrieved.
return	System.Int32

IsMaster() public method

Gets whether the plugin is a master file.

public IsMaster ( string p_strPlugin ) : bool
p_strPlugin	string	The plugin for which it is to be determined if the file is a plugin.
return	bool

IsPluginActive() public method

Determines if the specified plugin is active.

public IsPluginActive ( string p_strPlugin ) : bool
p_strPlugin	string	The plugins whose active state is to be determined.
return	bool

Load() public method

Loads the specified masterlist.

Loads the masterlist and userlist from the paths specified. Can be called multiple times. On error, the database is unchanged.

public Load ( string p_strMasterlistPath, string p_strUserlistPath ) : void
p_strMasterlistPath	string	The path to the masterlist to load.
p_strUserlistPath	string	The path to the userlist to load.
return	void

MarshalPluginArray() protected method

Marshal the given pointer to an array of plugins.

This adjusts the plugin paths to be in the format expected by the mod manager.

protected MarshalPluginArray ( IntPtr p_ptrPluginArray, UInt32 p_uintLength ) : string[]
p_ptrPluginArray	System.IntPtr	The pointer to the array of plugin names to marshal.
p_uintLength	System.UInt32	the length of the array to marshal.
return	string[]

MasterlistHasUpdate() public method

Updates the masterlist at the given path.

public MasterlistHasUpdate ( ) : bool
return	bool

SetActivePlugins() public method

Sets the list of active plugins.

public SetActivePlugins ( string p_strActivePlugins ) : void
p_strActivePlugins	string	The list of plugins to set as active.
return	void

SetLoadOrder() public method

Sets the load order of the plugins.

The returned list of sorted plugins will include plugins that were not included in the specified order list, if plugins exist that weren't included. The extra plugins will be apeended to the end of the given order.

public SetLoadOrder ( string p_strPlugins ) : void
p_strPlugins	string	The list of plugins in the desired order.
return	void

SetPluginActive() public method

Sets the active status of the specified plugin.

public SetPluginActive ( string p_strPlugin, bool p_booActive ) : void
p_strPlugin	string	The plugin whose active status is to be set.
p_booActive	bool	Whether the specified plugin should be made active or inactive.
return	void

SetPluginLoadOrder() public method

Sets the load order of the specified plugin.

Sets the load order of the specified plugin, removing it from its current position if it has one. The first position in the load order is 0. If the index specified is greater than the number of plugins in the load order, the plugin will be inserted at the end of the load order.

public SetPluginLoadOrder ( string p_strPlugin, Int32 p_intIndex ) : void
p_strPlugin	string	The plugin whose load order is to be set.
p_intIndex	System.Int32	The load index at which to place the specified plugin.
return	void

SortMods() public method

Sorts the user's mods

public SortMods ( bool p_booTrialOnly ) : string[]
p_booTrialOnly	bool	Whether the sort should actually be performed, or just previewed.
return	string[]

StripPluginDirectory() protected method

Removes the plugin directory from the given plugin path.

BAPI expects plugin paths to be relative to the plugins directory. This adjusts the plugin path for that purpose.

protected StripPluginDirectory ( string p_strPlugin ) : string
p_strPlugin	string	The plugin path to adjust.
return	string

StripPluginDirectory() protected method

Removes the plugin directory from the given plugin paths.

BAPI expects plugin paths to be relative to the plugins directory. This adjusts the plugin paths for that purpose.

protected StripPluginDirectory ( string p_strPlugins ) : string[]
p_strPlugins	string	The array of plugin paths to adjust.
return	string[]

UpdateMasterlist() public method

Updates the masterlist at the given path.

public UpdateMasterlist ( ) : void
return	void