TScript:vfs Command

From Derivative
Jump to navigation Jump to search
vfs [-p path] [-b] [-l pattern] [-L pattern] [-x pattern] [-o] [-f folder] [-r pattern] [-a file]

This command accesses the Virtual File System, the internally embedded files of any component. Components with "embedded files" have a Virtual File System, or VFS.

Options[edit]

-p path Specify the component. If none is given it uses the current component.
-l pattern List the files embedded in the component.
-b specifies to match by label, instead of path.
-L pattern List the files embedded in the component and all its children components recursively.
-b specifies to match by label, instead of path.
-r Remove the specified files from the component.
-b specifies to match by label, instead of path.
-a file Add a disk file to the component.
-x pattern Export the embedded files.
-o forces files to be overwritten, else they are renamed.
-f specifies a new folder, else the original path is used.
-b specifies to match by label, instead of path.
The new path to the file is returned.

Examples[edit]

Add image.jpg to /project1:

vfs -p /project1 -a image.jpg	

List /project1's embedded files:

vfs -p /project1 -l *

List /project1's embedded files and all its children:

vfs -p /project1 -L *		

Export all JPG images in project1 to C:\images:

cc /project1
vfs -x *.jpg -f C:\images

Delete all files whose label matches the pattern.

vfs -r house* -b

Usage in Operator File Parameters[edit]

In File parameters of operators like the Movie File In TOP and Audio File In CHOP, the vfs: syntax in parameters allows for specifying either the internal label, or the internal full path. The two formats are:

vfs:component_path/label
vfs:component_path:disk_path

Example:

vfs:/project1/butterfly1.jpg
vfs:/project1:Icons/bin33/butterfly.jpg

If the virtual file is in the same component as the operator with the File parameter:

vfs::Icons/bin33/butterfly.jpg