Scene - Creator Plugins API

Scene interface

Represents a scene in the animation.

Signature:

interface Scene extends BaseAssetMixin

Extends: BaseAssetMixin

A scene represents a container for animation content. It defines dimensions, framerate, duration, and contain layers.

const scene = creator.createScene({
  name: "New Scene",
  size: { width: 1920, height: 1080 },
  framerate: 60,
  duration: 5,
});

Property	Modifiers	Type	Description
backgroundColor		Color	Background color of the scene
duration		number	Duration of the scene in seconds
framerate		number	Frames per second
isNestableScene	`readonly`	boolean	Whether this scene can be nested within other scenes.
layers	`readonly`	ReadonlyArray<Layer>	Array of layers in this scene
size		Size	Dimensions of the scene in pixels
type	`readonly`	"SCENE"	Asset type

Method	Description
createImageLayer(opts)	Creates a new image layer
createSceneLayer(opts)	Creates a scene layer from a source scene
createShapeLayer(opts)	Creates a new shape layer
createTextLayer(opts)	Creates a new text layer
import(opts)	Import animations and images into the scene.