ktvn/com.github.benpollarduk.ktvn.logic.engines.ansiConsole/AnsiConsoleGameEngine

AnsiConsoleGameEngine

class AnsiConsoleGameEngine(parameters: TextFrameParameters = TextFrameParameters(DEFAULT_WIDTH, DEFAULT_LINES), enterPrompt: String = "<enter> ", adapter: ConsoleAdapter = AnsiConsoleAdapter()) : GameEngine

A class that functions as an engine for an ANSI compatible console. The display parameters can be specified to set up the text frame. An enterPrompt can be specified, this will be displayed when user input is awaited.

Constructors

AnsiConsoleGameEngine

constructor(parameters: TextFrameParameters = TextFrameParameters(DEFAULT_WIDTH, DEFAULT_LINES), enterPrompt: String = "<enter> ", adapter: ConsoleAdapter = AnsiConsoleAdapter())

Properties

open override val log: Log

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

progressionController

open override val progressionController: ProgressionController

Get the progression controller.

open override val volumeManager: VolumeManager

Get the volume manager.

Functions

beginProcessingInput

fun beginProcessingInput()

Begin processing console input.

characterAnimation

open override fun characterAnimation(character: Character, animation: Animation)

Play a character.

characterAsksQuestion

open override fun characterAsksQuestion(character: Character, question: Question)

Handle a character asking a question.

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

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

characterShowsEmotion

open override fun characterShowsEmotion(character: Character, emotion: Emotion)

Show a character.

characterSpeaks

open override fun characterSpeaks(character: Character, line: String)

Handle a character speaking a line.

characterThinks

open override fun characterThinks(character: Character, line: String)

Handle a character thinking a line.

open override fun clearScene(scene: Scene)

Clear a scene.

endProcessingInput

fun endProcessingInput()

End processing of console input.

open override fun enterChapter(chapter: Chapter, transition: ChapterTransition)

Enter a chapter with a transition.

open override fun enterScene(scene: Scene, transition: SceneTransition)

Enter a scene with a transition.

open override 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.

open override fun enterStory(story: Story)

Enter a story.

open override fun exitChapter(chapter: Chapter)

Exit a chapter .

open override fun exitScene(scene: Scene, transition: SceneTransition)

Exit a scene with a transition.

open override fun exitStep(step: Step, flags: Flags)

Exit a step.

open override fun exitStory(story: Story)

Exit a story .

getAnswerToQuestion

open override fun getAnswerToQuestion(question: Question): Answer

Get an Answer to a question.

narratorAsksQuestion

open override fun narratorAsksQuestion(narrator: Narrator, question: Question)

Handle a narrator asking a question.

narratorNarrates

open override fun narratorNarrates(narrator: Narrator, line: String)

Handle a narrator narrating a line.

playSoundEffect

open override fun playSoundEffect(soundEffect: SoundEffect)

Play a soundEffect.