ktaf/com.github.benpollarduk.ktaf.assets.interaction

Package-level declarations

Types

Interaction

typealias Interaction = (item: Item) -> InteractionResult

Provides a lambda signature for interactions with an item to return a InteractionResult.

InteractionEffect

enum InteractionEffect : Enum<InteractionEffect>

Enumeration of possible effects to an interaction.

InteractionResult

class InteractionResult(val effect: InteractionEffect, val item: Item, descriptionOfInteraction: String?) : Result

Describes the result of an interaction, detailing the effect that the interaction between the item and the target had. If descriptionOfInteraction is null the description property will return a generated description, otherwise the descriptionOfInteraction will be returned.

InteractWithItem

fun interface InteractWithItem

Provides a contract for any object that can be a target for an interaction with an Item.

Reaction

data class Reaction(val result: ReactionResult, val description: String)

Provides a reaction consisting of both a result and a description.

ReactionResult

enum ReactionResult : Enum<ReactionResult>

Possible results from a Reaction.

Result

interface Result

Provides a general interface that provides a description as a result.