Scripting Reference

T-HSCP-001-001

The following sections are reference guides for the scripting language used by 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.

When scripting in Harmony, you can open the scripting reference guide from the Script Editor by opening the Script Editor 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 Control Center scripting from the installation directory's help sub-directory, at the following locations:

On Windows:

  • Harmony scripting: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 15.0 Premium\help\script\index.html
  • Script node: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 15.0 Premium\help\scriptmodule\index.html
  • Control Center scripting: C:\Program Files (x86)\Toon Boom Animation\Toon Boom Harmony 15.0 Premium\help\dbscript

On macOS (Stand Alone):

  • Harmony scripting: /Applications/Toon Boom Harmony 15.0 Premium/tba/help/script/index.html
  • Script node: /Applications/Toon Boom Harmony 15.0 Premium/tba/help/scriptmodule/index.html
  • Control Center scripting: /Applications/Toon Boom Harmony 15.0 Premium/tba/help/dbscript/index.html

On macOS (Server):

  • Harmony scripting: /Applications/Toon Boom Harmony 15.0 Premium Network/tba/help/script/index.html
  • Script node: /Applications/Toon Boom Harmony 15.0 Premium Network/tba/help/scriptmodule/index.html
  • Control Center scripting: /Applications/Toon Boom Harmony 15.0 Premium Network/tba/help/dbscript/index.html

On GNU/Linux:

  • Harmony scripting: /usr/local/ToonBoomAnimation/harmonyPremium_15.0/help/script/index.html
  • Script node: /usr/local/ToonBoomAnimation/harmonyPremium_15.0/help/scriptmodule/index.html
  • Control Center scripting: /usr/local/ToonBoomAnimation/harmonyPremium_15.0/help/dbscript/index.html