Unigine.FileSystemMount Class
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
Properties
int Access#
The current access mode of the mount point.
string DataPath#
The absolute path to the mounted folder/package.
string Name#
The name of the mount point.
string UMountPath#
The absolute path to the *.umount file.
string VirtualPath#
The virtual path to the folder to which the contents of the external folder/package is mounted.
Members
void SetExclusiveFilters ( string[] OUT_filters ) #
Sets the list of exclusive filters (whitelist) to be used for files as a list of wildcards.Arguments
- string[]
OUT_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.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
void GetExclusiveFilters ( string[] OUT_filters ) #
Returns the list of exclusive filters (whitelist) used for files as a list of wildcards.Arguments
- string[]
OUT_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.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
void SetIgnoreFilters ( string[] OUT_filters ) #
Sets the list of ignore filters (blacklist) to be used for files as a list of wildcards.Arguments
- string[]
OUT_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.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
void GetIgnoreFilters ( string[] OUT_filters ) #
Returns the list of ignore filters (blacklist) used for files as a list of wildcards.Arguments
- string[]
OUT_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.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
void GetVirtualFiles ( 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
- string[]
OUT_files - Output vector to store the list of files stored in the mounted folder/package.NoticeThis output buffer is to be filled by the Engine as a result of executing the method.
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:
2024-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)