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

Describes the C# script type.
This is the script that allows scripting using the C# language. It is meant to be the most advanced and flexible script.
Inheritance: IScriptType
Mostra file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
CreateEditor ( IList p_lstModFiles ) : IScriptEditor

Creates an editor for the script type.

CreateExecutor ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, SynchronizationContext p_scxUIContext ) : IScriptExecutor

Creates an executor that can run the script type.

LoadScript ( string p_strScriptData ) : IScript

Loads the script from the given text representation.

SaveScript ( IScript p_scpScript ) : string

Saves the given script into a text representation.

ValidateScript ( IScript p_scpScript ) : bool

Determines if the given script is valid.

Protected Methods

Method Description
GetScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, SynchronizationContext p_scxUIContext ) : CSharpScriptFunctionProxy

Returns a proxy that implements the functions available to C# scripts.

Method Details

CreateEditor() public method

Creates an editor for the script type.
public CreateEditor ( IList p_lstModFiles ) : IScriptEditor
p_lstModFiles IList The list of files if the current mod.
return IScriptEditor

CreateExecutor() public method

Creates an executor that can run the script type.
public CreateExecutor ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, SynchronizationContext p_scxUIContext ) : IScriptExecutor
p_modMod IMod The mod being installed.
p_gmdGameMode IGameMode The game mode currently bieng managed.
p_eifEnvironmentInfo IEnvironmentInfo The application's envrionment info.
p_igpInstallers InstallerGroup The utility class to use to install the mod items.
p_scxUIContext System.Threading.SynchronizationContext The to use to marshall UI interactions to the UI thread.
return IScriptExecutor

GetScriptFunctionProxy() protected method

Returns a proxy that implements the functions available to C# scripts.
protected GetScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, SynchronizationContext p_scxUIContext ) : CSharpScriptFunctionProxy
p_modMod IMod The mod being installed.
p_gmdGameMode IGameMode The game mode currently bieng managed.
p_eifEnvironmentInfo IEnvironmentInfo The application's envrionment info.
p_igpInstallers InstallerGroup The utility class to use to install the mod items.
p_scxUIContext System.Threading.SynchronizationContext The to use to marshall UI interactions to the UI thread.
return CSharpScriptFunctionProxy

LoadScript() public method

Loads the script from the given text representation.
public LoadScript ( string p_strScriptData ) : IScript
p_strScriptData string The text to convert into a script.
return IScript

SaveScript() public method

Saves the given script into a text representation.
public SaveScript ( IScript p_scpScript ) : string
p_scpScript IScript The to save.
return string

ValidateScript() public method

Determines if the given script is valid.
public ValidateScript ( IScript p_scpScript ) : bool
p_scpScript IScript The script to validate.
return bool