@pixi/animate

Properties:

Name	Type	Description
`assets`	{ [id: string]: string }	Dictionary of paths to shape files and textures, indexed by unique id within the scene file.
`background`	number	Background color of the scene, as defined when the asset is published.
`framerate`	number	Framerate of the scene (frames per second), as defined when the asset is published.
`getTexture`	(id: string) => Texture	Function for getting a texture by ID. It can be set to PIXI.Texture.from for global texture atlas.
`height`	number	Height of the scene, as defined when the asset is published.
`lib`	{ [id: string]: (() => (MovieClip \| AnimateContainer)) }	Dictionary of display object constructors used within this scene. This is an empty object before setup() is run, but can be overwritten with a shared library dictionary (before setup() is run).
`setup`	(animate: PixiAnimate) => void	Creates classes for each Container and MovieClip within the scene, filling data.lib and setting data.stage.
`shapes`	{ [id: string]: DrawCommands[] }	Dictionary of loaded shape instructions for this scene. This is intially an empty object that can be filled by animate.load(), or by a custom loading system. It must be filled before any items are instantiated.
`spritesheets`	Spritesheet[]	Dictionary of loaded spritesheets for this scene. This is intially an empty object that will be filled by animate.load(). It will be used by the default method for getTexture(), and is not needed if getTexture() is overridden.
`stage`	() => MovieClip	Constructor for the root MovieClip. Is null before setup() is run.
`textures`	{ [id: string]: Texture }	Dictionary of loaded individual images for this scene. This is intially an empty object that will be filled by animate.load(). It will be used by the default method for getTexture(), and is not needed if getTexture() is overridden.
`totalFrames`	number	Total number of frames of the root MovieClip.
`version`	number	File format version that the asset was published for. 2 is the base version that PixiAnimate 2.0.0 supports.
`width`	number	Width of the scene, as defined when the asset is published.

Members

assets { [id: string]: string }

Dictionary of paths to shape files and textures, indexed by unique id within the scene file.

background number

Background color of the scene, as defined when the asset is published.

framerate number

Framerate of the scene (frames per second), as defined when the asset is published.

getTexture (id: string) => Texture

Function for getting a texture by ID. It can be set to PIXI.Texture.from for global texture atlas.

height number

Height of the scene, as defined when the asset is published.

lib { [id: string]: (() => (MovieClip | AnimateContainer)) }

Dictionary of display object constructors used within this scene. This is an empty object before setup() is run, but can be overwritten with a shared library dictionary (before setup() is run).

setup (animate: PixiAnimate) => void

Creates classes for each Container and MovieClip within the scene, filling data.lib and setting data.stage.

shapes { [id: string]: DrawCommands[] }

Dictionary of loaded shape instructions for this scene. This is intially an empty object that can be filled by animate.load(), or by a custom loading system. It must be filled before any items are instantiated.

spritesheets Spritesheet[]

Dictionary of loaded spritesheets for this scene. This is intially an empty object that will be filled by animate.load(). It will be used by the default method for getTexture(), and is not needed if getTexture() is overridden.

stage () => MovieClip

Constructor for the root MovieClip. Is null before setup() is run.

textures { [id: string]: Texture }

Dictionary of loaded individual images for this scene. This is intially an empty object that will be filled by animate.load(). It will be used by the default method for getTexture(), and is not needed if getTexture() is overridden.

totalFrames number

Total number of frames of the root MovieClip.

version number

File format version that the asset was published for. 2 is the base version that PixiAnimate 2.0.0 supports.

width number

Width of the scene, as defined when the asset is published.