ktvn/com.github.benpollarduk.ktvn.structure/Scene

Scene

class Scene

A scene within a Chapter.

Types

Companion

object Companion

Properties

background

var background: Background

Get the background for this Scene.

indexOfCurrentStep

var indexOfCurrentStep: Int

Get the index of the current Step.

layout

var layout: Layout

Get the layout for this Scene.

music

var music: Track

Get the music for this Scene.

name

var name: String

Get the name of this Scene.

numberOfSteps

val numberOfSteps: Int

Get the number of Step that make up this Scene.

type

var type: SceneType

Get the type of Scene this is.

Functions

background

infix fun background(background: Background)

Set the background.

infix fun background(key: String)

Set the background, specified by key.

layout

infix fun layout(layout: Layout)

Set the layout for this scene.

music

infix fun music(music: Track)

Set the music.

infix fun music(key: String)

Set the music, specified by key.

name

infix fun name(name: String)

Set the name for this scene.

steps

infix fun steps(steps: List<Step>)

Set the steps that make up this scene.

transitionIn

infix fun transitionIn(transition: SceneTransition)

Set the transition in for this scene.

transitionOut

infix fun transitionOut(transition: SceneTransition)

Set the transition out for this scene.

type

infix fun type(type: SceneType)

Set the type of scene this is.