Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Unigine::Package Class

Header:#include <UniginePackage.h>

Unigine external package.

Package Class

Members


virtual const char * getFileName(int num) =0

Return the file name.

Arguments

  • int num - The file number.

Return value

The file name.

virtual int getNumFiles() =0

Return the number of files in the package.

Return value

Number of the package files.

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 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.

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 ~Package()

Virtual destructor.
Last update: 2017-10-20