Scripting Reference

T-HSCP-001-001

The sections linked below are reference guides for Harmony's different scripting interfaces. In these reference guides, you will find information about the different functions, classes and properties made available for scripting in Harmony.

In Harmony, you can open the scripting reference guide from the Script Editor view by opening the view menu and selecting Help > Scripting Interface Documentation.

You can also open the reference guide for the Harmony scripting interface, the Script module and for database scripting from the installation directory's help subdirectory, at the following locations:

On Windows:

  • Harmony scripting: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 17 Premium\help\script\index.html
  • Script module: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 17 Premium\help\scriptmodule\index.html
  • Database scripting: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 17 Premium\help\dbscript

On macOS:

  • Harmony scripting: /Applications/Toon Boom Harmony 17 Premium/Harmony Premium.app/Contents/Documentation/script/index.html
  • Script module: /Applications/Toon Boom Harmony 17 Premium/Harmony Premium.app/Contents/Documentation/scriptmodule/index.html
  • Database scripting: /Applications/Toon Boom Harmony 17 Premium/Harmony Premium.app/Contents/Documentation/dbscript/index.html

On GNU/Linux:

  • Harmony scripting: /usr/local/ToonBoomAnimation/harmonyPremium_17/help/script/index.html
  • Script module: /usr/local/ToonBoomAnimation/harmonyPremium_17/help/scriptmodule/index.html
  • Database scripting: /usr/local/ToonBoomAnimation/harmonyPremium_17/help/dbscript/index.html