ktvn/com.github.benpollarduk.ktvn.logic.engines/GameEngine

GameEngine

interface GameEngine

Defines the functionality that an engine must provide to run a Game.

Inheritors

AnsiConsoleGameEngine

Properties

log

abstract val log: Log

Get the log. All events can be logged here so that they can be recalled later if needed.

progressionController

abstract val progressionController: ProgressionController

Get the progression controller.

volumeManager

abstract val volumeManager: VolumeManager

Get the volume manager.

Functions

characterAnimation

abstract fun characterAnimation(character: Character, animation: Animation)

Play a character.

characterAsksQuestion

abstract fun characterAsksQuestion(character: Character, question: Question)

Handle a character asking a question.

characterMoves

abstract fun characterMoves(character: Character, from: Position, to: Position, transition: LayoutTransition)

Move a character a position to another position with a specified transition.

characterShowsEmotion

abstract fun characterShowsEmotion(character: Character, emotion: Emotion)

Show a character.

characterSpeaks

abstract fun characterSpeaks(character: Character, line: String)

Handle a character speaking a line.

characterThinks

abstract fun characterThinks(character: Character, line: String)

Handle a character thinking a line.

clearScene

abstract fun clearScene(scene: Scene)

Clear a scene.

enterChapter

abstract fun enterChapter(chapter: Chapter, transition: ChapterTransition)

Enter a chapter with a transition.

enterScene

abstract fun enterScene(scene: Scene, transition: SceneTransition)

Enter a scene with a transition.

enterStep

abstract fun enterStep(step: Step, flags: Flags, canSkip: Boolean, cancellationToken: CancellationToken)

Enter a step with flags. When the step can be skipped canSkip will be true. A cancellationToken must be provided to support cancellation.

enterStory

abstract fun enterStory(story: Story)

Enter a story.

exitChapter

abstract fun exitChapter(chapter: Chapter)

Exit a chapter .

exitScene

abstract fun exitScene(scene: Scene, transition: SceneTransition)

Exit a scene with a transition.

exitStep

abstract fun exitStep(step: Step, flags: Flags)

Exit a step.

exitStory

abstract fun exitStory(story: Story)

Exit a story .

getAnswerToQuestion

abstract fun getAnswerToQuestion(question: Question): Answer

Get an Answer to a question.

narratorAsksQuestion

abstract fun narratorAsksQuestion(narrator: Narrator, question: Question)

Handle a narrator asking a question.

narratorNarrates

abstract fun narratorNarrates(narrator: Narrator, line: String)

Handle a narrator narrating a line.

playSoundEffect

abstract fun playSoundEffect(soundEffect: SoundEffect)

Play a soundEffect.