ktaf/com.github.benpollarduk.ktaf.assets/Examinable

Examinable

interface Examinable : PlayerVisible

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

Inheritors

ExaminableObject

Properties

abstract val attributes: AttributeManager

An AttributeManager that provides management of all Attribute for this Examinable.

abstract val commands: List<CustomCommand>

A list of CustomCommand that this Examinable provides.

abstract val description: Description

A Description that describes this object.

abstract val identifier: Identifier

An Identifier that can be used to identify this object.

isPlayerVisible

abstract val isPlayerVisible: Boolean

Returns true if visible to the player, else false.

Functions

abstract fun examine(scene: ExaminationScene): ExaminationResult

Examine this object to obtain an ExaminationResult. The scene that the examination occurs in must be specified.