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

Package Class

Members


virtual string GetFilePath ( int num ) =0#

Returns the path to the file at the specified index.

Arguments

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

Return value

Relative path to the file within the package.

virtual int GetNumFiles ( ) =0#

Returns the number of files in the package.

Return value

Number of the package files.

virtual bool ReadFile ( IntPtr data, ulong size ) =0#

Reads the currently selected file.

Arguments

  • IntPtr data - Destination data pointer.
  • ulong size - Size of the data buffer.

Return value

true if the file is successfully read; otherwise, false is returned.

virtual bool SelectFile ( string path, out ulong size ) =0#

Selects a file with the specified path and puts its size to the specified buffer.

Arguments

  • string path - Relative path to the file to be selected within the package.
  • out ulong size - Buffer to receive the selected file size, in bytes.

Return value

true if the file is selected; otherwise, false is returned.

int FindFile ( string path ) #

Returns the file index in the package by its name.

Arguments

  • string path - Relative path to the file within the package.

Return value

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

ulong GetFileSize ( int num ) #

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 with the specified index, in bytes.

The information on this page is valid for UNIGINE 2.20 SDK.

Last update: 2025-05-27
Build: ()