Adding a Toon Boom Asset to a Project

To add a Toon Boom asset to a project, you will first need to import the asset for use in the Game Engine, see Importing an Asset.

Once you have imported your asset and can view it in the Asset Viewer, there are two main methods to using it in your project:

  • Attaching the Asset to an Existing Node.

  • Using the Asset Directly as an Actor.

  1. Drag the imported asset from the Assets tab into the scene. If it is the wrong size for the scene then you can re-size it in one of two ways:

    1. Manually re-size the asset. The problem with this method is that you will need to do this every time you add the asset to any scene in your project.

    2. (Recommended) Adjust the Asset Transform in the Inspector. This transform will persist and be updated for any instance of the asset you add, and is a good place to establish the ‘real’ scale of your asset for this project.

  2. Make it a child object of any object you wish to attach it to. To do this, drag the object directly to another object. The object will become its child.

  3. Hide (or delete with caution) any of the previously visible elements of the object.

  4. If the asset has animation you can set its default (i.e. an auto-playing animation) via the instance or the original.

  5. To detect hits on the asset, connect to the signal area_enter_triggered(...) on the Asset instance and your script will be notified when a body or area comes into contact with the asset. You need to set the hitBoxShape property on the Asset to detect such signals.

  1. Open the imported asset in the Asset Viewer.

  2. Create an asset derivative (see Creating an Asset Derivative). This step is optional but is useful if you might want to reuse the asset in different ways.

  3. Attach a custom script, see Customizing an Asset Script. Here you can optionally choose as a starting point a bundled template script which includes basic interactivity, motion and physics handling.

  4. Set up collision regions for physics and/or hit testing (see Collision and Hitbox).