engine.filesystemmount Functions
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
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 FILESYSTEM_MOUNT_ACCESS_* values.string getName ( ) #
Returns the name of the mount point.Return value
Mount point name.string getDataPath ( ) #
Returns the absolute path to the mounted folder/package.Return value
Absolute path to the mounted folder/package.string 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.string getUMountPath ( ) #
Returns the absolute path to the *.umount file.Return value
Absolute path to the *.umount file.void setExclusiveFilters ( Vector<String>& filters ) #
Sets the list of exclusive filters (whitelist) to be used for files as a list of wildcards.Arguments
- Vector<String>& filters - List of wildcards to be used to filter files in the mounted folder/package.
NoticeMaximum number of patterns that can be used is limited to 32.
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.
NoticeMaximum number of patterns that can be used is limited to 32.
void setIgnoreFilters ( Vector<String>& filters ) #
Sets the list of ignore filters (blacklist) to be used for files as a list of wildcards.Arguments
- Vector<String>& filters - List of wildcards to be used to filter out files to be ignored in the mounted folder/package.
NoticeMaximum 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.
NoticeMaximum 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.Notice
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 ( string path ) #
Returns a value indicating whether the specified path is filtered out by the exclusive and ignore filters.Arguments
- string 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:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)