Storyboard

INFO

Inherits: Component

A root component that output the correct string for a standalone .osb file.

Example:

const sb = new Storyboard({
  children: [
    new Sprite({
      path: 'anim.png',
      layer: 'Background',
      origin: 'Centre',
      position: [320, 240],
    }),
  ],
})

const osb = sb.toString()

fs.writeFileSync(path, osb, 'utf-8')

Constructor details

Overloads:

new Storyboard()

new Storyboard({ children })

• Parameters:
  • children (Component | Graphic | Sample)[] | undefined: List of child storyboard objects. Defaults to undefined.

Properties

Properties inherited from Component:

children

Methods

Methods inherited from Component:

toFlatten

toString()

Returns the string representation of this storyboard.

• Returns: string