Storyboards.add Method

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Python
C++
TypeScript 🧪

"storyboards_var" is a variable referencing a Storyboards object.

# Uses no optional arguments.
returnValue = storyboards_var.add()

# Uses optional arguments.
returnValue = storyboards_var.add(isCleanStoryboard)

"storyboards_var" is a variable referencing a Storyboards object.

#include <Fusion/Animation/Storyboards.h>

// Uses no optional arguments.
returnValue = storyboards_var->add();

// Uses optional arguments.
returnValue = storyboards_var->add(isCleanStoryboard);

"storyboards_var" is a variable referencing a Storyboards object.

// Uses no optional arguments.
returnValue = storyboards_var.add();

// Uses Optional arguments.
returnValue = storyboards_var.add(isCleanStoryboard);

Name	Type	Description
isCleanStoryboard	boolean	A boolean value for setting whether or not the new storyboard is clean. When specified to true the transformation is the same as that from the Design workspace. When specified to false, the transformation for every part is kept in the new storyboard, and is derived from the previous storyboard. It defaults to true if not specified. This is an optional argument whose default value is True.

Storyboards.add Method

Description

Syntax

Return Value

Parameters

Version

Type	Description
Storyboard	Returns the newly created Storyboard object or null if the creation failed.