Exit

class Exit(val direction: Direction, locked: Boolean = false, identifier: Identifier? = null, description: Description? = null) : ExaminableObject, InteractWithItem

Constructors

Link copied to clipboard
constructor(direction: Direction, locked: Boolean = false, identifier: Identifier? = null, description: Description? = null)

Properties

Link copied to clipboard
open override val attributes: AttributeManager

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

Link copied to clipboard
open override var commands: List<CustomCommand>

A list of CustomCommand that this Examinable provides.

Link copied to clipboard
open override var description: Description

A Description that describes this object.

Link copied to clipboard
Link copied to clipboard

Provides a callback for handling examination of this object.

Link copied to clipboard
open override var identifier: Identifier

An Identifier that can be used to identify this object.

Link copied to clipboard

Specifies how this Exit interacts with various Item.

Link copied to clipboard

Get if this Exit is locked.

Link copied to clipboard
open override var isPlayerVisible: Boolean

Returns true if visible to the player, else false.

Functions

Link copied to clipboard
open override fun examine(scene: ExaminationScene): ExaminationResult

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

Link copied to clipboard
open override fun interact(item: Item): InteractionResult

Interact with the specified item to obtain a InteractionResult.

Link copied to clipboard
fun lock()

Lock this Exit.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
fun unlock()

Unlock this Exit.