specialFolders Class Reference

The specialFolders JavaScript global object. Provide the path to application specific paths. More...

Properties
String	root
	read-only property for the root installation folder More...
String	config
	read-only property that contains the folder where application configuration files are stored. Normally, this is the /etc folder. More...
String	resource
	read-only property that contains where the resources files are stored. More...
String	etc
	read-only property that indicates where the [install]/etc folder is. More...
String	lang
	read-only property that contains the folder where the language files are stored. More...
String	platform
	read-only property that contains the platform specific folder. More...
String	app
	A read-only property containing the folder where the platforms specific applications are stored. Application and Binary folders are different on OS X, but are identical on all other platforms. More...
String	bin
	This is a read-only property that contains the folder where the platforms specific binaries are stored. Application and Binary folders are different on OS X. They are identical on all other platforms. More...
String	bin32
	This is a read-only property that contains the folder where the platforms specific 32-bit binaries are stored. More...
String	library
	This is a read-only property that contains the folder where the platforms specific libraries are stored. More...
String	legacyPlugins
	Location where the plugins that were designed for the previous SDK are stored. Replaces the plugins property. More...
String	plugins
	Location where the plugins that comply with the current SDK are stored. More...
String	temp
	This is a read-only property that contains where the application will create its temporary files. More...
String	userConfig
	This is a read-only property that contains the folder where the user configuration is stored. More...
String	htmlHelp
	This is a read-only property that contains the folder where the html help folder is. More...
String	userScripts
	This is a read-only property that contains the folder where the user scripts are stored. More...
String	database
	This is a read-only property that contains the database folder. More...
String	templateLibrary
	This is a read-only property that contains the folder where templates are stored. More...

Detailed Description

The specialFolders JavaScript global object. Provide the path to application specific paths.

By using the SpecialFolders functions, you can retrieve information about the different folders (directories) used by the application. All of the functions are read-only. They return strings that represent folders in use by the various applications. Depending on the application (e.g. Toon Boom Harmony versus Toon Boom AnimatePro), the same content is stored in a different location.

var scriptFolder = specialFolders.resource + "/scripts";

Property Documentation

app

String specialFolders::app

read

A read-only property containing the folder where the platforms specific applications are stored. Application and Binary folders are different on OS X, but are identical on all other platforms.

bin

String specialFolders::bin

read

This is a read-only property that contains the folder where the platforms specific binaries are stored. Application and Binary folders are different on OS X. They are identical on all other platforms.

bin32

String specialFolders::bin32

read

This is a read-only property that contains the folder where the platforms specific 32-bit binaries are stored.

config

String specialFolders::config

read

read-only property that contains the folder where application configuration files are stored. Normally, this is the /etc folder.

database

String specialFolders::database

read

This is a read-only property that contains the database folder.

etc

String specialFolders::etc

read

read-only property that indicates where the [install]/etc folder is.

htmlHelp

String specialFolders::htmlHelp

read

This is a read-only property that contains the folder where the html help folder is.

lang

String specialFolders::lang

read

read-only property that contains the folder where the language files are stored.

legacyPlugins

String specialFolders::legacyPlugins

read

Location where the plugins that were designed for the previous SDK are stored. Replaces the plugins property.

library

String specialFolders::library

read

This is a read-only property that contains the folder where the platforms specific libraries are stored.

platform

String specialFolders::platform

read

read-only property that contains the platform specific folder.

plugins

String specialFolders::plugins

read

Location where the plugins that comply with the current SDK are stored.

resource

String specialFolders::resource

read

read-only property that contains where the resources files are stored.

root

String specialFolders::root

read

read-only property for the root installation folder

temp

String specialFolders::temp

read

This is a read-only property that contains where the application will create its temporary files.

templateLibrary

String specialFolders::templateLibrary

read

This is a read-only property that contains the folder where templates are stored.

userConfig

String specialFolders::userConfig

read

This is a read-only property that contains the folder where the user configuration is stored.

userScripts

String specialFolders::userScripts

read

This is a read-only property that contains the folder where the user scripts are stored.