C# Class Nexus.Client.Games.Gamebryo.ModManagement.Scripting.BsaManager

Encapsulates the management of BSA files.
Inheritance: IDisposable
Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
BsaManager ( GamebryoGameModeBase p_gmdGameMode ) : System

A simple constructor the initializes the object with the given values.
Dispose ( ) : void

Disposes the BSA manager.

This method ensures that all BSAs have been released.

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.

Method Details

BsaManager() public method

A simple constructor the initializes the object with the given values.
public BsaManager ( GamebryoGameModeBase p_gmdGameMode ) : System
p_gmdGameMode GamebryoGameModeBase The game mode currently being managed.
return System

Dispose() public method

Disposes the BSA manager.
This method ensures that all BSAs have been released.
public Dispose ( ) : void
return void

GetBSAFileList() public method

Retrieves the list of files in the specified BSA.
Thrown if /// contains illegal characters or refers to a file outside of the Data directory. Thrown if the specified BSA cannot be loaded.
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.
Thrown if /// contains illegal characters or refers to a file outside of the Data directory, or /// if refers to an unsafe location. Thrown if the specified BSA cannot be loaded.
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[]