Description

Load a native file (*.vdf or *.hdf). You are prompted for a filename.

Use loadFile when you need to open an existing *.vdf file. This action will close the open scene, prompting you first to save it.

You can also use this command to import or merge non-native motion capture files into your existing scene.

Functional area

File handling

Command syntax

Syntax

loadFile ["filename1" "filename2" ...][-startTime integer] [-type string] [-i] [-importType string] [-range integer integer] [-createBackupClip] [-currentSubject]

Arguments

Name	Type	Required	Comments
`filename`	String		String path name of file to be loaded (can be specified by the File Open or File Import dialog boxes or explicitly by name)

Flags

Name	Flag arguments	Argument type	Comments
`startTime`	1	integer	Force the incoming animation to start at the specified time.
`type`	1	string	Open the dialog with filter set to given extension (e.g. `"asf"` sets extension filter to .asf)
`i`	0	—	Import from a non-native file. Importer is chosen by matching the file extension.
`importType`	1	string	Arguments for this option are: `"ImportSelectedCreateNew"` - the default and does as indicated `"ImportOnlySelected"` - ignores any modules being imported that are not selected `"AlwaysCreateNew"` - forces importers to always create new modules `"CurrentClipCreateNew"` `"MergeAll"` `"MergeSelected"`
`range`	2	integer	—
`createBackupClip`	0	—	Automatically creates a backup clip for each clip created upon import.
`currentSubject`	0	—	Use to ensure VSR, VSS, VST, or VSK files merge into the current subject when loaded, regardless of whether the subject name of the current subject matches the file, for example, you can use this flag to import an updated VSS into an existing VSS.

Return value

boolean

Examples

loadFile -i -importType "mergeSelected"; 
// This command prompts you to select a non-native file. 
// The selected file is merged into your existing scene.

loadFile "C:/temp/myFile.vdf";
// Loads a native VDF file

Additional information

Related commands

saveFile