C# Class Nexus.Client.Games.Grimrock.Scripting.ModScript.GrimrockModScriptFunctionProxy

Implements the functions availabe to the Grimrock variant of Mod Script scripts.
The proxy allows sandboxed scripts to call functions that can perform actions outside of the sandbox. All values in Mod Script are strings. Thus, all parameters to the functions are strings. If they represent another datatype, the functions must convert the values before using them. There are a few exceptions, where some methods accept non-string parameters. This is becuase these methods are called by the interpreter, and not from the interpreted code.
Inheritance: Nexus.Client.ModManagement.Scripting.ModScript.ModScriptFunctionProxy
Mostra file Open project: NexusMods/NexusModManager-4.5

Public Methods

Method Description
GetScriptExtenderVersion ( ) : System.Version

Gets the version of the script extender that is installed.
GrimrockModScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, ModScriptUIUtil p_uipUIProxy ) : System

A simple constructor that initializes the object with the given values.
GrimrockNewerThan ( string p_strGameVersion ) : bool

Determines if the current game version is greater than the given version.

This is an alis for ModScriptFunctionProxy.GameNewerThan(string). It exists to maintain compatibility with old Mod Scripts.

ScriptExtenderNewerThan ( string p_strGameVersion ) : bool

Determines if the installed script extender version is greater than the given version.
ScriptExtenderPresent ( ) : bool

Determines if the script extender is installed.

Method Details

GetScriptExtenderVersion() public method

Gets the version of the script extender that is installed.
public GetScriptExtenderVersion ( ) : System.Version
return System.Version

GrimrockModScriptFunctionProxy() public method

A simple constructor that initializes the object with the given values.
public GrimrockModScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, ModScriptUIUtil 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 Nexus.Client.ModManagement.InstallerGroup The utility class to use to install the mod items.
p_uipUIProxy Nexus.Client.ModManagement.Scripting.ModScript.ModScriptUIUtil The UI manager to use to interact with UI elements.
return System

GrimrockNewerThan() public method

Determines if the current game version is greater than the given version.
This is an alis for ModScriptFunctionProxy.GameNewerThan(string). It exists to maintain compatibility with old Mod Scripts.
public GrimrockNewerThan ( string p_strGameVersion ) : bool
p_strGameVersion string The version to which to compare the game's version.
return bool

ScriptExtenderNewerThan() public method

Determines if the installed script extender version is greater than the given version.
public ScriptExtenderNewerThan ( string p_strGameVersion ) : bool
p_strGameVersion string The version to which to compare the script extender's version.
return bool

ScriptExtenderPresent() public method

Determines if the script extender is installed.
public ScriptExtenderPresent ( ) : bool
return bool