ktaf/com.github.benpollarduk.ktaf.logic/Game

Game

class Game(val information: GameInformation, initialPlayer: PlayableCharacter, val overworld: Overworld, completionCondition: EndCheck, gameOverCondition: EndCheck, errorPrefix: String = DEFAULT_ERROR_PREFIX, interpreter: Interpreter = defaultInterpreters, ioConfiguration: IOConfiguration = AnsiConsoleConfiguration)

Provides the overall container and logic for a game.

Constructors

constructor(information: GameInformation, initialPlayer: PlayableCharacter, overworld: Overworld, completionCondition: EndCheck, gameOverCondition: EndCheck, errorPrefix: String = DEFAULT_ERROR_PREFIX, interpreter: Interpreter = defaultInterpreters, ioConfiguration: IOConfiguration = AnsiConsoleConfiguration)

Types

object Companion

Properties

activeConverser

var activeConverser: Converser?

The active Converser.

displayCommandListInSceneFrames

var displayCommandListInSceneFrames: Boolean

Specifies if the command list should be displayed in scene frames.

val information: GameInformation

var isExecuting: Boolean

val overworld: Overworld

var player: PlayableCharacter

The current PlayableCharacter.

sceneMapKeyType

var sceneMapKeyType: KeyType

Specifies the type of key to use for scene maps.

Functions

fun changePlayer(player: PlayableCharacter)

Change to a specified player.

displayTransition

fun displayTransition(title: String, message: String)

Display a transition frame with a specified title and message.

findInteractionTarget

fun findInteractionTarget(name: String): InteractWithItem?

Find an InteractWithItem within this Game from a specified name. If the target cannot be found null is returned.

getAllPlayerVisibleExaminables

fun getAllPlayerVisibleExaminables(): List<Examinable>

Get a list of all Examinable that are currently visible to the player.