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

Overworld

class Overworld(val identifier: Identifier, var description: Description) : ExaminableObject

Provides an overworld which is a container of Region. The overwold has an identifier and a description.

Constructors

Overworld

constructor(identifier: String, description: String)

Provides an overlord which is a container of Region. The overwold has an identifier and a description.

constructor(identifier: Identifier, description: Description)

Properties

attributes

open override val attributes: AttributeManager

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

commands

open override var commands: List<CustomCommand>

A list of CustomCommand that this Examinable provides.

currentRegion

var currentRegion: Region?

Returns the current Region.

description

open override var description: Description

A Description that describes this object.

examination

var examination: Examination

Provides a callback for handling examination of this object.

identifier

open override var identifier: Identifier

An Identifier that can be used to identify this object.

isPlayerVisible

open override var isPlayerVisible: Boolean

Returns true if visible to the player, else false.

regions

val regions: List<Region>

Returns a list of Region that make up this Overworld.

Functions

addRegion

fun addRegion(region: Region)

Add a region to this Overworld.

examine

open override fun examine(scene: ExaminationScene): ExaminationResult

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

findRegion

fun findRegion(regionName: String): Region?

Find a Region within this Overworld, by regionName.

move

fun move(region: Region): Boolean

Move to a specified region. Returns true if the move was successful, else false.

removeRegion

fun removeRegion(region: Region)

Remove a region from this Overworld.

toString

open override fun toString(): String