storyboard-easel/dev.bnorm.storyboard.easel/SceneMode

SceneMode

enum SceneMode : Enum<SceneMode> (source)

What mode for a dev.bnorm.storyboard.Scene is active. Scenes can be displayed multiple times and in multiple locations. It is useful for a scene to know what mode it is in, so it can change how it is rendered or perform different effects. For example, a scene may have an animation, which is not useful to play when the scene is being previewed.

There are currently two modes:

Story - Used when the scene is displayed within the main story. Only one copy of the scene should ever be in story mode.
Preview - Used when previewing the display of a scene. For example, in the overview, assistant, or when being exported.

Entries

Story

Preview

Properties

entries

val entries: EnumEntries<SceneMode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): SceneMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<SceneMode>

Returns an array containing the constants of this enum type, in the order they're declared.