ktaf/com.github.benpollarduk.ktaf.conversations

Package-level declarations

Types

Conversation

class Conversation(paragraphs: List<Paragraph> = emptyList())

Provides a mechanism for holding a conversation with a Converser. The paragraphs specify the body of the conversation.

ConversationAction

typealias ConversationAction = (game: Game) -> Unit

Provides a mechanism for invoking actions in a conversation within a specified game.

Converser

interface Converser : Examinable

Provides a contract for any onject that can hold a Conversation.

LogItem

data class LogItem(val participant: Participant, val line: String)

A logged element of a Conversation, consisting of the participant and the line that they said.

Paragraph

class Paragraph(val line: String, val instruction: EndOfParagraphInstruction = Next(), val name: String = "", val action: ConversationAction = { })

A paragraph within a Conversation. Must contain a line, but can also have an optional action that is invoked as a response to this paragraph being triggered. The instruction is applied to direct the conversation after this paragraph.

Participant

enum Participant : Enum<Participant>

Enumeration of participants in a conversation.

Response

data class Response(val line: String, val instruction: EndOfParagraphInstruction = Next())

A response which forms part of a Conversation. The line forms the body of the response and the instruction is applied to direct the conversation after this paragraph.