Storyboard.play Method

Storyboard

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.

Syntax

Python
C++
TypeScript 🧪

"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);

Parameters

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.

Storyboard.play Method

Description

Syntax

Return Value

Parameters

Version

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

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.