Add a figure
figure_addAdd a stick figure instance at a specified or default position on a keyframe using a chosen or default figure definition, adding the figure to the project timeline.
Instructions
Add a figure instance to the keyframe the playhead is on, using one of the existing figure definitions. The new figure is placed at the given position, or at the centre of the canvas. Give a keyframe number to choose the keyframe; without one the playhead decides. Give the definition to use with "figureTypeId"; omit it to use the first definition in the project.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | No | Where to place the figure, in canvas pixels. | |
| y | No | Where to place the figure, in canvas pixels. | |
| frame | No | The place on the timeline to work on. Defaults to the playhead. | |
| project | No | The id of an open project, from project_open. Defaults to the project used most recently. | |
| figureTypeId | No | The figure definition to instantiate. |