ktvn/com.github.benpollarduk.ktvn.logic

Package-level declarations

Types

class Answer

An answer to a question.

AutoTimeController

class AutoTimeController

Provides a class for controlling 'auto' functionality.

data class Ending(val name: String, val number: Int)

Provides the ending of a story.

class Flags

Provides a mechanism for setting and getting flags.

class Game(visualNovel: VisualNovel, gameSave: GameSave = GameSave.EMPTY, restorePoint: RestorePoint = RestorePoint.EMPTY)

An executable game with a specified visualNovel and optional gameSave and restorePoint.

GameExecutionResult

data class GameExecutionResult(val reachedEnding: Boolean, val ending: Ending, val gameSave: GameSave)

Provides a result of the execution of a Game.

object GameExecutor

Provides an object that controls execution of games.

InteractiveComponent

fun interface InteractiveComponent

Provides an interface for interactive components.

ProgressionController

class ProgressionController

A controller for progression throughout a Game.

ProgressionMode

interface ProgressionMode

Provides an interface for progression modes.

A question, provides the option for a user to branch a story based on input.

abstract class VisualNovel(val story: Story, val configuration: GameConfiguration, val desiredResolution: Resolution = Resolution.NOT_SPECIFIED)

A visual novel. Contains all the components required to create a Game including a story and configuration. A desiredResolution can be specified if a specific resolution should be targeted.