This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

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.

int findFile ( const char * name ) const#

Returns the file ID in the package by its name.

Arguments

  • const char * name - File name.

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#

Arguments

  • int num
Last update: 2024-08-16
Build: ()