Unigine::PackageUng Class

PackageUng Class

Members

int getNumFiles() const#

Return value

Current total number of files in the package.

---

PackageUng ( const char * password = "", const char * compress_extension_list = "json xml txt node world prop track mat basemat" ) #

Constructor. Initializes a PackageUng object with an optional password and a specified list for the expressions to be compressed. By default, the list includes formats that do not require Data Streaming.

Arguments

• const char * password - Password used to protect the archive. If empty, no password protection is applied.
• const char * compress_extension_list - A space-separated list of file extensions that should be compressed when added to the package.

void close ( ) #

Closes the currently opened package and resets internal state of PackageUng object.

bool createPackage ( const char * path ) #

Creates a new UNG package file at the specified path.

Arguments

• const char * path - Package path.

Return value

true if a package was created successfully; otherwise, false.

static bool isSupported ( ) #

Returns a value indicating if UNG-packages are supported.

Return value

true if UNG packages are supported; otherwise, false.

bool load ( const char * path ) #

Loads an existing package from the specified path.

Arguments

• const char * path - The path to the package file.

Return value

true if a package was loaded successfully; otherwise, false.

bool readFile ( unsigned char * data, size_t size ) #

Reads the contents of the currently selected file and puts it into the data array.

Arguments

• unsigned char * data - Data array.
• size_t size - File size, in bytes.

Return value

true if a file was read successfully; otherwise, false.

bool selectFile ( const char * path, size_t & size ) #

Selects a file with a given path as a current one and puts its size in the provided variable.

Arguments

• const char * path - Relative path of the file within the package.
• size_t & size - A reference variable to store the size of the selected file.

Return value

true if a file was selected successfully; otherwise, false.

bool writeFile ( const char * path, const unsigned char * OUT_data, size_t size ) #

Writes data to the package with a given path.

Arguments

• const char * path - File path.
• const unsigned char * OUT_data - Data to be written.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.
• size_t size - Size of the data to be written, in bytes.

Return value

true if the data was successfully written to a file; otherwise, false.

bool containsFile ( const char * path ) const#

Checks if the package contains the specified file.

Arguments

• const char * path - File path.

Return value

true if the package contains the specified file; otherwise, false.

int findFile ( const char * path ) const#

Returns the file ID in the package by its path.

Arguments

• const char * path - File path.

Return value

File ID. A number between 0 and the total number of files in the package, or -1, if the file doesn't exist.

size_t getFileSize ( int num ) const#

Returns the size of the file at the specified index within the package.

Arguments

• int num - Index of the file in the package.

Return value

Size of the file in bytes.

const char * getFilePath ( int num ) #

Returns the path of the file at the specified index.

Arguments

• int num - Index of the file in the package.

Return value

A string representing the path of the file.

size_t getFileCompressedSize ( int num ) const#

Returns the compressed size of the file at the specified index. Compression is applied only to files with extensions included in the compression list specified in the constructor.

Arguments

• int num - Index of the file in the package.

Return value

The size of the file in its compressed form, in bytes.

bool isFileCompressed ( int num ) const#

Checks whether the file at specified index is stored in compressed form within the package. Compression is applied only to files with extensions included in the compression list specified in the constructor.

Arguments

• int num - Index of the file in the package.

Return value

true if the specified file is compressed; otherwise, false.

int getNumCompressExtensions ( ) const#

Returns the number of file extensions currently included in the compression list. The compression list is specified when the PackageUng object is constructed.

Return value

Number of file extensions in the compression list.

const char * getCompressExtension ( int num ) const#

Retrieves a file extension from the compression list by it's index. The compression list is specified when the PackageUng object is constructed.

Arguments

• int num - Index of the extension in the compression list.

Return value

The file extension at the given index.

bool isCompressExtension ( const char * OUT_ext ) const#

Checks whether the specified file extension is in the compression list. The compression list is specified when the PackageUng object is constructed.

Arguments

• const char * OUT_ext - The file extension to check (without a leading dot).
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

true if the specified extension is in compression list; otherwise, false.