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 getExclusiveFilters(Vector< String > & filters)
Returns the list of exclusive filters (whitelist) used for files as a list of wildcards.Arguments
- Vector< String > & filters - List of wildcards currently used to filter files in the mounted folder/package.Maximum number of patterns that can be used is limited to 32.
void getIgnoreFilters(Vector< String > & filters)
Returns the list of ignore filters (blacklist) used for files as a list of wildcards.Arguments
- Vector< String > & filters - List of wildcards currently used to filter out files to be ignored in the mounted folder/package.Maximum number of patterns that can be used is limited to 32.
void getVirtualFiles(Vector< String > & files)
Returns the list of virtual paths to all files in the mounted folder/package.Contents of nested mount points inside the mounted folder will not be included in the list.
Arguments
- Vector< String > & files - Output vector to store the list of files stored in the mounted folder/package.
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.int ACCESS_READONLY
Description
The mount point is read-only, files contained in the mounted folder/package cannot be modified.int ACCESS_READWRITE
Description
The mount point access mode is read-write, files contained in the mounted folder/package can be modified.Last update: 2018-08-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)