CreatorAPI - Creator Plugins API

CreatorAPI interface

Main Creator API interface.

Signature:

interface CreatorAPI

This is the primary interface for interacting with LottieFiles Creator from a plugin. Access it via the global creator object.

Property	Modifiers	Type	Description
activeScene	`readonly`	Scene	The currently active scene
apiVersion	`readonly`	APIVersion	The API version being used
assets	`readonly`	ReadonlyArray<Asset>	Array of all scene and image assets in the project
clientStorage	`readonly`	ClientStorage	Browser storage for plugin data.
closePlugin		() => void	Closes the plugin and stops it from running
openLink		(url: string) => void	Opens an external link in the user's default browser
scenes	`readonly`	ReadonlyArray<Scene>	Array of all scenes in the animation
selection	`readonly`	SelectionAPI	API for accessing the currently selected nodes and keyframes
switchToScene		(scene: Scene) => void	Switches to a different scene
timeline	`readonly`	TimelineAPI	API for timeline playback control
ui	`readonly`	UIAPI	API for managing the plugin UI
utils	`readonly`	UtilsAPI	Utility helpers for working with nodes

Method	Description
createScene(opts)	Creates a new scene.
getAvailableFonts()	Returns all fonts available for use in text layers.
off(type, callback)	Removes an event listener
on(type, callback)	Registers an event listener for plugin events