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

The base class for the Fallout variant of C# scripts.

Inheritance: CSharpBaseScript

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.
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.
GetFileFromFomod ( string p_strFile ) : byte[]	Retrieves the specified file from the mod.
GetFommVersion ( ) : System.Version	Gets the version of the mod manager.
GetFomodFileList ( ) : string[]	Retrieves the list of files in the mod.
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.
InstallFileFromFomod ( string p_strFile ) : bool	Installs the speified file from the mod to the file system.
InstallFileFromFomod ( string p_strFrom, string p_strTo ) : bool	Installs the specified file from the mod to the specified location on the file system.
IsAIActive ( ) : bool	Determines if archive invalidation is active.
IsLoadOrderAutoSorted ( ) : bool	Determines if the plugins have been auto-sorted.
ScriptExtenderPresent ( ) : bool	Indicates whether or not a script extender is present.
SetupScriptCompiler ( TesPlugin p_plgPlugins ) : void	Sets up the script compiler for the given plugins.

Method Details

AutoSortPlugins() public static method

Auto-sorts the specified plugins.

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

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

CompileResultScript() public static method

Compiles the result script.

public static 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 static method

Compiles a script.

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

EditFalloutINI() public static method

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

public static 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 static method

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

public static 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 static method

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

public static 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 static method

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

public static 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 static method

Edits the specified shader with the specified data.

public static 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

GetAutoInsertionPoint() public static method

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

public static 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 static method

Retrieves the list of files in the specified BSA.

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

GetDataFileFromBSA() public static method

Gets the specified file from the specified BSA.

public static 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 static method

Retrieves the specified Fallout.ini value as an integer.

public static 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 static method

Retrieves the specified Fallout.ini value as a string.

public static 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 static method

Gets the version of the game that is installed.

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

GetFileFromFomod() public static method

Retrieves the specified file from the mod.

public static GetFileFromFomod ( string p_strFile ) : byte[]
p_strFile	string	The file to retrieve.
return	byte[]

GetFommVersion() public static method

Gets the version of the mod manager.

public static GetFommVersion ( ) : System.Version
return	System.Version

GetFomodFileList() public static method

Retrieves the list of files in the mod.

public static GetFomodFileList ( ) : string[]
return	string[]

GetGeckIniInt() public static method

Retrieves the specified GECKCustom.ini value as an integer.

public static 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 static method

Retrieves the specified GECKCustom.ini value as a string.

public static 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 static method

Retrieves the specified GECKPrefs.ini value as an integer.

public static 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 static method

Retrieves the specified GECKPrefs.ini value as a string.

public static 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 static method

Retrieves the specified FalloutPrefs.ini value as an integer.

public static 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 static method

Retrieves the specified FalloutPrefs.ini value as a string.

public static 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 static method

Gets the specified value from the RendererInfo.txt file.

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

InstallFileFromFomod() public static method

Installs the speified file from the mod to the file system.

public static InstallFileFromFomod ( string p_strFile ) : bool
p_strFile	string	The path of the file to install.
return	bool

InstallFileFromFomod() public static method

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

public static InstallFileFromFomod ( 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

IsAIActive() public static method

Determines if archive invalidation is active.

public static IsAIActive ( ) : bool
return	bool

IsLoadOrderAutoSorted() public static method

Determines if the plugins have been auto-sorted.

public static IsLoadOrderAutoSorted ( ) : bool
return	bool

ScriptExtenderPresent() public static method

Indicates whether or not a script extender is present.

public static ScriptExtenderPresent ( ) : bool
return	bool

SetupScriptCompiler() public static method

Sets up the script compiler for the given plugins.

public static 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