Storyboard.play Method

Parent Object: Storyboard
Defined in namespace "adsk::fusion" and the header file is <Fusion/Animation/Storyboard.h>

Description

Method that plays the storyboard.

Syntax

"storyboard_var" is a variable referencing a Storyboard object.

# Uses no optional arguments.
returnValue = storyboard_var.play()

# Uses optional arguments.
returnValue = storyboard_var.play(fromCurrentPosition, begin, end)
"storyboard_var" is a variable referencing a Storyboard object.

#include <Fusion/Animation/Storyboard.h>

// Uses no optional arguments.
returnValue = storyboard_var->play();

// Uses optional arguments.
returnValue = storyboard_var->play(fromCurrentPosition, begin, end);
"storyboard_var" is a variable referencing a Storyboard object.

// Uses no optional arguments.
returnValue = storyboard_var.play();

// Uses Optional arguments.
returnValue = storyboard_var.play(fromCurrentPosition, begin, end);

Return Value

Type Description
boolean This returns true if the playback is successfully started.

Parameters

Name Type Description
fromCurrentPosition boolean Optional argument specifies whether to play the storyboard from current playhead position. Set this to false to specify the begin. This defaults to true indicating that it plays from current playhead position.

This is an optional argument whose default value is True.
begin double Specifies the begin time in seconds to start playback. This is ignored if the fromCurrentPosition is not set to false.

This is an optional argument whose default value is 0.0.
end double Specifies the end time in seconds to stop playback. This defaults to 0 indicating the Storyboard.end will be used. If specified this should be larger than the Storyboard.playheadPosition if the fromCurrentPosition argument is set to true, or it should be larger than begin if the fromCurrentPosition argument is set to false.

This is an optional argument whose default value is 0.0.

Version

Introduced in version May 2026