This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
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
VR Development
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::FileSystemMount Class

Header: #include <UnigineFileSystem.h>

This class represents a mount point that is used to extend the Engine's file system. Mount point is a sort of a symlink enabling you to extend the virtual file system of your project by adding any external folders and packages to the data directory.

FileSystemMount Class

Members


int getAccess ( ) #

Returns the current access mode of the mount point.

Return value

Mount point access mode, one of the ACCESS_* values.

const char * getName ( ) #

Returns the name of the mount point.

Return value

Mount point name.

const char * getDataPath ( ) #

Returns the absolute path to the mounted folder/package.

Return value

Absolute path to the mounted folder/package.

const char * getVirtualPath ( ) #

Returns the virtual path to the folder to which the contents of the external folder/package is mounted.

Return value

Virtual path to the folder to which the contents of the external folder/package is mounted.

const char * getUMountPath ( ) #

Returns the absolute path to the *.umount file.

Return value

Absolute path to the *.umount file.

void setExclusiveFilters ( Vector< String > & OUT_filters ) #

Sets the list of exclusive filters (whitelist) to be used for files as a list of wildcards.

Arguments

  • Vector< String > & OUT_filters - List of wildcards to be used to filter files in the mounted folder/package.
    Notice
    Maximum number of patterns that can be used is limited to 32.
    Notice
    This output buffer is to be filled by the Engine as a result of executing the method.

void getExclusiveFilters ( Vector< String > & OUT_filters ) #

Returns the list of exclusive filters (whitelist) used for files as a list of wildcards.

Arguments

  • Vector< String > & OUT_filters - List of wildcards currently used to filter files in the mounted folder/package.
    Notice
    Maximum number of patterns that can be used is limited to 32.
    Notice
    This output buffer is to be filled by the Engine as a result of executing the method.

void setIgnoreFilters ( Vector< String > & OUT_filters ) #

Sets the list of ignore filters (blacklist) to be used for files as a list of wildcards.

Arguments

  • Vector< String > & OUT_filters - List of wildcards to be used to filter out files to be ignored in the mounted folder/package.
    Notice
    Maximum number of patterns that can be used is limited to 32.
    Notice
    This output buffer is to be filled by the Engine as a result of executing the method.

void getIgnoreFilters ( Vector< String > & OUT_filters ) #

Returns the list of ignore filters (blacklist) used for files as a list of wildcards.

Arguments

  • Vector< String > & OUT_filters - List of wildcards currently used to filter out files to be ignored in the mounted folder/package.
    Notice
    Maximum number of patterns that can be used is limited to 32.
    Notice
    This output buffer is to be filled by the Engine as a result of executing the method.

void getVirtualFiles ( Vector< String > & OUT_files ) #

Returns the list of virtual paths to all files in the mounted folder/package.
Notice
Contents of nested mount points inside the mounted folder will not be included in the list.

Arguments

  • Vector< String > & OUT_files - Output vector to store the list of files stored in the mounted folder/package.
    Notice
    This output buffer is to be filled by the Engine as a result of executing the method.

bool isPathFilteredOut ( const char * path ) #

Returns a value indicating whether the specified path is filtered out by the exclusive and ignore filters.

Arguments

  • const char * path - Any file path.

Return value

true if the specified path is filtered out after applying exclusive and ignore filters if any; otherwise, false.
Last update: 2023-12-19
Build: ()