ktaf/com.github.benpollarduk.ktaf.assets.locations/Room

Room

class Room(val identifier: Identifier, var description: Description, exits: List<Exit> = emptyList(), items: List<Item> = emptyList()) : ExaminableObject, InteractWithItem

A room with a specified identifier and a description.

Constructors

constructor(identifier: String, description: String, exits: List<Exit> = emptyList(), items: List<Item> = emptyList())

A room with a specified identifier and a description.

constructor(identifier: Identifier, description: Description, exits: List<Exit> = emptyList(), items: List<Item> = emptyList())

Types

object Companion

Properties

open override val attributes: AttributeManager

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

val characters: List<NonPlayableCharacter>

Get the all characters in this Room.

open override var commands: List<CustomCommand>

A list of CustomCommand that this Examinable provides.

open override var description: Description

A Description that describes this object.

var enteredFrom: Direction?

Get the Direction this room was entered from.

var examination: Examination

Provides a callback for handling examination of this object.

val exits: List<Exit>

Get the all exits.

var hasBeenVisited: Boolean

Get if this Room has been visited.

open override var identifier: Identifier

An Identifier that can be used to identify this object.

var interaction: Interaction

Specifies how this Room interacts with various Item.

isPlayerVisible

open override var isPlayerVisible: Boolean

Returns true if visible to the player, else false.

val items: List<Item>

Get the all items in this Room.

val unlockedExits: List<Exit>

Get the all unlocked exits.

Functions

fun addCharacter(character: NonPlayableCharacter)

Add a character to this Room.

fun addExit(exit: Exit)

Add an exit to this Room.

fun addItem(item: Item)

Add an item to this Room.

fun canMove(direction: Direction): Boolean

Determine if a move in this Room is possible in a specified direction. Returns true if the move is possible, else false.

containsCharacter

fun containsCharacter(character: NonPlayableCharacter): Boolean

Get if this Room contains a specified character.

fun containsCharacter(character: String, includeInvisibleCharacters: Boolean = false): Boolean

Get if this Room contains a character. If includeInvisibleCharacters is true then characters that aren't visible to the player are included.

containsInteractionTarget

fun containsInteractionTarget(target: String, includeInvisibleExits: Boolean = false): Boolean

Get if this Room contains an InteractWithItem specified by target. If includeInvisibleExits is true then targets that aren't visible to the player are included.

fun containsItem(item: Item): Boolean

Get if this Room contains a specified item.

fun containsItem(item: String, includeInvisibleItems: Boolean = false): Boolean

Get if this Room contains an item. If includeInvisibleItems is true then items that aren't visible to the player are included.

open override fun examine(scene: ExaminationScene): ExaminationResult

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

fun findCharacter(character: String, includeInvisibleCharacters: Boolean = false): NonPlayableCharacter?

Find a Character in this Room, specified by character. If includeInvisibleCharacters is true then items that aren't visible to the player are included.

fun findExit(direction: Direction, includeInvisibleExits: Boolean = false): Exit?

Find the Exit in the specified direction. If includeInvisibleExits is set true then exits which are not player visible will be included. If an exits cannot be found then null is returned.

findInteractionTarget

fun findInteractionTarget(target: String, includeInvisibleTargets: Boolean = false): InteractWithItem?

Find an InteractWithItem in this Room, specified by target. If includeInvisibleTargets is true then targets that aren't visible to the player are included.

fun findItem(item: String, includeInvisibleItems: Boolean = false): Item?

Find an Item in this Room, specified by item. If includeInvisibleItems is true then items that aren't visible to the player are included.

operator fun get(direction: Direction): Exit?

Get the Exit at the specified direction. If no Exit exists in the specified direction then null is returned.

fun hasExit(direction: Direction, includeInvisibleExits: Boolean = false): Boolean

Get if this Room has an Exit in a specified direction. If includeInvisibleExits is true then exits that aren't visible to the player are included.

hasLockedExitInDirection

fun hasLockedExitInDirection(direction: Direction, includeInvisibleExits: Boolean = false): Boolean

Get if this Room has a locked Exit in a specified direction. If includeInvisibleExits is true then exits that aren't visible to the player are included.

hasUnlockedExitInDirection

fun hasUnlockedExitInDirection(direction: Direction, includeInvisibleExits: Boolean = false): Boolean

Get if this Room has an unlocked Exit in a specified direction. If includeInvisibleExits is true then exits that aren't visible to the player are included.

open override fun interact(item: Item): InteractionResult

Interact with the specified item.

fun movedInto(from: Direction?)

Move in to this Room form a specified Direction.

removeCharacter

fun removeCharacter(character: NonPlayableCharacter)

Remove a character from this Room.

fun removeExit(exit: Exit)

Remove an exit from this Room.

removeInteractionTarget

fun removeInteractionTarget(target: InteractWithItem): Boolean

Remove a target from this Room. If the target exists in the Room true is returned else false.

fun removeItem(item: Item)

Remove an item from this Room.

specifyConditionalDescription

fun specifyConditionalDescription(description: ConditionalDescription)

Specify a ConditionalDescription for this Room with description.

open override fun toString(): String