Eyeon:Script/Reference/Applications/Fusion/Classes/Fusion/MapPath

From VFXPedia

Jump to: navigation, search

Contents

Fusion : MapPath

Arguments

result = MapPath(path)

  • path (required, string)

A file or directory path that can contain Fusion's path maps.

Returns

  • result (string)

A file or directory path with all path maps expanded into their literal path equivalents.

Remarks

There are a number of default and user-specified path maps within Fusion that are intended to provide convenient ways to access common locations, or for flexibility in scripting. These can be any string, but often end in a colon, e.g. Fusion:, Comps:. They are expanded into a literal path as specified by the Path Maps preferences page.

However, many Fusion functions (and all Lua functions) require strictly literal paths. MapPath() can be used to easily convert any path map into a fully-expanded literal path. If there is no path map at the beginning of the path, MapPath() will just return the unchanged path.

Fusion:MapPath() will expand any path maps listed in the global Path Map preferences, which include the following standard defaults:

Fusion:The directory that contains the Fusion application
Temp:The system temporary directory
User:The current user's home directory
UserData:The Fusion subdir within User:
Profiles:The dir containing Fusion user profile settings
Profile:The current Fusion user profile dir
Scripts:The dir containing all Fusion scripts (comp scripts, tool scripts etc)
Queues:Saved queues from the Render Manager
LUTs:LUT files to appear in the image view list
Libraries:Library settings for tools like Text+
Comps:The default directory for saved compositions
ScriptPlugins:Scripts defining custom tools
Defaults:Default initial settings files for tools
DiskCaches:Default dir for Disk Cache files
Macros:Macro settings to appear in the Tools menu
Settings:Saved settings for tools
Stamps:Thumbnails for file objects in the Bins
Previews:Dir for net-rendered previews and disk caches
Plugins:Dir for all Fusion plugins
AEPlugins:Dir for all After Effects plugins
Brushes:Dir for brushes used by Paint and Particles
Bins:Storage for information related to the Bins
Filters:Custom saved settings for the Filter tool

Requirements

  • eyeonScript 5.0
  • Fusion 5.0

See Also

ReverseMapPath()
Composition:MapPath()

Examples

print(MapPath("Fusion:\\"))

Result:
C:\Program Files\Fusion\


Tips for MapPath (edit)

EyeonTips:Script/Reference/Applications/Fusion/Classes/Fusion/MapPath