ktaf/com.github.benpollarduk.ktaf.assets

Package-level declarations

Types

Provides a callback for a condition that must return a Boolean.

class ConditionalDescription(trueDescription: String, falseDescription: String, condition: Condition) : Description

Provides a conditional description of an object. Returns the trueDescription if the condition returns true, else the falseDescription.

Description

open class Description(description: String)

Provides a description of an object, specified by description.

Examinable

interface Examinable : PlayerVisible

Provides a simple contract for any object that can be examined.

ExaminableObject

abstract class ExaminableObject : Examinable

Provides a base implementation for examinable objects.

Examination

typealias Examination = (examinationRequest: ExaminationRequest) -> ExaminationResult

Provides a lambda signature for handling an examinationRequest that must return a ExaminationResult.

ExaminationRequest

data class ExaminationRequest(val examinable: Examinable, val scene: ExaminationScene)

Represents a request to examine an examinable in a scene.

ExaminationResult

data class ExaminationResult(val description: String) : Result

The result of an examination.

ExaminationScene

data class ExaminationScene(val examiner: Character, val room: Room)

Represents a scene that an examination occurs in with a examiner and a room.

Identifier

class Identifier(val name: String)

Provides functionality that can be used to identify an object with a specified name.

Item

class Item(val identifier: Identifier, var description: Description, var takeable: Boolean = false, var interaction: Interaction = defaultInteraction) : ExaminableObject, InteractWithItem

Provides an item that can appear in a Game. The item must have a identifier and a description. Optionally the item can be made takeable by setting takeable to true, and an interaction to define how this interacts with various InteractWithItem specified with interaction.

PlayerVisible

interface PlayerVisible

Provides a simple contract for any object that can be visible to a player.

Size

data class Size(val width: Int, val height: Int)

Represents a 2-dimensional size with a width and a height.