Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Storyboard

Represents a storyboard.

Hierarchy

  • Storyboard

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly layers

layers: Partial<Record<<internal>.StoryboardLayerType, <internal>.StoryboardLayer>>

The layers in the storyboard.

useSkinSprites

useSkinSprites: boolean

Whether the storyboard can fall back to skin sprites in case no matching storyboard sprites are found.

variables

variables: Record<string, string>

The variables of the storyboard.

Accessors

earliestEventTime

  • get earliestEventTime(): null | number

  • Across all layers, find the earliest point in time that a storyboard element exists at. Will return null if there are no elements.

    This iterates all elements and as such should be used sparingly or stored locally.

    Returns null | number

latestEventTime

  • get latestEventTime(): null | number

  • Across all layers, find the latest point in time that a storyboard element exists at. Will return null if there are no elements.

    This iterates all elements and as such should be used sparingly or stored locally. Samples return start time as their end time.

    Returns null | number

Methods

getLayer

Generated using TypeDoc