C# Class Nexus.Client.ModAuthoring.UI.ModPackagingFormVM

This class encapsulates the data and the operations presented by UI elements that display a mod packaging Project editor.

Inheritance: ObservableObject

Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Properties

Property	Type	Description
ConfirmSaveCurrentProject	Func
GetIgnoreWarnings	Func
GetNewModSavePath	Func
GetOpenPath	Func
GetProjectSavePath	Func

Public Methods

Method	Description
ModPackagingFormVM ( InstallScriptEditorVM p_vmlScriptEditorVM, ModInfoEditorVM p_vmlInfoEditorVM, Project p_prjModProject, IScriptTypeRegistry p_srgScriptTypeRegistry, ModPackager p_mpkModBuilder ) : System	A simple constructor that initializes the object with the given values.
Validate ( ) : bool	Validates the project.

Protected Methods

Method	Description
BuildMod ( string p_strPath ) : void	Build a mod file at the given path from the current Project.
GetAbandonCurrentProject ( ) : bool	Determine if we should
NewProject ( ) : void	Creates a new packaging Project.
OpenProject ( ) : void	Opens the mod packaging Project from the given path.
SaveProject ( string p_strPath ) : void	Saves the mod packaging Project to the given path.
ValidateFiles ( ) : bool	Validates the mod files. This raises a warning if no files have been selected.
ValidateModInfo ( ) : bool	This validates the mod info.
ValidateReadme ( ) : bool	Validates the readme. This raises a warning if there is no readme.
ValidateScript ( ) : bool	This validates the install script.

Private Methods

Method	Description
Project_PropertyChanged ( object sender, PropertyChangedEventArgs e ) : void	Handles the INotifyPropertyChanged.PropertyChanged event of the Project being edited.

Method Details

BuildMod() protected method

Build a mod file at the given path from the current Project.

protected BuildMod ( string p_strPath ) : void
p_strPath	string	The file path at which to build the mod.
return	void

GetAbandonCurrentProject() protected method

Determine if we should

protected GetAbandonCurrentProject ( ) : bool
return	bool

ModPackagingFormVM() public method

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

public ModPackagingFormVM ( InstallScriptEditorVM p_vmlScriptEditorVM, ModInfoEditorVM p_vmlInfoEditorVM, Project p_prjModProject, IScriptTypeRegistry p_srgScriptTypeRegistry, ModPackager p_mpkModBuilder ) : System
p_vmlScriptEditorVM	Nexus.Client.ModAuthoring.UI.Controls.InstallScriptEditorVM	The that encapsulates the data /// and operations for diaplying the editor.
p_vmlInfoEditorVM	Nexus.Client.ModAuthoring.UI.Controls.ModInfoEditorVM	The that encapsulates the data /// and operations for diaplying the editor.
p_prjModProject	Project	The to edit.
p_srgScriptTypeRegistry	IScriptTypeRegistry	The of available s.
p_mpkModBuilder	ModPackager	he to use to build mod files /// from s.
return	System

NewProject() protected method

Creates a new packaging Project.

protected NewProject ( ) : void
return	void

OpenProject() protected method

Opens the mod packaging Project from the given path.

protected OpenProject ( ) : void
return	void

SaveProject() protected method

Saves the mod packaging Project to the given path.

protected SaveProject ( string p_strPath ) : void
p_strPath	string	The file path to which to save the .
return	void

Validate() public method

Validates the project.

public Validate ( ) : bool
return	bool

ValidateFiles() protected method

Validates the mod files.

This raises a warning if no files have been selected.

protected ValidateFiles ( ) : bool
return	bool

ValidateModInfo() protected method

This validates the mod info.

protected ValidateModInfo ( ) : bool
return	bool

ValidateReadme() protected method

Validates the readme.

This raises a warning if there is no readme.

protected ValidateReadme ( ) : bool
return	bool

ValidateScript() protected method

This validates the install script.

protected ValidateScript ( ) : bool
return	bool

Property Details

ConfirmSaveCurrentProject public property

Gets whether the current Project should be saved.

If the delegate returns null, then the user wishes to keep the current project as the project being edited.

public Func ConfirmSaveCurrentProject
return	Func

GetIgnoreWarnings public property

Determines if the validation warnings should be ignored.

public Func GetIgnoreWarnings
return	Func

GetNewModSavePath public property

Gets the file path to which to save the new mod.

public Func GetNewModSavePath
return	Func

GetOpenPath public property

Gets the path of the Project file to open.

public Func GetOpenPath
return	Func

GetProjectSavePath public property

Gets the file path to which to save the Project.

public Func GetProjectSavePath
return	Func