C# Class Nexus.Client.Games.Fallout3.Scripting.CSharpScript.FalloutCSharpScriptFunctionProxy

Implements the functions availabe to Fallout C# scripts.

Inheritance: Nexus.Client.ModManagement.Scripting.CSharpScript.CSharpScriptFunctionProxy

Show file Open project: NexusMods/NexusModManager-4.5

Public Methods

Method	Description
AutoSortPlugins ( string p_strPlugins ) : void	Auto-sorts the specified plugins. This is, apparently, a beta function. Use with caution.
CompileResultScript ( SubRecord sr, Record &r2, string &msg ) : void	Compiles the result script.
CompileScript ( Record r2, string &msg ) : void	Compiles a script.
EditFalloutINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool	Sets the specified value in the Fallout.ini file to the given value.
EditGeckINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool	Sets the specified value in the GECKCustom.ini file to the given value.
EditGeckPrefsINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool	Sets the specified value in the GECKPrefs.ini file to the given value.
EditPrefsINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool	Sets the specified value in the FalloutPrefs.ini file to the given value.
EditShader ( int p_intPackage, string p_strShaderName, byte p_bteData ) : bool	Edits the specified shader with the specified data.
FalloutCSharpScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, BsaManager p_bamBsaManager, UIUtil p_uipUIProxy ) : System	A simple constructor that initialies the object with the given values.
GetAutoInsertionPoint ( string p_strPlugin ) : int	Determins where in the load order the specified plugin would be inserted if the plugins were auto-sorted.
GetBSAFileList ( string p_strBsa ) : string[]	Retrieves the list of files in the specified BSA.
GetDataFileFromBSA ( string p_strBsa, string p_strFile ) : byte[]	Gets the specified file from the specified BSA.
GetFalloutIniInt ( string p_strSection, string p_strKey ) : int	Retrieves the specified Fallout.ini value as an integer.
GetFalloutIniString ( string p_strSection, string p_strKey ) : string	Retrieves the specified Fallout.ini value as a string.
GetFalloutVersion ( ) : System.Version	Gets the version of the game that is installed.
GetGeckIniInt ( string p_strSection, string p_strKey ) : int	Retrieves the specified GECKCustom.ini value as an integer.
GetGeckIniString ( string p_strSection, string p_strKey ) : string	Retrieves the specified GECKCustom.ini value as a string.
GetGeckPrefsIniInt ( string p_strSection, string p_strKey ) : int	Retrieves the specified GECKPrefs.ini value as an integer.
GetGeckPrefsIniString ( string p_strSection, string p_strKey ) : string	Retrieves the specified GECKPrefs.ini value as a string.
GetPrefsIniInt ( string p_strSection, string p_strKey ) : int	Retrieves the specified FalloutPrefs.ini value as an integer.
GetPrefsIniString ( string p_strSection, string p_strKey ) : string	Retrieves the specified FalloutPrefs.ini value as a string.
GetRendererInfo ( string p_strValue ) : string	Gets the specified value from the RendererInfo.txt file.
IsAIActive ( ) : bool	Determines if archive invalidation is active.
IsLoadOrderAutoSorted ( ) : bool	Determines if the plugins have been auto-sorted.
ScriptExtenderPresent ( ) : bool	Indicates whether or a script extender is present.
SetupScriptCompiler ( TesPlugin p_plgPlugins ) : void	Sets up the script compiler for the given plugins.

Method Details

AutoSortPlugins() public method

Auto-sorts the specified plugins.

This is, apparently, a beta function. Use with caution.

public AutoSortPlugins ( string p_strPlugins ) : void
p_strPlugins	string	The list of plugins to auto-sort.
return	void

CompileResultScript() public method

Compiles the result script.

public CompileResultScript ( SubRecord sr, Record &r2, string &msg ) : void
sr	Nexus.Client.Games.Gamebryo.Tools.TESsnip.SubRecord
r2	Nexus.Client.Games.Gamebryo.Tools.TESsnip.Record
msg	string
return	void

CompileScript() public method

Compiles a script.

public CompileScript ( Record r2, string &msg ) : void
r2	Nexus.Client.Games.Gamebryo.Tools.TESsnip.Record
msg	string
return	void

EditFalloutINI() public method

Sets the specified value in the Fallout.ini file to the given value.

public EditFalloutINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool
p_strSection	string	The section in the Ini file to edit.
p_strKey	string	The key in the Ini file to edit.
p_strValue	string	The value to which to set the key.
p_booSaveOld	bool	Not used.
return	bool

EditGeckINI() public method

Sets the specified value in the GECKCustom.ini file to the given value.

public EditGeckINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool
p_strSection	string	The section in the Ini file to edit.
p_strKey	string	The key in the Ini file to edit.
p_strValue	string	The value to which to set the key.
p_booSaveOld	bool	Not used.
return	bool

EditGeckPrefsINI() public method

Sets the specified value in the GECKPrefs.ini file to the given value.

public EditGeckPrefsINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool
p_strSection	string	The section in the Ini file to edit.
p_strKey	string	The key in the Ini file to edit.
p_strValue	string	The value to which to set the key.
p_booSaveOld	bool	Not used.
return	bool

EditPrefsINI() public method

Sets the specified value in the FalloutPrefs.ini file to the given value.

public EditPrefsINI ( string p_strSection, string p_strKey, string p_strValue, bool p_booSaveOld ) : bool
p_strSection	string	The section in the Ini file to edit.
p_strKey	string	The key in the Ini file to edit.
p_strValue	string	The value to which to set the key.
p_booSaveOld	bool	Not used.
return	bool

EditShader() public method

Edits the specified shader with the specified data.

public EditShader ( int p_intPackage, string p_strShaderName, byte p_bteData ) : bool
p_intPackage	int	The package containing the shader to edit.
p_strShaderName	string	The shader to edit.
p_bteData	byte	The value to which to edit the shader.
return	bool

FalloutCSharpScriptFunctionProxy() public method

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

public FalloutCSharpScriptFunctionProxy ( IMod p_modMod, IGameMode p_gmdGameMode, IEnvironmentInfo p_eifEnvironmentInfo, InstallerGroup p_igpInstallers, BsaManager p_bamBsaManager, 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	Nexus.Client.ModManagement.InstallerGroup	The utility class to use to install the mod items.
p_bamBsaManager	Nexus.Client.Games.Gamebryo.ModManagement.Scripting.BsaManager	The manager to use to work with BSA files.
p_uipUIProxy	Nexus.Client.ModManagement.Scripting.UIUtil	The UI manager to use to interact with UI elements.
return	System

GetAutoInsertionPoint() public method

Determins where in the load order the specified plugin would be inserted if the plugins were auto-sorted.

public GetAutoInsertionPoint ( string p_strPlugin ) : int
p_strPlugin	string	The name of the plugin whose auto-sort insertion /// point is to be determined.
return	int

GetBSAFileList() public method

Retrieves the list of files in the specified BSA.

public GetBSAFileList ( string p_strBsa ) : string[]
p_strBsa	string	The BSA whose file listing is requested.
return	string[]

GetDataFileFromBSA() public method

Gets the specified file from the specified BSA.

public GetDataFileFromBSA ( string p_strBsa, string p_strFile ) : byte[]
p_strBsa	string	The BSA from which to extract the specified file.
p_strFile	string	The files to extract form the specified BSA.
return	byte[]

GetFalloutIniInt() public method

Retrieves the specified Fallout.ini value as an integer.

public GetFalloutIniInt ( string p_strSection, string p_strKey ) : int
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	int

GetFalloutIniString() public method

Retrieves the specified Fallout.ini value as a string.

public GetFalloutIniString ( string p_strSection, string p_strKey ) : string
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	string

GetFalloutVersion() public method

Gets the version of the game that is installed.

public GetFalloutVersion ( ) : System.Version
return	System.Version

GetGeckIniInt() public method

Retrieves the specified GECKCustom.ini value as an integer.

public GetGeckIniInt ( string p_strSection, string p_strKey ) : int
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	int

GetGeckIniString() public method

Retrieves the specified GECKCustom.ini value as a string.

public GetGeckIniString ( string p_strSection, string p_strKey ) : string
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	string

GetGeckPrefsIniInt() public method

Retrieves the specified GECKPrefs.ini value as an integer.

public GetGeckPrefsIniInt ( string p_strSection, string p_strKey ) : int
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	int

GetGeckPrefsIniString() public method

Retrieves the specified GECKPrefs.ini value as a string.

public GetGeckPrefsIniString ( string p_strSection, string p_strKey ) : string
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	string

GetPrefsIniInt() public method

Retrieves the specified FalloutPrefs.ini value as an integer.

public GetPrefsIniInt ( string p_strSection, string p_strKey ) : int
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	int

GetPrefsIniString() public method

Retrieves the specified FalloutPrefs.ini value as a string.

public GetPrefsIniString ( string p_strSection, string p_strKey ) : string
p_strSection	string	The section containing the value to retrieve.
p_strKey	string	The key of the value to retrieve.
return	string

GetRendererInfo() public method

Gets the specified value from the RendererInfo.txt file.

public GetRendererInfo ( string p_strValue ) : string
p_strValue	string	The value to retrieve from the file.
return	string

IsAIActive() public method

Determines if archive invalidation is active.

public IsAIActive ( ) : bool
return	bool

IsLoadOrderAutoSorted() public method

Determines if the plugins have been auto-sorted.

public IsLoadOrderAutoSorted ( ) : bool
return	bool

ScriptExtenderPresent() public method

Indicates whether or a script extender is present.

public ScriptExtenderPresent ( ) : bool
return	bool

SetupScriptCompiler() public method

Sets up the script compiler for the given plugins.

public SetupScriptCompiler ( TesPlugin p_plgPlugins ) : void
p_plgPlugins	Nexus.Client.Games.Gamebryo.Tools.TESsnip.TesPlugin	The plugins for which to set up the script compiler.
return	void