The Harmony Scripting guide contains information to help you use Qt Script, the scripting language used by Toon Boom Harmony.
Qt Script provides access to many of the functions supported in the Harmony interface. With Qt Script, you can automate a number of Harmony functions to speed up the completion of various repetitive tasks.
- Harmony Scripts are scripts that you can write and use directly in the Harmony user interface. Among many possible uses, Harmony scripts can automate workflows and functionalities in Harmony, create dialogs and perform batch operations on a scene.
- The Script Module is a special node which can take input from image or peg nodes, process its information in a custom-made script and output the processed peg or image information in the desired way. It allows you to create nodes that have custom behaviors. For example, the Maya Render Batch node is actually a Script Module template that is configured to render your scene through an external render.
- DbScript are scripts than can be launched in a command line interface via the Control Center application. They can be used to perform operations on the different elements of a Harmony Server database.
.js extension, instead of
.qsa. This change to the API improves the software and gives access to 64-bit capabilities of the scripting interface.
To avoid complications for users of earlier version, every effort was made to enable backward compatibility with QSA scripts. Simple functions can be ported without making any changes. However, class definitions must conform to the Qt Script syntax. Therefore, scripts that define classes must be updated. For detailed instructions on how to update from QSA to Qt scripts, see the Moving from QSA to Qt Script documentation of the Qt website.