C# Class Nexus.Client.ModManagement.Scripting.CSharpScript.CSharpScriptFunctionProxy

Implements the functions availabe to C# scripts.

Inheritance: ScriptFunctionProxy

Exibir arquivo Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method	Description
CSharpScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, UIUtil p_uipUIProxy ) : System	A simple constructor that initializes the object with the given values.
CopyDataFile ( string p_strFrom, string p_strTo ) : bool	Installs the specified file from the mod to the specified location on the file system. This is the legacy form of ScriptFunctionProxy.InstallFileFromMod(string, string). It now just calls ScriptFunctionProxy.InstallFileFromMod(string, string).
Select ( SelectOption p_sopOptions, string p_strTitle, bool p_booSelectMany ) : int[]	Displays a selection form to the user.
Select ( string p_strItems, Image p_imgPreviews, string p_strDescriptions, string p_strTitle, bool p_booSelectMany ) : int[]	Displays a selection form to the user. The items, previews, and descriptions are repectively ordered. In other words, the i-th item in p_strItems uses the i-th preview in p_imgPreviews and the i-th description in p_strDescriptions. Similarly, the idices return as results correspond to the indices of the items in p_strItems.
Select ( string p_strItems, string p_strPreviewPaths, string p_strDescriptions, string p_strTitle, bool p_booSelectMany ) : int[]	Displays a selection form to the user. The items, previews, and descriptions are repectively ordered. In other words, the i-th item in p_strItems uses the i-th preview in p_strPreviewPaths and the i-th description in p_strDescriptions. Similarly, the idices return as results correspond to the indices of the items in p_strItems.

Method Details

CSharpScriptFunctionProxy() public method

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

public CSharpScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, UIUtil p_uipUIProxy ) : System
p_modMod	IMod	The mod for which the script is running.
p_gmdGameMode	IGameMode	The game mode currently being managed.
p_eifEnvironmentInfo	IEnvironmentInfo	The application's envrionment info.
p_igpInstallers	InstallerGroup	The utility class to use to install the mod items.
p_uipUIProxy	UIUtil	The UI manager to use to interact with UI elements.
return	System

CopyDataFile() public method

Installs the specified file from the mod to the specified location on the file system.

This is the legacy form of ScriptFunctionProxy.InstallFileFromMod(string, string). It now just calls ScriptFunctionProxy.InstallFileFromMod(string, string).

public CopyDataFile ( string p_strFrom, string p_strTo ) : bool
p_strFrom	string	The path of the file in the mod to install.
p_strTo	string	The path on the file system where the file is to be created.
return	bool

Select() public method

Displays a selection form to the user.

public Select ( SelectOption p_sopOptions, string p_strTitle, bool p_booSelectMany ) : int[]
p_sopOptions	SelectOption	The options from which to select.
p_strTitle	string	The title of the selection form.
p_booSelectMany	bool	Whether more than one item can be selected.
return	int[]

Select() public method

Displays a selection form to the user.

The items, previews, and descriptions are repectively ordered. In other words, the i-th item in p_strItems uses the i-th preview in p_imgPreviews and the i-th description in p_strDescriptions. Similarly, the idices return as results correspond to the indices of the items in p_strItems.

public Select ( string p_strItems, Image p_imgPreviews, string p_strDescriptions, string p_strTitle, bool p_booSelectMany ) : int[]
p_strItems	string	The items from which to select.
p_imgPreviews	Image	The preview images for the items.
p_strDescriptions	string	The descriptions of the items.
p_strTitle	string	The title of the selection form.
p_booSelectMany	bool	Whether more than one item can be selected.
return	int[]

Select() public method

Displays a selection form to the user.

The items, previews, and descriptions are repectively ordered. In other words, the i-th item in p_strItems uses the i-th preview in p_strPreviewPaths and the i-th description in p_strDescriptions. Similarly, the idices return as results correspond to the indices of the items in p_strItems.

public Select ( string p_strItems, string p_strPreviewPaths, string p_strDescriptions, string p_strTitle, bool p_booSelectMany ) : int[]
p_strItems	string	The items from which to select.
p_strPreviewPaths	string	The preview image file names for the items.
p_strDescriptions	string	The descriptions of the items.
p_strTitle	string	The title of the selection form.
p_booSelectMany	bool	Whether more than one item can be selected.
return	int[]