Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

Unigine::Package Class

Unigine external package.

To use this class, include the UniginePackage.h file.

Unigine::Package Class

Members


virtual ~Package ()

Virtual destructor.

virtual Package * clone () =0

Clone the external package for multi-threaded loading.

Return value

The cloned package. Return NULL if the multi-threading loading is not possible.

virtual int getNumFiles () =0

Return the number of files in the package.

Return value

Number of the package files.

virtual const char * getFileName (int num) =0

Return the file name.

Arguments

  • int num - The file number.

Return value

The file name.

virtual int selectFile (const char * name, int & size) =0

Select a file by name.

Arguments

  • const char * name - The file name.
  • int & size - The file size.

Return value

Returns 1 if the file is selected; otherwise, 0 is returned.

virtual int readFile (unsigned char * data, int size) =0

Read currently selected file.

Arguments

  • unsigned char * data - Destination data pointer.
  • int size - Size of the data buffer.

Return value

Returns 1 if the file is successfully read; otherwise, 0 is returned.
Last update: 2017-07-03