C# 클래스 Nexus.Client.Games.Gamebryo.PluginManagement.LoadOrder.PluginOrderManager

The interface for LibLoadOrder functionality.

This use LibLoadOrder API to expose its plugin sorting and activation abilities.

상속: ILoadOrderManager, IDisposable

파일 보기 프로젝트 열기: NexusMods/NexusModManager-4.5 1 사용 예제들

공개 메소드들

메소드	설명
Dispose ( ) : void	Disposes of any resources that the LoadOrderManager 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.
MasterlistHasUpdate ( ) : bool	Updates the masterlist at the given path.
PluginOrderManager ( IEnvironmentInfo p_eifEnvironmentInfo, GamebryoGameModeBase p_gmdGameMode, FileUtil p_futFileUtility ) : System	A simple constructor that initializes the object with the given dependencies.
SetActivePlugins ( string p_strActivePlugins ) : void	Sets the list of active plugins.
SetLoadOrder ( string p_strPlugins ) : void	Sets the load order of the plugins.
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.

보호된 메소드들

메소드	설명
AddPluginDirectory ( string p_strPlugin ) : string	Makes the given plugin path absolute.
Dispose ( bool p_booDisposing ) : void	Disposes of the unamanged resources need for LibLoadOrder API.
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.

비공개 메소드들

메소드	설명
AddMissingElements ( IList p_lstOrdered, bool p_booPluginFileOnly ) : void	Adds plugins missing from the loadorder file to the ordered list.
Backup ( string p_strDataFolder ) : void	Backup the plugins.txt and loadorder.txt files
FileWatcherOnChangedLoose ( object source, FileSystemEventArgs e ) : void	Handles changes made to files in the plugin installation folder.
FileWatcherOnChangedTxt ( object source, FileSystemEventArgs e ) : void	Handles changes made to text files.
FileWatcherOnCreatedLoose ( object source, FileSystemEventArgs e ) : void	Handles new files added to the plugin installation folder.
FileWatcherOnDeletedLoose ( object source, FileSystemEventArgs e ) : void	Handles files removed from the plugin installation folder.
GetActiveList ( ) : List	Gets the list of active plugins.
GetSortedListLoadOrder ( ) : string[]	Gets the list of plugin from a file, sorted by load order.
GetTimestampLoadOrder ( ) : string[]	Gets the list of plugin, sorted by load order.
InitializeManager ( ) : void	Initializes the Plugin Order manager.
IsFileReady ( String p_strFilePath ) : bool?	Checks whether the file to write to is currently free for use.
RemoveNonExistentPlugins ( string p_strPlugins ) : string[]	Removes non-existent and ghosted plugins from the given list.
RunningTask_TaskEnded ( object sender, TaskEndedEventArgs e ) : void	Handles the IBackgroundTask.TaskEnded event of a task set. This displays the confirmation message.
SetActivePluginsTask ( string p_strActivePlugins ) : void	Sets the list of active plugins.
SetSortedListLoadOrder ( string p_strPlugins ) : void	Sets the load order of the plugins in a file.
SetTimestampLoadOrder ( string p_strPlugins ) : void	Sets the load order of the plugins.
SetupWatcher ( string p_strGameModeLocal ) : void	Initializes File Watcher.
TaskList_CollectionChanged ( object sender, NotifyCollectionChangedEventArgs e ) : void	Handles the INotifyCollectionChanged.CollectionChanged event of the view model's installed mod list. This updates the list of mods to refelct changes to the installed mod list.
WriteLoadOrder ( string p_strFilePath, string p_strPlugins ) : void	Handles write operations to the load order file.

메소드 상세

AddPluginDirectory() 보호된 메소드

Makes the given plugin path absolute.

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

Dispose() 공개 메소드

Disposes of any resources that the LoadOrderManager allocated.

public Dispose ( ) : void
리턴	void

Dispose() 보호된 메소드

Disposes of the unamanged resources need for LibLoadOrder API.

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

GetActivePlugins() 공개 메소드

Gets the list of active plugins.

public GetActivePlugins ( ) : string[]
리턴	string[]

GetIndexedPlugin() 공개 메소드

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.
리턴	string

GetLoadOrder() 공개 메소드

Gets the list of plugin, sorted by load order.

public GetLoadOrder ( ) : string[]
리턴	string[]

GetPluginLoadOrder() 공개 메소드

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.
리턴	System.Int32

IsMaster() 공개 메소드

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.
리턴	bool

IsPluginActive() 공개 메소드

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.
리턴	bool

MasterlistHasUpdate() 공개 메소드

Updates the masterlist at the given path.

public MasterlistHasUpdate ( ) : bool
리턴	bool

PluginOrderManager() 공개 메소드

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

public PluginOrderManager ( IEnvironmentInfo p_eifEnvironmentInfo, GamebryoGameModeBase p_gmdGameMode, FileUtil p_futFileUtility ) : System
p_eifEnvironmentInfo	IEnvironmentInfo	The application's envrionment info.
p_gmdGameMode	GamebryoGameModeBase	The game mode for which plugins are being managed.
p_futFileUtility	Nexus.Client.Util.FileUtil	The file utility class.
리턴	System

SetActivePlugins() 공개 메소드

Sets the list of active plugins.

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

SetLoadOrder() 공개 메소드

Sets the load order of the plugins.

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

SetPluginActive() 공개 메소드

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.
리턴	void

SetPluginLoadOrder() 공개 메소드

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.
리턴	void

SortMods() 공개 메소드

Sorts the user's mods

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

StripPluginDirectory() 보호된 메소드

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.
리턴	string

StripPluginDirectory() 보호된 메소드

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.
리턴	string[]

UpdateMasterlist() 공개 메소드

Updates the masterlist at the given path.

public UpdateMasterlist ( ) : void
리턴	void